diff --git a/404.html b/404.html index 33720948b..4e9eaf8f4 100644 --- a/404.html +++ b/404.html @@ -11,14 +11,14 @@ - - - + + +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

Company

Developer

Resources

Guides
Soon

Tutorials
Soon

Contact

Copyright © 2024 Vocdoni, Inc. All rights reserved.
- - + + \ No newline at end of file diff --git a/assets/css/styles.34e6d5a8.css b/assets/css/styles.34e6d5a8.css new file mode 100644 index 000000000..9787754fb --- /dev/null +++ b/assets/css/styles.34e6d5a8.css @@ -0,0 +1 @@ +@import url(https://fonts.googleapis.com/css2?family=Manrope:wght@500;700&display=swap);.col,.container{padding:0 var(--ifm-spacing-horizontal);width:100%}.markdown>h2,.markdown>h3,.markdown>h4,.markdown>h5,.markdown>h6{margin-bottom:calc(var(--ifm-heading-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown li,a{text-align:left}.breadcrumbs__link,.button{transition-timing-function:var(--ifm-transition-timing-default)}.button,code{vertical-align:middle}.button--outline.button--active,.button--outline:active,.button--outline:hover,:root{--ifm-button-color:var(--ifm-font-color-base-inverse)}.menu__link:hover,a{transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.navbar--dark,:root{--ifm-navbar-link-hover-color:var(--ifm-color-primary)}.menu,.navbar-sidebar{overflow-x:hidden}:root,html[data-theme=dark]{--ifm-color-emphasis-500:var(--ifm-color-gray-500)}progress,sub,sup{vertical-align:initial}.markdown li,body{word-wrap:break-word}.toggleButton_gllP,html{-webkit-tap-highlight-color:transparent}.button,.discriminatorTabLabel_dvfv,.dropdown__link,.filename_FaIo,.schemaTabLabel_clV0,.showMoreButton_ZGo2,.tabItem_AM8E,.text--truncate{white-space:nowrap}*,.DocSearch-Container,.DocSearch-Container *,:after,:before{box-sizing:border-box}:root{--ifm-color-scheme:light;--ifm-dark-value:10%;--ifm-darker-value:15%;--ifm-darkest-value:30%;--ifm-light-value:15%;--ifm-lighter-value:30%;--ifm-lightest-value:50%;--ifm-contrast-background-value:90%;--ifm-contrast-foreground-value:70%;--ifm-contrast-background-dark-value:70%;--ifm-contrast-foreground-dark-value:90%;--ifm-color-primary:#3578e5;--ifm-color-secondary:#ebedf0;--ifm-color-success:#00a400;--ifm-color-info:#54c7ec;--ifm-color-warning:#ffba00;--ifm-color-danger:#fa383e;--ifm-color-primary-dark:#306cce;--ifm-color-primary-darker:#2d66c3;--ifm-color-primary-darkest:#2554a0;--ifm-color-primary-light:#538ce9;--ifm-color-primary-lighter:#72a1ed;--ifm-color-primary-lightest:#9abcf2;--ifm-color-primary-contrast-background:#ebf2fc;--ifm-color-primary-contrast-foreground:#102445;--ifm-color-secondary-dark:#d4d5d8;--ifm-color-secondary-darker:#c8c9cc;--ifm-color-secondary-darkest:#a4a6a8;--ifm-color-secondary-light:#eef0f2;--ifm-color-secondary-lighter:#f1f2f5;--ifm-color-secondary-lightest:#f5f6f8;--ifm-color-secondary-contrast-background:#fdfdfe;--ifm-color-secondary-contrast-foreground:#474748;--ifm-color-success-dark:#009400;--ifm-color-success-darker:#008b00;--ifm-color-success-darkest:#007300;--ifm-color-success-light:#26b226;--ifm-color-success-lighter:#4dbf4d;--ifm-color-success-lightest:#80d280;--ifm-color-success-contrast-background:#e6f6e6;--ifm-color-success-contrast-foreground:#003100;--ifm-color-info-dark:#4cb3d4;--ifm-color-info-darker:#47a9c9;--ifm-color-info-darkest:#3b8ba5;--ifm-color-info-light:#6ecfef;--ifm-color-info-lighter:#87d8f2;--ifm-color-info-lightest:#aae3f6;--ifm-color-info-contrast-background:#eef9fd;--ifm-color-info-contrast-foreground:#193c47;--ifm-color-warning-dark:#e6a700;--ifm-color-warning-darker:#d99e00;--ifm-color-warning-darkest:#b38200;--ifm-color-warning-light:#ffc426;--ifm-color-warning-lighter:#ffcf4d;--ifm-color-warning-lightest:#ffdd80;--ifm-color-warning-contrast-background:#fff8e6;--ifm-color-warning-contrast-foreground:#4d3800;--ifm-color-danger-dark:#e13238;--ifm-color-danger-darker:#d53035;--ifm-color-danger-darkest:#af272b;--ifm-color-danger-light:#fb565b;--ifm-color-danger-lighter:#fb7478;--ifm-color-danger-lightest:#fd9c9f;--ifm-color-danger-contrast-background:#ffebec;--ifm-color-danger-contrast-foreground:#4b1113;--ifm-color-white:#fff;--ifm-color-black:#000;--ifm-color-gray-0:var(--ifm-color-white);--ifm-color-gray-100:#f5f6f7;--ifm-color-gray-200:#ebedf0;--ifm-color-gray-300:#dadde1;--ifm-color-gray-400:#ccd0d5;--ifm-color-gray-500:#bec3c9;--ifm-color-gray-600:#8d949e;--ifm-color-gray-700:#606770;--ifm-color-gray-800:#444950;--ifm-color-gray-900:#1c1e21;--ifm-color-gray-1000:var(--ifm-color-black);--ifm-color-emphasis-0:var(--ifm-color-gray-0);--ifm-color-emphasis-100:var(--ifm-color-gray-100);--ifm-color-emphasis-200:var(--ifm-color-gray-200);--ifm-color-emphasis-300:var(--ifm-color-gray-300);--ifm-color-emphasis-400:var(--ifm-color-gray-400);--ifm-color-emphasis-600:var(--ifm-color-gray-600);--ifm-color-emphasis-700:var(--ifm-color-gray-700);--ifm-color-emphasis-800:var(--ifm-color-gray-800);--ifm-color-emphasis-900:var(--ifm-color-gray-900);--ifm-color-emphasis-1000:var(--ifm-color-gray-1000);--ifm-color-content:var(--ifm-color-emphasis-900);--ifm-color-content-inverse:var(--ifm-color-emphasis-0);--ifm-color-content-secondary:#525860;--ifm-background-color:#0000;--ifm-background-surface-color:var(--ifm-color-content-inverse);--ifm-global-border-width:1px;--ifm-global-radius:0.4rem;--ifm-hover-overlay:#0000000d;--ifm-font-color-base:var(--ifm-color-content);--ifm-font-color-base-inverse:var(--ifm-color-content-inverse);--ifm-font-color-secondary:var(--ifm-color-content-secondary);--ifm-font-family-base:system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--ifm-font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--ifm-font-size-base:100%;--ifm-font-weight-light:300;--ifm-font-weight-normal:400;--ifm-font-weight-semibold:500;--ifm-font-weight-bold:700;--ifm-font-weight-base:var(--ifm-font-weight-normal);--ifm-line-height-base:1.65;--ifm-global-spacing:1rem;--ifm-spacing-vertical:var(--ifm-global-spacing);--ifm-spacing-horizontal:var(--ifm-global-spacing);--ifm-transition-fast:200ms;--ifm-transition-slow:400ms;--ifm-transition-timing-default:cubic-bezier(0.08,0.52,0.52,1);--ifm-global-shadow-lw:0 1px 2px 0 #0000001a;--ifm-global-shadow-md:0 5px 40px #0003;--ifm-global-shadow-tl:0 12px 28px 0 #0003,0 2px 4px 0 #0000001a;--ifm-z-index-dropdown:100;--ifm-z-index-fixed:200;--ifm-z-index-overlay:400;--ifm-container-width:1140px;--ifm-container-width-xl:1320px;--ifm-code-background:#f6f7f8;--ifm-code-border-radius:var(--ifm-global-radius);--ifm-code-padding-horizontal:0.1rem;--ifm-code-padding-vertical:0.1rem;--ifm-pre-background:var(--ifm-code-background);--ifm-pre-border-radius:var(--ifm-code-border-radius);--ifm-pre-color:inherit;--ifm-pre-line-height:1.45;--ifm-pre-padding:1rem;--ifm-heading-color:inherit;--ifm-heading-margin-top:0;--ifm-heading-margin-bottom:var(--ifm-spacing-vertical);--ifm-heading-font-family:var(--ifm-font-family-base);--ifm-heading-font-weight:var(--ifm-font-weight-bold);--ifm-heading-line-height:1.25;--ifm-h1-font-size:2rem;--ifm-h2-font-size:1.5rem;--ifm-h3-font-size:1.25rem;--ifm-h4-font-size:1rem;--ifm-h5-font-size:0.875rem;--ifm-h6-font-size:0.85rem;--ifm-image-alignment-padding:1.25rem;--ifm-leading-desktop:1.25;--ifm-leading:calc(var(--ifm-leading-desktop)*1rem);--ifm-list-left-padding:2rem;--ifm-list-margin:1rem;--ifm-list-item-margin:0.25rem;--ifm-list-paragraph-margin:1rem;--ifm-table-cell-padding:0.75rem;--ifm-table-background:#0000;--ifm-table-stripe-background:#00000008;--ifm-table-border-width:1px;--ifm-table-border-color:var(--ifm-color-emphasis-300);--ifm-table-head-background:inherit;--ifm-table-head-color:inherit;--ifm-table-head-font-weight:var(--ifm-font-weight-bold);--ifm-table-cell-color:inherit;--ifm-link-color:var(--ifm-color-primary);--ifm-link-decoration:none;--ifm-link-hover-color:var(--ifm-link-color);--ifm-link-hover-decoration:underline;--ifm-paragraph-margin-bottom:var(--ifm-leading);--ifm-blockquote-font-size:var(--ifm-font-size-base);--ifm-blockquote-border-left-width:2px;--ifm-blockquote-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-blockquote-padding-vertical:0;--ifm-blockquote-shadow:none;--ifm-blockquote-color:var(--ifm-color-emphasis-800);--ifm-blockquote-border-color:var(--ifm-color-emphasis-300);--ifm-hr-background-color:var(--ifm-color-emphasis-500);--ifm-hr-height:1px;--ifm-hr-margin-vertical:1.5rem;--ifm-scrollbar-size:7px;--ifm-scrollbar-track-background-color:#f1f1f1;--ifm-scrollbar-thumb-background-color:silver;--ifm-scrollbar-thumb-hover-background-color:#a7a7a7;--ifm-alert-background-color:inherit;--ifm-alert-border-color:inherit;--ifm-alert-border-radius:var(--ifm-global-radius);--ifm-alert-border-width:0px;--ifm-alert-border-left-width:5px;--ifm-alert-color:var(--ifm-font-color-base);--ifm-alert-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-alert-padding-vertical:var(--ifm-spacing-vertical);--ifm-alert-shadow:var(--ifm-global-shadow-lw);--ifm-avatar-intro-margin:1rem;--ifm-avatar-intro-alignment:inherit;--ifm-avatar-photo-size:3rem;--ifm-badge-background-color:inherit;--ifm-badge-border-color:inherit;--ifm-badge-border-radius:var(--ifm-global-radius);--ifm-badge-border-width:var(--ifm-global-border-width);--ifm-badge-color:var(--ifm-color-white);--ifm-badge-padding-horizontal:calc(var(--ifm-spacing-horizontal)*0.5);--ifm-badge-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-breadcrumb-border-radius:1.5rem;--ifm-breadcrumb-spacing:0.5rem;--ifm-breadcrumb-color-active:var(--ifm-color-primary);--ifm-breadcrumb-item-background-active:var(--ifm-hover-overlay);--ifm-breadcrumb-padding-horizontal:0.8rem;--ifm-breadcrumb-padding-vertical:0.4rem;--ifm-breadcrumb-size-multiplier:1;--ifm-breadcrumb-separator:url('data:image/svg+xml;utf8,');--ifm-breadcrumb-separator-filter:none;--ifm-breadcrumb-separator-size:0.5rem;--ifm-breadcrumb-separator-size-multiplier:1.25;--ifm-button-background-color:inherit;--ifm-button-border-color:var(--ifm-button-background-color);--ifm-button-border-width:var(--ifm-global-border-width);--ifm-button-font-weight:var(--ifm-font-weight-bold);--ifm-button-padding-horizontal:1.5rem;--ifm-button-padding-vertical:0.375rem;--ifm-button-size-multiplier:1;--ifm-button-transition-duration:var(--ifm-transition-fast);--ifm-button-border-radius:calc(var(--ifm-global-radius)*var(--ifm-button-size-multiplier));--ifm-button-group-spacing:2px;--ifm-card-background-color:var(--ifm-background-surface-color);--ifm-card-border-radius:calc(var(--ifm-global-radius)*2);--ifm-card-horizontal-spacing:var(--ifm-global-spacing);--ifm-card-vertical-spacing:var(--ifm-global-spacing);--ifm-toc-border-color:var(--ifm-color-emphasis-300);--ifm-toc-link-color:var(--ifm-color-content-secondary);--ifm-toc-padding-vertical:0.5rem;--ifm-toc-padding-horizontal:0.5rem;--ifm-dropdown-background-color:var(--ifm-background-surface-color);--ifm-dropdown-font-weight:var(--ifm-font-weight-semibold);--ifm-dropdown-link-color:var(--ifm-font-color-base);--ifm-dropdown-hover-background-color:var(--ifm-hover-overlay);--ifm-footer-background-color:var(--ifm-color-emphasis-100);--ifm-footer-color:inherit;--ifm-footer-link-color:var(--ifm-color-emphasis-700);--ifm-footer-link-hover-color:var(--ifm-color-primary);--ifm-footer-link-horizontal-spacing:0.5rem;--ifm-footer-padding-horizontal:calc(var(--ifm-spacing-horizontal)*2);--ifm-footer-padding-vertical:calc(var(--ifm-spacing-vertical)*2);--ifm-footer-title-color:inherit;--ifm-footer-logo-max-width:min(30rem,90vw);--ifm-hero-background-color:var(--ifm-background-surface-color);--ifm-hero-text-color:var(--ifm-color-emphasis-800);--ifm-menu-color:var(--ifm-color-emphasis-700);--ifm-menu-color-active:var(--ifm-color-primary);--ifm-menu-color-background-active:var(--ifm-hover-overlay);--ifm-menu-color-background-hover:var(--ifm-hover-overlay);--ifm-menu-link-padding-horizontal:0.75rem;--ifm-menu-link-padding-vertical:0.375rem;--ifm-menu-link-sublist-icon:url('data:image/svg+xml;utf8,');--ifm-menu-link-sublist-icon-filter:none;--ifm-navbar-background-color:var(--ifm-background-surface-color);--ifm-navbar-height:3.75rem;--ifm-navbar-item-padding-horizontal:0.75rem;--ifm-navbar-item-padding-vertical:0.25rem;--ifm-navbar-link-color:var(--ifm-font-color-base);--ifm-navbar-link-active-color:var(--ifm-link-color);--ifm-navbar-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-navbar-padding-vertical:calc(var(--ifm-spacing-vertical)*0.5);--ifm-navbar-shadow:var(--ifm-global-shadow-lw);--ifm-navbar-search-input-background-color:var(--ifm-color-emphasis-200);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-800);--ifm-navbar-search-input-placeholder-color:var(--ifm-color-emphasis-500);--ifm-navbar-search-input-icon:url('data:image/svg+xml;utf8,');--ifm-navbar-sidebar-width:83vw;--ifm-pagination-border-radius:var(--ifm-global-radius);--ifm-pagination-color-active:var(--ifm-color-primary);--ifm-pagination-font-size:1rem;--ifm-pagination-item-active-background:var(--ifm-hover-overlay);--ifm-pagination-page-spacing:0.2em;--ifm-pagination-padding-horizontal:calc(var(--ifm-spacing-horizontal)*1);--ifm-pagination-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-pagination-nav-border-radius:var(--ifm-global-radius);--ifm-pagination-nav-color-hover:var(--ifm-color-primary);--ifm-pills-color-active:var(--ifm-color-primary);--ifm-pills-color-background-active:var(--ifm-hover-overlay);--ifm-pills-spacing:0.125rem;--ifm-tabs-color:var(--ifm-font-color-secondary);--ifm-tabs-color-active:var(--ifm-color-primary);--ifm-tabs-color-active-border:var(--ifm-tabs-color-active);--ifm-tabs-padding-horizontal:1rem;--ifm-tabs-padding-vertical:1rem;--docusaurus-progress-bar-color:var(--ifm-color-primary)}:root,[data-theme=dark]{--ifm-color-primary:#27af86}.badge--danger,.badge--info,.badge--primary,.badge--secondary,.badge--success,.badge--warning{--ifm-badge-border-color:var(--ifm-badge-background-color)}.button--link,.button--outline{--ifm-button-background-color:#0000}html{-webkit-font-smoothing:antialiased;text-size-adjust:100%;background-color:var(--ifm-background-color);color:var(--ifm-font-color-base);color-scheme:var(--ifm-color-scheme);font:var(--ifm-font-size-base)/var(--ifm-line-height-base) var(--ifm-font-family-base);text-rendering:optimizelegibility}iframe{border:0;color-scheme:auto}.container{margin:0 auto;max-width:var(--ifm-container-width)}.container--fluid{max-width:inherit}.row{display:flex;flex-wrap:wrap;margin:0 calc(var(--ifm-spacing-horizontal)*-1)}.margin-bottom--none,.margin-vert--none,.markdown>:last-child{margin-bottom:0!important}.margin-top--none,.margin-vert--none,.tabItem_LNqP,.tabItem_kzG2{margin-top:0!important}.row--no-gutters{margin-left:0;margin-right:0}.margin-horiz--none,.margin-right--none,.tabItem_AM8E:last-child,.tabItem_VIbn:last-child,.tabItem_es3Q:last-child,.tabItem_fIhq:last-child{margin-right:0!important}.row--no-gutters>.col{padding-left:0;padding-right:0}.items-start,.row--align-top{align-items:flex-start}.row--align-bottom{align-items:flex-end}.items-center,.menuExternalLink_NmtK,.row--align-center{align-items:center}.row--align-stretch{align-items:stretch}.row--align-baseline{align-items:baseline}.col{--ifm-col-width:100%;flex:1 0;margin-left:0;max-width:var(--ifm-col-width)}.padding-bottom--none,.padding-vert--none{padding-bottom:0!important}.padding-top--none,.padding-vert--none{padding-top:0!important}.discriminatorTabsContainer,.padding-horiz--none,.padding-left--none{padding-left:0!important}.padding-horiz--none,.padding-right--none{padding-right:0!important}.col[class*=col--]{flex:0 0 var(--ifm-col-width)}.col--1{--ifm-col-width:8.33333%}.col--offset-1{margin-left:8.33333%}.col--2{--ifm-col-width:16.66667%}.col--offset-2{margin-left:16.66667%}.col--3{--ifm-col-width:25%}.col--offset-3{margin-left:25%}.col--4{--ifm-col-width:33.33333%}.col--offset-4{margin-left:33.33333%}.col--5{--ifm-col-width:41.66667%}.col--offset-5{margin-left:41.66667%}.col--6{--ifm-col-width:50%}.col--offset-6{margin-left:50%}.col--7{--ifm-col-width:58.33333%}.col--offset-7{margin-left:58.33333%}.col--8{--ifm-col-width:66.66667%}.col--offset-8{margin-left:66.66667%}.col--9{--ifm-col-width:75%}.col--offset-9{margin-left:75%}.col--10{--ifm-col-width:83.33333%}.col--offset-10{margin-left:83.33333%}.col--11{--ifm-col-width:91.66667%}.col--offset-11{margin-left:91.66667%}.col--12{--ifm-col-width:100%}.col--offset-12{margin-left:100%}.margin-horiz--none,.margin-left--none{margin-left:0!important}.margin--none{margin:0!important}.margin-bottom--xs,.margin-vert--xs{margin-bottom:.25rem!important}.margin-top--xs,.margin-vert--xs{margin-top:.25rem!important}.margin-horiz--xs,.margin-left--xs{margin-left:.25rem!important}.margin-horiz--xs,.margin-right--xs{margin-right:.25rem!important}.margin--xs{margin:.25rem!important}.margin-bottom--sm,.margin-vert--sm{margin-bottom:.5rem!important}.margin-top--sm,.margin-vert--sm{margin-top:.5rem!important}.margin-horiz--sm,.margin-left--sm{margin-left:.5rem!important}.margin-horiz--sm,.margin-right--sm{margin-right:.5rem!important}.margin--sm{margin:.5rem!important}.margin-bottom--md,.margin-vert--md{margin-bottom:1rem!important}.margin-top--md,.margin-vert--md{margin-top:1rem!important}.margin-horiz--md,.margin-left--md{margin-left:1rem!important}.margin-horiz--md,.margin-right--md{margin-right:1rem!important}.margin--md{margin:1rem!important}.margin-bottom--lg,.margin-vert--lg{margin-bottom:2rem!important}.margin-top--lg,.margin-vert--lg{margin-top:2rem!important}.margin-horiz--lg,.margin-left--lg{margin-left:2rem!important}.margin-horiz--lg,.margin-right--lg{margin-right:2rem!important}.margin--lg{margin:2rem!important}.margin-bottom--xl,.margin-vert--xl{margin-bottom:5rem!important}.margin-top--xl,.margin-vert--xl{margin-top:5rem!important}.margin-horiz--xl,.margin-left--xl{margin-left:5rem!important}.margin-horiz--xl,.margin-right--xl{margin-right:5rem!important}.margin--xl{margin:5rem!important}.padding--none{padding:0!important}.padding-bottom--xs,.padding-vert--xs{padding-bottom:.25rem!important}.padding-top--xs,.padding-vert--xs{padding-top:.25rem!important}.padding-horiz--xs,.padding-left--xs{padding-left:.25rem!important}.padding-horiz--xs,.padding-right--xs{padding-right:.25rem!important}.padding--xs{padding:.25rem!important}.padding-bottom--sm,.padding-vert--sm{padding-bottom:.5rem!important}.padding-top--sm,.padding-vert--sm{padding-top:.5rem!important}.padding-horiz--sm,.padding-left--sm{padding-left:.5rem!important}.padding-horiz--sm,.padding-right--sm{padding-right:.5rem!important}.padding--sm{padding:.5rem!important}.padding-bottom--md,.padding-vert--md{padding-bottom:1rem!important}.padding-top--md,.padding-vert--md{padding-top:1rem!important}.padding-horiz--md,.padding-left--md{padding-left:1rem!important}.padding-horiz--md,.padding-right--md{padding-right:1rem!important}.padding--md{padding:1rem!important}.padding-bottom--lg,.padding-vert--lg{padding-bottom:2rem!important}.padding-top--lg,.padding-vert--lg{padding-top:2rem!important}.padding-horiz--lg,.padding-left--lg{padding-left:2rem!important}.padding-horiz--lg,.padding-right--lg{padding-right:2rem!important}.padding--lg{padding:2rem!important}.padding-bottom--xl,.padding-vert--xl{padding-bottom:5rem!important}.padding-top--xl,.padding-vert--xl{padding-top:5rem!important}.padding-horiz--xl,.padding-left--xl{padding-left:5rem!important}.padding-horiz--xl,.padding-right--xl{padding-right:5rem!important}.padding--xl{padding:5rem!important}code{background-color:var(--ifm-code-background);border:.1rem solid #0000001a;border-radius:var(--ifm-code-border-radius);font-family:var(--ifm-font-family-monospace);font-size:var(--ifm-code-font-size);padding:var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal)}a code{color:inherit}pre{background-color:var(--ifm-pre-background);border-radius:var(--ifm-pre-border-radius);color:var(--ifm-pre-color);font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace);margin:0 0 var(--ifm-spacing-vertical);overflow:auto;padding:var(--ifm-pre-padding)}pre code{background-color:initial;border:none;font-size:100%;line-height:inherit;padding:0}kbd{background-color:var(--ifm-color-emphasis-0);border:1px solid var(--ifm-color-emphasis-400);border-radius:.2rem;box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-400);color:var(--ifm-color-emphasis-800);font:80% var(--ifm-font-family-monospace);padding:.15rem .3rem}img[align=right]{padding-left:var(--image-alignment-padding)}img[align=left]{padding-right:var(--image-alignment-padding)}.markdown:after,.markdown:before{content:"";display:table}.markdown:after{clear:both}.markdown>h2{--ifm-h2-font-size:2rem;margin-top:calc(var(--ifm-h2-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h3{--ifm-h3-font-size:1.5rem;margin-top:calc(var(--ifm-h3-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h4,.markdown>h5,.markdown>h6{margin-top:calc(var(--ifm-heading-vertical-rhythm-top)*var(--ifm-leading))}.markdown>p,.markdown>pre,.markdown>ul,.tabList_OQG4,.tabList__CuJ{margin-bottom:var(--ifm-leading)}.markdown li>p{margin-top:var(--ifm-list-paragraph-margin)}.markdown li+li{margin-top:var(--ifm-list-item-margin)}ol,ul{margin:0 0 var(--ifm-list-margin);padding-left:var(--ifm-list-left-padding);list-style-position:outside}ol ol,ul ol{list-style-type:lower-roman}ol ol,ol ul,ul ol,ul ul{margin:0}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}table thead tr{border-bottom:2px solid var(--ifm-table-border-color)}table thead,table tr:nth-child(2n){background-color:var(--ifm-table-stripe-background)}table tr{background-color:var(--ifm-table-background);border-top:var(--ifm-table-border-width) solid var(--ifm-table-border-color)}table td,table th{border:var(--ifm-table-border-width) solid var(--ifm-table-border-color);padding:var(--ifm-table-cell-padding)}table th{background-color:var(--ifm-table-head-background);color:var(--ifm-table-head-color);font-weight:var(--ifm-table-head-font-weight)}table td{color:var(--ifm-table-cell-color)}strong{font-weight:var(--ifm-font-weight-bold)}a{color:var(--ifm-link-color);text-decoration:inherit;color:#229573;-webkit-text-decoration:var(--ifm-link-decoration);text-decoration:var(--ifm-link-decoration)}a:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button:hover,.text--no-decoration,.text--no-decoration:hover,a:not([href]){text-decoration:none}.markdown p,p{margin:0 0 var(--ifm-paragraph-margin-bottom)}blockquote{border-left:var(--ifm-blockquote-border-left-width) solid var(--ifm-blockquote-border-color);box-shadow:var(--ifm-blockquote-shadow);color:var(--ifm-blockquote-color);font-size:var(--ifm-blockquote-font-size);margin:0 0 var(--ifm-spacing-vertical);padding:var(--ifm-blockquote-padding-vertical) var(--ifm-blockquote-padding-horizontal)}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}.markdown hr,hr{background-color:var(--ifm-hr-background-color);border:0;height:var(--ifm-hr-height);margin:var(--ifm-hr-margin-vertical) 0}.shadow--lw{box-shadow:var(--ifm-global-shadow-lw)!important}.shadow--md{box-shadow:var(--ifm-global-shadow-md)!important}.shadow--tl{box-shadow:var(--ifm-global-shadow-tl)!important}.text--primary,.wordWrapButtonEnabled_EoeP .wordWrapButtonIcon_Bwma{color:var(--ifm-color-primary)}.text--secondary{color:var(--ifm-color-secondary)}.text--success{color:var(--ifm-color-success)}.text--info{color:var(--ifm-color-info)}.text--warning{color:var(--ifm-color-warning)}.text--danger{color:var(--ifm-color-danger)}.clean-btn,hr{color:inherit}.text--center{text-align:center}.text--left{text-align:left}.text--justify,p{text-align:justify}.text--right{text-align:right}.text--capitalize{text-transform:capitalize}.text--lowercase{text-transform:lowercase}.admonitionHeading_tbUL,.alert__heading,.api-method>.menu__link:before,.text--uppercase{text-transform:uppercase}.text--light{font-weight:var(--ifm-font-weight-light)}.text--normal{font-weight:var(--ifm-font-weight-normal)}.text--semibold{font-weight:var(--ifm-font-weight-semibold)}.text--bold{font-weight:var(--ifm-font-weight-bold)}.text--italic{font-style:italic}.text--truncate{overflow:hidden;text-overflow:ellipsis}.text--break{word-wrap:break-word!important;word-break:break-word!important}.clean-btn{background:none;border:none;cursor:pointer;font-family:inherit;padding:0}.alert,.alert .close{color:var(--ifm-alert-foreground-color)}.clean-list{list-style:none;padding-left:0}.alert--primary{--ifm-alert-background-color:var(--ifm-color-primary-contrast-background);--ifm-alert-background-color-highlight:#3578e526;--ifm-alert-foreground-color:var(--ifm-color-primary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-primary-dark)}.alert--secondary{--ifm-alert-background-color:var(--ifm-color-secondary-contrast-background);--ifm-alert-background-color-highlight:#ebedf026;--ifm-alert-foreground-color:var(--ifm-color-secondary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-secondary-dark)}.alert--success{--ifm-alert-background-color:var(--ifm-color-success-contrast-background);--ifm-alert-background-color-highlight:#00a40026;--ifm-alert-foreground-color:var(--ifm-color-success-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-success-dark)}.alert--info{--ifm-alert-background-color:var(--ifm-color-info-contrast-background);--ifm-alert-background-color-highlight:#54c7ec26;--ifm-alert-foreground-color:var(--ifm-color-info-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-info-dark)}.alert--warning{--ifm-alert-background-color:var(--ifm-color-warning-contrast-background);--ifm-alert-background-color-highlight:#ffba0026;--ifm-alert-foreground-color:var(--ifm-color-warning-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-warning-dark)}.alert--danger{--ifm-alert-background-color:var(--ifm-color-danger-contrast-background);--ifm-alert-background-color-highlight:#fa383e26;--ifm-alert-foreground-color:var(--ifm-color-danger-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-danger-dark)}.alert{--ifm-code-background:var(--ifm-alert-background-color-highlight);--ifm-link-color:var(--ifm-alert-foreground-color);--ifm-link-hover-color:var(--ifm-alert-foreground-color);--ifm-link-decoration:underline;--ifm-tabs-color:var(--ifm-alert-foreground-color);--ifm-tabs-color-active:var(--ifm-alert-foreground-color);--ifm-tabs-color-active-border:var(--ifm-alert-border-color);background-color:var(--ifm-alert-background-color);border:var(--ifm-alert-border-width) solid var(--ifm-alert-border-color);border-left-width:var(--ifm-alert-border-left-width);border-radius:var(--ifm-alert-border-radius);box-shadow:var(--ifm-alert-shadow);padding:var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal)}.alert__heading{align-items:center;display:flex;font:700 var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.5rem}.alert__icon{display:inline-flex;margin-right:.4em}.alert__icon svg{fill:var(--ifm-alert-foreground-color);stroke:var(--ifm-alert-foreground-color);stroke-width:0}.alert .close{margin:calc(var(--ifm-alert-padding-vertical)*-1) calc(var(--ifm-alert-padding-horizontal)*-1) 0 0;opacity:.75}.alert .close:focus,.alert .close:hover{opacity:1}.alert a{text-decoration-color:var(--ifm-alert-border-color)}.alert a:hover{text-decoration-thickness:2px}.avatar{column-gap:var(--ifm-avatar-intro-margin);display:flex}.avatar__photo{border-radius:50%;display:block;height:var(--ifm-avatar-photo-size);overflow:hidden;width:var(--ifm-avatar-photo-size)}.avatar__photo--sm{--ifm-avatar-photo-size:2rem}.avatar__photo--lg{--ifm-avatar-photo-size:4rem}.avatar__photo--xl{--ifm-avatar-photo-size:6rem}.avatar__intro{display:flex;flex:1 1;flex-direction:column;justify-content:center;text-align:var(--ifm-avatar-intro-alignment)}.badge,.breadcrumbs__item,.breadcrumbs__link,.button,.dropdown>.navbar__link:after{display:inline-block}.avatar__name{font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base)}.avatar__subtitle{margin-top:.25rem}.avatar--vertical{--ifm-avatar-intro-alignment:center;--ifm-avatar-intro-margin:0.5rem;align-items:center;flex-direction:column}.badge{background-color:var(--ifm-badge-background-color);border:var(--ifm-badge-border-width) solid var(--ifm-badge-border-color);border-radius:var(--ifm-badge-border-radius);color:var(--ifm-badge-color);font-size:75%;font-weight:var(--ifm-font-weight-bold);line-height:1;padding:var(--ifm-badge-padding-vertical) var(--ifm-badge-padding-horizontal)}.badge--primary{--ifm-badge-background-color:var(--ifm-color-primary)}.badge--secondary{--ifm-badge-background-color:var(--ifm-color-secondary);color:var(--ifm-color-black)}.breadcrumbs__link,.button.button--secondary.button--outline:not(.button--active):not(:hover){color:var(--ifm-font-color-base)}.badge--success{--ifm-badge-background-color:var(--ifm-color-success)}.badge--info{--ifm-badge-background-color:var(--ifm-color-info)}.badge--warning{--ifm-badge-background-color:var(--ifm-color-warning)}.badge--danger{--ifm-badge-background-color:var(--ifm-color-danger)}.breadcrumbs{margin-bottom:0;padding-left:0}.breadcrumbs__item:not(:last-child):after{background:var(--ifm-breadcrumb-separator) center;content:" ";display:inline-block;filter:var(--ifm-breadcrumb-separator-filter);height:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));margin:0 var(--ifm-breadcrumb-spacing);opacity:.5;width:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier))}.breadcrumbs__item--active .breadcrumbs__link{background:var(--ifm-breadcrumb-item-background-active);color:var(--ifm-breadcrumb-color-active)}.breadcrumbs__link{border-radius:var(--ifm-breadcrumb-border-radius);font-size:calc(1rem*var(--ifm-breadcrumb-size-multiplier));padding:calc(var(--ifm-breadcrumb-padding-vertical)*var(--ifm-breadcrumb-size-multiplier)) calc(var(--ifm-breadcrumb-padding-horizontal)*var(--ifm-breadcrumb-size-multiplier));transition-duration:var(--ifm-transition-fast);transition-property:background,color}.breadcrumbs__link:any-link:hover,.breadcrumbs__link:link:hover,.breadcrumbs__link:visited:hover,area.breadcrumbs__link[href]:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs--sm{--ifm-breadcrumb-size-multiplier:0.8}.breadcrumbs--lg{--ifm-breadcrumb-size-multiplier:1.2}.button{background-color:var(--ifm-button-background-color);border:var(--ifm-button-border-width) solid var(--ifm-button-border-color);border-radius:var(--ifm-button-border-radius);cursor:pointer;font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:var(--ifm-button-font-weight);line-height:1.5;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;transition-duration:var(--ifm-button-transition-duration);transition-property:color,background,border-color;-webkit-user-select:none;user-select:none}.button,.button:hover{color:var(--ifm-button-color)}.button--outline{--ifm-button-color:var(--ifm-button-border-color)}.button--outline:hover{--ifm-button-background-color:var(--ifm-button-border-color)}.button--link{--ifm-button-border-color:#0000;color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}.button--link.button--active,.button--link:active,.button--link:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button.disabled,.button:disabled,.button[disabled]{opacity:.65;pointer-events:none}.button--sm{--ifm-button-size-multiplier:0.8}.button--lg{--ifm-button-size-multiplier:1.35}.button--block{display:block;width:100%}.button.button--secondary{color:var(--ifm-color-gray-900)}:where(.button--primary){--ifm-button-background-color:var(--ifm-color-primary);--ifm-button-border-color:var(--ifm-color-primary)}:where(.button--primary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-primary-dark);--ifm-button-border-color:var(--ifm-color-primary-dark)}.button--primary.button--active,.button--primary:active{--ifm-button-background-color:var(--ifm-color-primary-darker);--ifm-button-border-color:var(--ifm-color-primary-darker)}:where(.button--secondary){--ifm-button-background-color:var(--ifm-color-secondary);--ifm-button-border-color:var(--ifm-color-secondary)}:where(.button--secondary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-secondary-dark);--ifm-button-border-color:var(--ifm-color-secondary-dark)}.button--secondary.button--active,.button--secondary:active{--ifm-button-background-color:var(--ifm-color-secondary-darker);--ifm-button-border-color:var(--ifm-color-secondary-darker)}:where(.button--success){--ifm-button-background-color:var(--ifm-color-success);--ifm-button-border-color:var(--ifm-color-success)}:where(.button--success):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-success-dark);--ifm-button-border-color:var(--ifm-color-success-dark)}.button--success.button--active,.button--success:active{--ifm-button-background-color:var(--ifm-color-success-darker);--ifm-button-border-color:var(--ifm-color-success-darker)}:where(.button--info){--ifm-button-background-color:var(--ifm-color-info);--ifm-button-border-color:var(--ifm-color-info)}:where(.button--info):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-info-dark);--ifm-button-border-color:var(--ifm-color-info-dark)}.button--info.button--active,.button--info:active{--ifm-button-background-color:var(--ifm-color-info-darker);--ifm-button-border-color:var(--ifm-color-info-darker)}:where(.button--warning){--ifm-button-background-color:var(--ifm-color-warning);--ifm-button-border-color:var(--ifm-color-warning)}:where(.button--warning):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-warning-dark);--ifm-button-border-color:var(--ifm-color-warning-dark)}.button--warning.button--active,.button--warning:active{--ifm-button-background-color:var(--ifm-color-warning-darker);--ifm-button-border-color:var(--ifm-color-warning-darker)}:where(.button--danger){--ifm-button-background-color:var(--ifm-color-danger);--ifm-button-border-color:var(--ifm-color-danger)}:where(.button--danger):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-danger-dark);--ifm-button-border-color:var(--ifm-color-danger-dark)}.button--danger.button--active,.button--danger:active{--ifm-button-background-color:var(--ifm-color-danger-darker);--ifm-button-border-color:var(--ifm-color-danger-darker)}.button-group{display:inline-flex;gap:var(--ifm-button-group-spacing)}.button-group>.button:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.button-group>.button:not(:last-child){border-bottom-right-radius:0;border-top-right-radius:0}.button-group--block{display:flex;justify-content:stretch}.button-group--block>.button{flex-grow:1}.card{background-color:var(--ifm-card-background-color);border-radius:var(--ifm-card-border-radius);box-shadow:var(--ifm-global-shadow-lw);display:flex;flex-direction:column;overflow:hidden}.card--full-height{height:100%}.card__image{padding-top:var(--ifm-card-vertical-spacing)}.card__image:first-child{padding-top:0}.card__body,.card__footer,.card__header{padding:var(--ifm-card-vertical-spacing) var(--ifm-card-horizontal-spacing)}.card__body:not(:last-child),.card__footer:not(:last-child),.card__header:not(:last-child){padding-bottom:0}.card__body>:last-child,.card__footer>:last-child,.card__header>:last-child{margin-bottom:0}.card__footer{margin-top:auto}.table-of-contents{font-size:.8rem;margin-bottom:0;padding:var(--ifm-toc-padding-vertical) 0}.table-of-contents,.table-of-contents ul{list-style:none;padding-left:var(--ifm-toc-padding-horizontal)}.table-of-contents li{margin:var(--ifm-toc-padding-vertical) var(--ifm-toc-padding-horizontal)}.table-of-contents__left-border{border-left:1px solid var(--ifm-toc-border-color)}.table-of-contents__link{color:var(--ifm-toc-link-color);display:block}.table-of-contents__link--active,.table-of-contents__link--active code,.table-of-contents__link:hover,.table-of-contents__link:hover code{color:var(--ifm-color-primary);text-decoration:none}.close{color:var(--ifm-color-black);float:right;font-size:1.5rem;font-weight:var(--ifm-font-weight-bold);line-height:1;opacity:.5;padding:1rem;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.close:hover{opacity:.7}.close:focus,.theme-code-block-highlighted-line .codeLineNumber_Tfdd:before{opacity:.8}.dropdown{display:inline-flex;font-weight:var(--ifm-dropdown-font-weight);position:relative;vertical-align:top}.dropdown--hoverable:hover .dropdown__menu,.dropdown--show .dropdown__menu{opacity:1;pointer-events:all;transform:translateY(-1px);visibility:visible}#nprogress,.dropdown__menu,.navbar__item.dropdown .navbar__link:not([href]){pointer-events:none}.dropdown--right .dropdown__menu{left:inherit;right:0}.dropdown--nocaret .navbar__link:after{content:none!important}.dropdown__menu{background-color:var(--ifm-dropdown-background-color);border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-md);left:0;list-style:none;max-height:80vh;min-width:10rem;opacity:0;overflow-y:auto;padding:.5rem;position:absolute;top:calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);transform:translateY(-.625rem);transition-duration:var(--ifm-transition-fast);transition-property:opacity,transform,visibility;transition-timing-function:var(--ifm-transition-timing-default);visibility:hidden;z-index:var(--ifm-z-index-dropdown)}.language-bash,.language-csharp,.language-go,.language-javascript,.language-nodejs,.language-php,.language-python,.language-ruby,.theme-api-markdown code{max-height:500px;overflow:auto}.menu__caret,.menu__link,.menu__list-item-collapsible{border-radius:.25rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.dropdown__link{border-radius:.25rem;color:var(--ifm-dropdown-link-color);display:block;font-size:.875rem;margin-top:.2rem;padding:.25rem .5rem}.dropdown__link--active,.dropdown__link:hover{background-color:var(--ifm-dropdown-hover-background-color);color:var(--ifm-dropdown-link-color);text-decoration:none}.dropdown__link--active,.dropdown__link--active:hover{--ifm-dropdown-link-color:var(--ifm-link-color)}.dropdown>.navbar__link:after{border-color:currentcolor #0000;border-style:solid;border-width:.4em .4em 0;content:"";margin-left:.3em;position:relative;top:2px;transform:translateY(-50%)}.footer{background-color:var(--ifm-footer-background-color);color:var(--ifm-footer-color);padding:var(--ifm-footer-padding-vertical) var(--ifm-footer-padding-horizontal)}.footer--dark{--ifm-footer-background-color:#303846;--ifm-footer-color:var(--ifm-footer-link-color);--ifm-footer-link-color:var(--ifm-color-secondary);--ifm-footer-title-color:var(--ifm-color-white)}.footer__links,.theme-api-markdown pre{margin-bottom:1rem}.footer__link-item{color:var(--ifm-footer-link-color);line-height:2}.footer__link-item:hover{color:var(--ifm-footer-link-hover-color)}.footer__link-separator{margin:0 var(--ifm-footer-link-horizontal-spacing)}.footer__logo{margin-top:1rem;max-width:var(--ifm-footer-logo-max-width)}.footer__title{color:var(--ifm-footer-title-color);font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base);margin-bottom:var(--ifm-heading-margin-bottom)}.menu,.navbar__link{font-weight:var(--ifm-font-weight-semibold)}.apiItemContainer article>:first-child,.apiItemContainer header+*,.docItemContainer article>:first-child,.docItemContainer header+*,.docItemContainer_joH8 article>:first-child,.docItemContainer_joH8 header+*,.footer__item,.formItem_WgRa:first-child,.showMoreButton_ZGo2:first-child,.showMoreButton_jDKX:first-child{margin-top:0}.admonitionContent_S0QG>:last-child,.cardContainer_fWXF :last-child,.cardContainer_p3e_ :last-child,.collapsibleContent_i85q>:last-child,.footer__items,.markdown [class^=codeBlock]>pre,.tabItem_Ymn6>:last-child,.theme-api-markdown details p{margin-bottom:0}.codeBlockStandalone_MEMb,[type=checkbox],fieldset,legend{padding:0}.hero{align-items:center;background-color:var(--ifm-hero-background-color);color:var(--ifm-hero-text-color);display:flex;padding:4rem 2rem}.hero--primary{--ifm-hero-background-color:var(--ifm-color-primary);--ifm-hero-text-color:var(--ifm-font-color-base-inverse)}.hero--dark{--ifm-hero-background-color:#303846;--ifm-hero-text-color:var(--ifm-color-white)}.hero__title{font-size:3rem}.hero__subtitle{font-size:1.5rem}.menu__list{list-style:none;margin:0;padding-left:0}.menu__caret,.menu__link{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu__list .menu__list{flex:0 0 100%;margin-top:.25rem;padding-left:var(--ifm-menu-link-padding-horizontal)}.menu__list-item:not(:first-child){margin-top:.25rem}.menu__list-item--collapsed .menu__list{height:0;overflow:hidden}.details_lb9f[data-collapsed=false].isBrowser_bmU9>summary:before,.details_lb9f[open]:not(.isBrowser_bmU9)>summary:before,.menu__list-item--collapsed .menu__caret:before,.menu__list-item--collapsed .menu__link--sublist:after,.tabArrowRight_X4Xu,.tabArrowRight_oN04,.tabArrowRight_qsDv,.tabArrowRight_x8Ix{transform:rotate(90deg)}.menu__list-item-collapsible{display:flex;flex-wrap:wrap;position:relative}.menu__caret:hover,.menu__link:hover,.menu__list-item-collapsible--active,.menu__list-item-collapsible:hover{background:var(--ifm-menu-color-background-hover)}.menu__list-item-collapsible .menu__link--active,.menu__list-item-collapsible .menu__link:hover{background:none!important}.menu__caret,.menu__link{align-items:center;display:flex}.navbar-sidebar,.navbar-sidebar__backdrop{bottom:0;opacity:0;transition-timing-function:ease-in-out;top:0;left:0;visibility:hidden}.menu__link{color:var(--ifm-menu-color);flex:1;line-height:1.25}.menu__link:hover{color:var(--ifm-menu-color);text-decoration:none}.menu__caret:before,.menu__link--sublist-caret:after{content:"";filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast) linear;width:1.25rem}.menu__link--sublist-caret:after{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;margin-left:auto;min-width:1.25rem}.navbar__items--center .navbar__brand,blockquote,body,dd,dl,fieldset,figure,h1,h2,h3,h4,h5,h6,hr,menu,ol,p,pre,ul{margin:0}.menu__link--active,.menu__link--active:hover{color:var(--ifm-menu-color-active)}.navbar__brand,.navbar__link{color:var(--ifm-navbar-link-color)}.menu__link--active:not(.menu__link--sublist),.paramsItem:focus,.paramsItem:hover,.paramsItem_PKlE:focus,.paramsItem_PKlE:hover,.schemaItem:focus,.schemaItem:hover,.schemaItem_P8yX:focus,.schemaItem_P8yX:hover{background-color:var(--ifm-menu-color-background-active)}.menu__caret:before{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem}.navbar--dark,html[data-theme=dark]{--ifm-menu-link-sublist-icon-filter:invert(100%) sepia(94%) saturate(17%) hue-rotate(223deg) brightness(104%) contrast(98%)}.navbar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-navbar-shadow);height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.docsWrapper_BCFX,.flex,.navbar,.navbar>.container,.navbar>.container-fluid,.theme-edit-this-page{display:flex}.navbar--fixed-top{position:sticky;top:0;z-index:var(--ifm-z-index-fixed)}.navbar__inner{display:flex;flex-wrap:wrap;justify-content:space-between;width:100%}.navbar__brand{align-items:center;display:flex;margin-right:1rem;min-width:0}.navbar__brand:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.announcementBarContent_xLdY,.navbar__title{flex:1 1 auto}.navbar__toggle{display:none;margin-right:.5rem}.navbar__logo{flex:0 0 auto;height:2rem;margin-right:.5rem}.docs-wrapper,.navbar__logo img,body,html{height:100%}.navbar__items{align-items:center;display:flex;flex:1;min-width:0}.navbar__items--center{flex:0 0 auto}.navbar__items--center+.navbar__items--right{flex:1}.navbar__items--right{flex:0 0 auto;justify-content:flex-end}.navbar__items--right>:last-child,.pr-0{padding-right:0}.navbar__item{display:inline-block;padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.navbar__link--active,.navbar__link:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.navbar--dark,.navbar--primary{--ifm-menu-color:var(--ifm-color-gray-300);--ifm-navbar-link-color:var(--ifm-color-gray-100);--ifm-navbar-search-input-background-color:#ffffff1a;--ifm-navbar-search-input-placeholder-color:#ffffff80;color:var(--ifm-color-white)}.navbar--dark{--ifm-navbar-background-color:#242526;--ifm-menu-color-background-active:#ffffff0d;--ifm-navbar-search-input-color:var(--ifm-color-white)}.navbar--primary{--ifm-navbar-background-color:var(--ifm-color-primary);--ifm-navbar-link-hover-color:var(--ifm-color-white);--ifm-menu-color-active:var(--ifm-color-white);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-500)}.navbar__search-input{-webkit-appearance:none;appearance:none;background:var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat .75rem center/1rem 1rem;border:none;border-radius:2rem;color:var(--ifm-navbar-search-input-color);cursor:text;display:inline-block;font-size:.9rem;height:2rem;padding:0 .5rem 0 2.25rem;width:12.5rem}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar-sidebar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-global-shadow-md);position:fixed;transform:translate3d(-100%,0,0);transition-duration:.25s;transition-property:opacity,visibility,transform;width:var(--ifm-navbar-sidebar-width)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar__items{transform:translateZ(0)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar--show .navbar-sidebar__backdrop{opacity:1;visibility:visible}.navbar-sidebar__backdrop{background-color:#0009;position:fixed;right:0;transition-duration:.1s;transition-property:opacity,visibility}.buttonGroup_SdX7 button.selected_VHjy,.buttonGroup_SdX7 button:hover,.navbar-sidebar__back{background:var(--ifm-menu-color-background-active)}.navbar-sidebar__brand{align-items:center;box-shadow:var(--ifm-navbar-shadow);display:flex;flex:1;height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar-sidebar__items{display:flex;height:calc(100% - var(--ifm-navbar-height));transition:transform var(--ifm-transition-fast) ease-in-out}.navbar-sidebar__items--show-secondary{transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0)}.navbar-sidebar__item{flex-shrink:0;padding:.5rem;width:calc(var(--ifm-navbar-sidebar-width))}.navbar-sidebar__back{font-size:15px;font-weight:var(--ifm-button-font-weight);margin:0 0 .2rem -.5rem;padding:.6rem 1.5rem;position:relative;text-align:left;top:-.5rem;width:calc(100% + 1rem)}.navbar-sidebar__close{display:flex;margin-left:auto}.pagination{column-gap:var(--ifm-pagination-page-spacing);display:flex;font-size:var(--ifm-pagination-font-size);padding-left:0}.pagination--sm{--ifm-pagination-font-size:0.8rem;--ifm-pagination-padding-horizontal:0.8rem;--ifm-pagination-padding-vertical:0.2rem}.pagination--lg{--ifm-pagination-font-size:1.2rem;--ifm-pagination-padding-horizontal:1.2rem;--ifm-pagination-padding-vertical:0.3rem}.inline-flex,.pagination__item{display:inline-flex}.pagination__item>span{padding:var(--ifm-pagination-padding-vertical)}.pagination__item--active .pagination__link{color:var(--ifm-pagination-color-active)}.pagination__item--active .pagination__link,.pagination__item:not(.pagination__item--active):hover .pagination__link{background:var(--ifm-pagination-item-active-background)}.pagination__item--disabled,.pagination__item[disabled]{opacity:.25;pointer-events:none}.pagination__link{border-radius:var(--ifm-pagination-border-radius);color:var(--ifm-font-color-base);display:inline-block;padding:var(--ifm-pagination-padding-vertical) var(--ifm-pagination-padding-horizontal);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination__link:hover{text-decoration:none}.pagination-nav{grid-gap:var(--ifm-spacing-horizontal);display:grid;gap:var(--ifm-spacing-horizontal);grid-template-columns:repeat(2,1fr)}.pagination-nav__link{border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-pagination-nav-border-radius);display:block;height:100%;line-height:var(--ifm-heading-line-height);padding:var(--ifm-global-spacing);transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav__link:hover{border-color:var(--ifm-pagination-nav-color-hover);text-decoration:none}.pagination-nav__link--next{grid-column:2/3;text-align:right}.pagination-nav__label{font-size:var(--ifm-h4-font-size);font-weight:var(--ifm-heading-font-weight);word-break:break-word}.pagination-nav__link--prev .pagination-nav__label:before{content:"« "}.pagination-nav__link--next .pagination-nav__label:after{content:" »"}.pagination-nav__sublabel{color:var(--ifm-color-content-secondary);font-size:var(--ifm-h5-font-size);font-weight:var(--ifm-font-weight-semibold);margin-bottom:.25rem}.pills__item,.tabs{font-weight:var(--ifm-font-weight-bold)}.pills{display:flex;gap:var(--ifm-pills-spacing);padding-left:0}.pills__item{border-radius:.5rem;cursor:pointer;display:inline-block;padding:.25rem 1rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.menu__list li,.tabs,.theme-api-markdown ul,:not(.containsTaskList_mC6p>li)>.containsTaskList_mC6p{padding-left:0}.pills__item--active{color:var(--ifm-pills-color-active)}.pills__item--active,.pills__item:not(.pills__item--active):hover{background:var(--ifm-pills-color-background-active)}.pills--block{justify-content:stretch}.pills--block .pills__item{flex-grow:1;text-align:center}.tabs{color:var(--ifm-tabs-color);display:flex;margin-bottom:0;overflow-x:auto}.mb-6,.my-6{margin-bottom:1.5rem}.tabs__item{border-bottom:3px solid #0000;border-radius:var(--ifm-global-radius);cursor:pointer;display:inline-flex;padding:var(--ifm-tabs-padding-vertical) var(--ifm-tabs-padding-horizontal);transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs__item--active{border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}.tabs__item:hover{background-color:var(--ifm-hover-overlay)}.tabs--block{justify-content:stretch}.tabs--block .tabs__item{flex-grow:1;justify-content:center}html[data-theme=dark]{--ifm-color-scheme:dark;--ifm-color-emphasis-0:var(--ifm-color-gray-1000);--ifm-color-emphasis-100:var(--ifm-color-gray-900);--ifm-color-emphasis-200:var(--ifm-color-gray-800);--ifm-color-emphasis-300:var(--ifm-color-gray-700);--ifm-color-emphasis-400:var(--ifm-color-gray-600);--ifm-color-emphasis-600:var(--ifm-color-gray-400);--ifm-color-emphasis-700:var(--ifm-color-gray-300);--ifm-color-emphasis-800:var(--ifm-color-gray-200);--ifm-color-emphasis-900:var(--ifm-color-gray-100);--ifm-color-emphasis-1000:var(--ifm-color-gray-0);--ifm-background-color:#1b1b1d;--ifm-background-surface-color:#242526;--ifm-hover-overlay:#ffffff0d;--ifm-color-content:#e3e3e3;--ifm-color-content-secondary:#fff;--ifm-breadcrumb-separator-filter:invert(64%) sepia(11%) saturate(0%) hue-rotate(149deg) brightness(99%) contrast(95%);--ifm-code-background:#ffffff1a;--ifm-scrollbar-track-background-color:#444;--ifm-scrollbar-thumb-background-color:#686868;--ifm-scrollbar-thumb-hover-background-color:#7a7a7a;--ifm-table-stripe-background:#ffffff12;--ifm-toc-border-color:var(--ifm-color-emphasis-200);--ifm-color-primary-contrast-background:#102445;--ifm-color-primary-contrast-foreground:#ebf2fc;--ifm-color-secondary-contrast-background:#474748;--ifm-color-secondary-contrast-foreground:#fdfdfe;--ifm-color-success-contrast-background:#003100;--ifm-color-success-contrast-foreground:#e6f6e6;--ifm-color-info-contrast-background:#193c47;--ifm-color-info-contrast-foreground:#eef9fd;--ifm-color-warning-contrast-background:#4d3800;--ifm-color-warning-contrast-foreground:#fff8e6;--ifm-color-danger-contrast-background:#4b1113;--ifm-color-danger-contrast-foreground:#ffebec;--docsearch-text-color:#f5f6f7;--docsearch-container-background:#090a11cc;--docsearch-modal-background:#15172a;--docsearch-modal-shadow:inset 1px 1px 0 0 #2c2e40,0 3px 8px 0 #000309;--docsearch-searchbox-background:#090a11;--docsearch-searchbox-focus-background:#000;--docsearch-hit-color:#bec3c9;--docsearch-hit-shadow:none;--docsearch-hit-background:#090a11;--docsearch-key-gradient:linear-gradient(-26.5deg,#565872,#31355b);--docsearch-key-shadow:inset 0 -2px 0 0 #282d55,inset 0 0 1px 1px #51577d,0 2px 2px 0 #0304094d;--docsearch-footer-background:#1e2136;--docsearch-footer-shadow:inset 0 1px 0 0 #494c6a80,0 -4px 8px 0 #0003;--docsearch-logo-color:#fff;--docsearch-muted-color:#7f8497}#nprogress .bar{background:var(--docusaurus-progress-bar-color);height:2px;left:0;position:fixed;top:0;width:100%;z-index:1031}#nprogress .peg,.absolute{position:absolute}#nprogress .peg{box-shadow:0 0 10px var(--docusaurus-progress-bar-color),0 0 5px var(--docusaurus-progress-bar-color);height:100%;opacity:1;right:0;transform:rotate(3deg) translateY(-4px);width:100px}*,:after,:before{border:0 solid #e5e7eb;--tw-border-spacing-x:0;--tw-border-spacing-y:0;--tw-translate-x:0;--tw-translate-y:0;--tw-rotate:0;--tw-skew-x:0;--tw-skew-y:0;--tw-scale-x:1;--tw-scale-y:1;--tw-pan-x: ;--tw-pan-y: ;--tw-pinch-zoom: ;--tw-scroll-snap-strictness:proximity;--tw-ordinal: ;--tw-slashed-zero: ;--tw-numeric-figure: ;--tw-numeric-spacing: ;--tw-numeric-fraction: ;--tw-ring-inset: ;--tw-ring-offset-width:0px;--tw-ring-offset-color:#fff;--tw-ring-color:#3b82f680;--tw-ring-offset-shadow:0 0 #0000;--tw-ring-shadow:0 0 #0000;--tw-shadow:0 0 #0000;--tw-shadow-colored:0 0 #0000;--tw-blur: ;--tw-brightness: ;--tw-contrast: ;--tw-grayscale: ;--tw-hue-rotate: ;--tw-invert: ;--tw-saturate: ;--tw-sepia: ;--tw-drop-shadow: ;--tw-backdrop-blur: ;--tw-backdrop-brightness: ;--tw-backdrop-contrast: ;--tw-backdrop-grayscale: ;--tw-backdrop-hue-rotate: ;--tw-backdrop-invert: ;--tw-backdrop-opacity: ;--tw-backdrop-saturate: ;--tw-backdrop-sepia: }:after,:before{--tw-content:""}html{-webkit-text-size-adjust:100%;font-feature-settings:normal;font-family:ui-sans-serif,system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji;line-height:1.5;tab-size:4}body{line-height:inherit}hr{border-top-width:1px;height:0}abbr:where([title]){-webkit-text-decoration:underline dotted;text-decoration:underline dotted}h1,h2,h3,h4,h5,h6{font-size:inherit;font-weight:inherit}b,strong{font-weight:bolder}code,kbd,pre,samp{font-family:ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;font-size:1em}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative}sub{bottom:-.25em}sup{top:-.5em}table{display:block;margin-bottom:var(--ifm-spacing-vertical);overflow:auto;border-collapse:collapse;border-color:inherit;text-indent:0}button,input,optgroup,select,textarea{color:inherit;font-family:inherit;font-size:100%;font-weight:inherit;line-height:inherit;margin:0;padding:0}.admonitionHeading_tbUL code,button,select{text-transform:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button;background-color:initial;background-image:none}:-moz-focusring{outline:auto}:-moz-ui-invalid{box-shadow:none}::-webkit-inner-spin-button,::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}summary{display:list-item}menu,ol,ul{list-style:none;padding:0}textarea{resize:vertical}input::placeholder,textarea::placeholder{color:#9ca3af;opacity:1}.tabArrow_LyoO:hover,.tabArrow_WDKX:hover,.tabArrow_x5p_:hover,.tabArrow_zmvw:hover,[role=button],button{cursor:pointer}:disabled{cursor:default}audio,canvas,embed,iframe,img,object,svg,video{display:block;vertical-align:middle}img,video{height:auto;max-width:100%}#docusaurus-base-url-issue-banner-container,.hidden,.markdown #authentication,.markdown #authentication+div,.themedImage_ToTc,[data-theme=dark] .lightToggleIcon_pyhR,[data-theme=light] .darkToggleIcon_wfgR,[hidden],html[data-announcement-bar-initially-dismissed=true] .announcementBar_mb4j{display:none}::backdrop{--tw-border-spacing-x:0;--tw-border-spacing-y:0;--tw-translate-x:0;--tw-translate-y:0;--tw-rotate:0;--tw-skew-x:0;--tw-skew-y:0;--tw-scale-x:1;--tw-scale-y:1;--tw-pan-x: ;--tw-pan-y: ;--tw-pinch-zoom: ;--tw-scroll-snap-strictness:proximity;--tw-ordinal: ;--tw-slashed-zero: ;--tw-numeric-figure: ;--tw-numeric-spacing: ;--tw-numeric-fraction: ;--tw-ring-inset: ;--tw-ring-offset-width:0px;--tw-ring-offset-color:#fff;--tw-ring-color:#3b82f680;--tw-ring-offset-shadow:0 0 #0000;--tw-ring-shadow:0 0 #0000;--tw-shadow:0 0 #0000;--tw-shadow-colored:0 0 #0000;--tw-blur: ;--tw-brightness: ;--tw-contrast: ;--tw-grayscale: ;--tw-hue-rotate: ;--tw-invert: ;--tw-saturate: ;--tw-sepia: ;--tw-drop-shadow: ;--tw-backdrop-blur: ;--tw-backdrop-brightness: ;--tw-backdrop-contrast: ;--tw-backdrop-grayscale: ;--tw-backdrop-hue-rotate: ;--tw-backdrop-invert: ;--tw-backdrop-opacity: ;--tw-backdrop-saturate: ;--tw-backdrop-sepia: }.my-6{margin-top:1.5rem}.-mt-1{margin-top:-.25rem}.ml-1{margin-left:.25rem}.mt-4{margin-top:1rem}.mb-2{margin-bottom:.5rem}.mb-3{margin-bottom:.75rem}.mt-5{margin-top:1.25rem}.mb-8{margin-bottom:2rem}.grid{display:grid}.\!hidden{display:none!important}.h-72{height:18rem}.w-auto{width:auto}.responseSamplesTabItem_f_p_,.w-full{width:100%}.w-\[480px\]{width:480px}.min-w-\[480px\]{min-width:480px}.max-w-lg{max-width:32rem}.max-w-sm{max-width:24rem}.transform{transform:translate(var(--tw-translate-x),var(--tw-translate-y)) rotate(var(--tw-rotate)) skewX(var(--tw-skew-x)) skewY(var(--tw-skew-y)) scaleX(var(--tw-scale-x)) scaleY(var(--tw-scale-y))}.cursor-wait{cursor:wait}.flex-row{flex-direction:row}.flex-col{flex-direction:column}.flex-wrap{flex-wrap:wrap}.place-content-center{place-content:center}.place-items-end{place-items:end}.content-center{align-content:center}.justify-start{justify-content:flex-start}.justify-end{justify-content:flex-end}.justify-center{justify-content:center}.justify-between{justify-content:space-between}.gap-2{gap:.5rem}.gap-1{gap:.25rem}.gap-8{gap:2rem}.gap-3{gap:.75rem}.gap-4{gap:1rem}.rounded{border-radius:.25rem}.border{border-width:1px}.border-b{border-bottom-width:1px}.border-b-2{border-bottom-width:2px}.border-black{--tw-border-opacity:1;border-color:rgb(0 0 0/var(--tw-border-opacity))}.bg-white{--tw-bg-opacity:1;background-color:rgb(255 255 255/var(--tw-bg-opacity))}.p-5{padding:1.25rem}.px-4{padding-left:1rem;padding-right:1rem}.py-4{padding-bottom:1rem;padding-top:1rem}.py-8{padding-bottom:2rem;padding-top:2rem}.px-8{padding-left:2rem;padding-right:2rem}.px-3{padding-left:.75rem;padding-right:.75rem}.py-2{padding-bottom:.5rem;padding-top:.5rem}.pt-5{padding-top:1.25rem}.pb-3{padding-bottom:.75rem}.pb-10{padding-bottom:2.5rem}.pt-7{padding-top:1.75rem}.pl-5{padding-left:1.25rem}.text-left{text-align:left}.text-sm{font-size:.875rem;line-height:1.25rem}.text-xs{font-size:.75rem;line-height:1rem}.text-base{font-size:1rem;line-height:1.5rem}.text-4xl{font-size:2.25rem;line-height:2.5rem}.font-bold{font-weight:700}.font-normal{font-weight:400}.tabItem_AM8E,.tabItem_fIhq{font-weight:var(--ifm-font-weight-normal)}.leading-6{line-height:1.5rem}.text-black{--tw-text-opacity:1;color:rgb(0 0 0/var(--tw-text-opacity))}.text-gray-600{--tw-text-opacity:1;color:rgb(75 85 99/var(--tw-text-opacity))}.shadow-md{--tw-shadow:0 4px 6px -1px #0000001a,0 2px 4px -2px #0000001a;--tw-shadow-colored:0 4px 6px -1px var(--tw-shadow-color),0 2px 4px -2px var(--tw-shadow-color);box-shadow:var(--tw-ring-offset-shadow,0 0 #0000),var(--tw-ring-shadow,0 0 #0000),var(--tw-shadow)}.blur{--tw-blur:blur(8px)}.blur,.drop-shadow,.drop-shadow-lg,.filter{filter:var(--tw-blur) var(--tw-brightness) var(--tw-contrast) var(--tw-grayscale) var(--tw-hue-rotate) var(--tw-invert) var(--tw-saturate) var(--tw-sepia) var(--tw-drop-shadow)}.tabArrow_LyoO,.tabArrow_WDKX,.tabArrow_x5p_,.tabArrow_zmvw,.tocCollapsibleButton_TO0P:after{filter:var(--ifm-menu-link-sublist-icon-filter)}.drop-shadow{--tw-drop-shadow:drop-shadow(0 1px 2px #0000001a) drop-shadow(0 1px 1px #0000000f)}.drop-shadow-lg{--tw-drop-shadow:drop-shadow(0 10px 8px #0000000a) drop-shadow(0 4px 3px #0000001a)}.backdrop-filter{-webkit-backdrop-filter:var(--tw-backdrop-blur) var(--tw-backdrop-brightness) var(--tw-backdrop-contrast) var(--tw-backdrop-grayscale) var(--tw-backdrop-hue-rotate) var(--tw-backdrop-invert) var(--tw-backdrop-opacity) var(--tw-backdrop-saturate) var(--tw-backdrop-sepia);backdrop-filter:var(--tw-backdrop-blur) var(--tw-backdrop-brightness) var(--tw-backdrop-contrast) var(--tw-backdrop-grayscale) var(--tw-backdrop-hue-rotate) var(--tw-backdrop-invert) var(--tw-backdrop-opacity) var(--tw-backdrop-saturate) var(--tw-backdrop-sepia)}.transition{transition-duration:.15s;transition-property:color,background-color,border-color,text-decoration-color,fill,stroke,opacity,box-shadow,transform,filter,backdrop-filter,-webkit-backdrop-filter;transition-timing-function:cubic-bezier(.4,0,.2,1)}[data-theme=dark]{--ifm-color-primary-dark:#b4eedd;--ifm-color-primary-darker:#8ae5ca;--ifm-color-primary-darkest:#61dcb7;--ifm-color-primary-light:#27af86;--ifm-color-primary-lighter:#37d2a4;--ifm-color-primary-lightest:#61dcb7;--docusaurus-highlighted-code-line-bg:#0000004d;--openapi-card-background-color:var(--ifm-color-gray-900)!important}a:any-link:hover{text-decoration:none}h1,h2,h3,h4,h5,h6{color:var(--ifm-heading-color);font-family:var(--ifm-heading-font-family);font-weight:var(--ifm-heading-font-weight);line-height:var(--ifm-heading-line-height);margin:var(--ifm-heading-margin-top) 0 var(--ifm-heading-margin-bottom) 0}.markdown ol,.markdown ul,p{line-height:var(--voc-line-height)}h1{font-size:var(--ifm-h1-font-size)}h2{font-size:var(--ifm-h2-font-size)}h3{font-size:var(--ifm-h3-font-size)}h4{font-size:var(--ifm-h4-font-size)}h5{font-size:var(--ifm-h5-font-size)}h6{font-size:var(--ifm-h6-font-size)}p{margin-bottom:25px}ul{list-style-type:disc}ol{list-style-type:decimal}li{padding-left:10px}.header-github-link:hover,.header-medium-link:hover,.schemaName_KIS9,.schemaName_MpGo{opacity:.6}.header-medium-link:before{content:"\f37d";font-family:Font Awesome\ 5 Brands;font-size:x-large}.main-wrapper h1[class^=docTitle]{font-size:2.8rem}.imgBanner{border:3px solid #fff;border-radius:12px;max-width:250px;width:250px}.hover\:underline:hover{text-decoration-line:underline}.docItemCol_node_modules-docusaurus-theme-openapi-docs-lib-next-theme-ApiItem-Layout-styles-module .card>h2{overflow:unset;text-overflow:unset;white-space:unset}.breadcrumbs svg,.navbar__item svg,.tags_jXut{display:inline}.api-method>.menu__link{align-items:center;justify-content:start}.api-method>.menu__link:before{border:1px solid #0000;border-radius:.25rem;color:#fff;flex-shrink:0;font-size:12px;font-weight:600;height:20px;line-height:20px;margin-right:var(--ifm-spacing-horizontal);text-align:center;width:50px}.get>.menu__link:before{background-color:#3465a4;content:"get"}.post>.menu__link:before{background-color:var(--openapi-code-green);content:"post"}.delete>.menu__link:before{background-color:var(--openapi-code-red);content:"del"}.put>.menu__link:before{background-color:var(--openapi-code-blue);content:"put"}.patch>.menu__link:before{background-color:var(--openapi-code-orange);content:"patch"}.head>.menu__link:before{background-color:var(--ifm-color-secondary-darkest);content:"head"}.header-github-link:before{background:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat;content:"";display:flex;height:24px;width:24px}html[data-theme=dark] .header-github-link:before{background:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='%23fff' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat}.badge+span{vertical-align:middle}.formItem_node_modules-docusaurus-theme-openapi-docs-lib-next-theme-ApiDemoPanel-FormItem-styles-module>code{padding:5px 8px}.required_node_modules-docusaurus-theme-openapi-docs-lib-next-theme-ApiDemoPanel-FormItem-styles-module{margin-left:8px}.markdown{--ifm-h1-vertical-rhythm-top:3;--ifm-h2-vertical-rhythm-top:2;--ifm-h3-vertical-rhythm-top:1.5;--ifm-heading-vertical-rhythm-top:1.25;--ifm-h1-vertical-rhythm-bottom:1.25;--ifm-heading-vertical-rhythm-bottom:1}.markdown h1:first-child{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-h1-vertical-rhythm-bottom)*var(--ifm-leading));font-size:2.5rem;margin-top:0}.markdown h1{border-top:1px dotted #bbb;margin-top:35px;padding-top:30px}.markdown h2,.markdown h3{padding-top:20px}.markdown h4{padding-top:15px}.markdown ol,.markdown ul{margin:0 0 var(--ifm-paragraph-margin-bottom) 30px}.docusaurus-mermaid-container{margin:50px 10px}.inline-img-container{margin-bottom:var(--ifm-heading-margin-bottom);width:100%}div[class*=" announcementBar"],div[class^=announcementBar]{-webkit-backdrop-filter:blur(12px);backdrop-filter:blur(12px);background:linear-gradient(90deg,#e7ff0000 -.01%,#00ddb3);border-bottom:none;height:-moz-fit-content;height:fit-content;padding:0;text-align:left}div[class*=" announcementBar"] p,div[class^=announcementBar] p{background:linear-gradient(90deg,#00ddb300 -.01%,#ff005d 125%);color:#000;font-size:13px;margin-bottom:0;padding:0 20px}.feedback-wrapper{align-items:center;color:#69757a;display:inline-flex;font-size:1.125rem;margin-bottom:10px;margin-top:10px;padding-bottom:10px;padding-top:10px;position:relative}.feedback-wrapper .confirmation-content,.feedback-wrapper .feedback-button i svg{height:100%;width:100%}.feedback-wrapper .confirmationMessage{display:block;text-align:center;width:100%}.feedback-wrapper .cta-content{align-items:center;display:flex;text-align:center;width:100%}.feedback-wrapper .cta-text{margin-right:1rem}.feedback-wrapper .feedback-options{display:contents;grid-template-columns:1fr;list-style:none;margin:0;padding:0}.feedback-wrapper .feedback-button{align-items:center;background:#e8eced;border:0;border-radius:50%;cursor:pointer;display:flex;height:3rem;justify-content:center;width:3rem}.feedback-wrapper .feedback-button:hover{background:#afb0b0}.feedback-wrapper .feedback-button i{color:#69757a;display:inherit}:root{--ifm-color-primary-dark:#1e8666;--ifm-color-primary-darker:#145c46;--ifm-color-primary-darkest:#0b3226;--ifm-color-primary-light:#007575;--ifm-color-primary-lighter:#00a7a7;--ifm-color-primary-lightest:#00dbdb;--docusaurus-highlighted-code-line-bg:#0000001a;--ifm-background-color:var(--ifm-color-emphasis-0)!important;--ifm-footer-background-color:#0000;--ifm-font-family-monospace:"Fira Code",monospace;--ifm-font-family-base:Manrope,sans-serif;--ifm-code-font-size:90%;--voc-line-height:28px;--ifm-font-size-base:17px;--feedback-component-button-size:3rem;--voc-landing-background-gradient:linear-gradient(90deg,#e7ff0000 -0.01%,#00ddb3);--voc-navbar-landing-background-gradient:linear-gradient(90deg,#e7ff0000 -0.01%,#00ddb3 200%),#ffffff40;--ifm-navbar-shadow:#ffffff80 0px 1px 1px 0px;--ifm-navbar-search-input-background-color:#0000;--ifm-navbar-search-input-color:#000;--ifm-navbar-search-input-placeholder-color:var(--ifm-navbar-search-input-color);font-family:Manrope,sans-serif;--openapi-required:var(--ifm-color-danger);--openapi-deprecated:var(--ifm-color-warning);--openapi-code-blue:var(--ifm-color-info);--openapi-code-red:var(--ifm-color-danger);--openapi-code-orange:var(--ifm-color-warning);--openapi-code-green:var(--ifm-color-success);--openapi-card-background-color:var(--ifm-color-gray-100);--openapi-card-border-radius:var(--ifm-pre-border-radius);--openapi-input-border:var(--ifm-color-primary);--openapi-input-background:var(--openapi-card-background-color);--docusaurus-announcement-bar-height:auto;--docusaurus-collapse-button-bg:#0000;--docusaurus-collapse-button-bg-hover:#0000001a;--doc-sidebar-width:300px;--doc-sidebar-hidden-width:30px;--docusaurus-tag-list-border:var(--ifm-color-emphasis-300);--docsearch-primary-color:#5468ff;--docsearch-text-color:#1c1e21;--docsearch-spacing:12px;--docsearch-icon-stroke-width:1.4;--docsearch-highlight-color:var(--docsearch-primary-color);--docsearch-muted-color:#969faf;--docsearch-container-background:#656c85cc;--docsearch-logo-color:#5468ff;--docsearch-modal-width:560px;--docsearch-modal-height:600px;--docsearch-modal-background:#f5f6f7;--docsearch-modal-shadow:inset 1px 1px 0 0 #ffffff80,0 3px 8px 0 #555a64;--docsearch-searchbox-height:56px;--docsearch-searchbox-background:#ebedf0;--docsearch-searchbox-focus-background:#fff;--docsearch-searchbox-shadow:inset 0 0 0 2px var(--docsearch-primary-color);--docsearch-hit-height:56px;--docsearch-hit-color:#444950;--docsearch-hit-active-color:#fff;--docsearch-hit-background:#fff;--docsearch-hit-shadow:0 1px 3px 0 #d4d9e1;--docsearch-key-gradient:linear-gradient(-225deg,#d5dbe4,#f8f8f8);--docsearch-key-shadow:inset 0 -2px 0 0 #cdcde6,inset 0 0 1px 1px #fff,0 1px 2px 1px #1e235a66;--docsearch-footer-height:44px;--docsearch-footer-background:#fff;--docsearch-footer-shadow:0 -1px 0 0 #e0e3e8,0 -3px 6px 0 #45629b1f;--docsearch-primary-color:var(--ifm-color-primary);--docsearch-text-color:var(--ifm-font-color-base)}.theme-api-markdown div[class^=collapsibleContent]{margin-top:0!important;padding-left:2px}.theme-api-markdown details{--docusaurus-details-decoration-color:var(--ifm-font-color-base);background-color:initial;border:unset!important;box-shadow:unset!important;color:var(--ifm-font-color-base);margin:unset;max-width:600px;padding:unset}.theme-api-markdown details ul{font-size:14px;padding-left:0}.theme-api-markdown details li{list-style:none;padding-bottom:5px;padding-top:5px}.theme-api-markdown details>div>div{border-top:unset!important;padding-top:unset!important}.theme-api-markdown .details__demo-panel{background:var(--openapi-card-background-color);border-radius:var(--openapi-card-border-radius);margin-bottom:1rem}.theme-api-markdown .details__demo-panel>summary{cursor:pointer;padding-left:1rem;padding-top:1rem}.codeBlockTitle_Ktv7+.codeBlockContent_biex .codeBlock_bY9V,.theme-api-markdown .details__demo-panel>div>div>pre{border-top-left-radius:0;border-top-right-radius:0}.theme-api-markdown .details__demo-panel>summary::marker{content:"";display:none}.theme-api-markdown .details__demo-panel>summary::-webkit-details-marker{content:"";display:none}.theme-api-markdown .details__demo-panel>pre{margin-bottom:0;padding-top:0}.theme-api-markdown .details__request-summary>button,.theme-api-markdown .details__response-summary>button{margin-bottom:1rem;margin-right:1rem}.mimeTabsTopSection_wt53,.theme-api-markdown .details__request-summary,.theme-api-markdown .details__response-summary{align-items:center;display:flex;justify-content:space-between}.theme-api-markdown code{max-width:600px}.tocCollapsibleContent_vkbj a,.version-button div{display:block}.version-button div>button>span:after{border-color:currentcolor #0000;border-style:solid;border-width:.4em .4em 0;content:"";display:inline-block;font-size:.8rem;margin-left:.3em;position:relative;top:1px;transform:translateY(-50%)}[class^=paramsItem]:before,[class^=schemaItem]:before{border-bottom:thin solid var(--ifm-color-gray-500);content:"";display:inline-block;height:.5rem;left:0;position:absolute;top:10px;vertical-align:top;width:.7rem}.code__tab--bash:after,.code__tab--csharp:after,.code__tab--go:after,.code__tab--javascript:after,.code__tab--nodejs:after,.code__tab--php:after,.code__tab--python:after,.code__tab--ruby:after{height:28px;margin-block:auto;width:28px;content:""}.schemaItem{padding:5px 0 5px 1rem}.discriminatorItem,.schemaItem{border-left:thin solid var(--ifm-color-gray-500)!important;list-style:none;margin:0!important;position:relative}.discriminatorItem{padding:5px 0!important}.code__tab--go,.code__tab--python{padding-left:1.4rem;padding-right:1.4rem}.code__tab--python:after{background:url(https://raw.githubusercontent.com/devicons/devicon/master/icons/python/python-original.svg)}.code__tab--python{color:var(--ifm-color-success)}.code__tab--python.tabs__item--active{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-color-success)}.code__tab--go:after{background:url(https://raw.githubusercontent.com/devicons/devicon/master/icons/go/go-original-wordmark.svg)}.code__tab--go{color:var(--ifm-color-info)}.code__tab--go.tabs__item--active{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-color-info)}.code__tab--javascript:after{background:url(https://raw.githubusercontent.com/devicons/devicon/master/icons/javascript/javascript-original.svg)}.code__tab--javascript{color:var(--ifm-color-warning);padding-left:1.4rem;padding-right:1.4rem}.code__tab--bash,.code__tab--ruby{color:var(--ifm-color-danger);padding-left:1.4rem;padding-right:1.4rem}.code__tab--javascript.tabs__item--active{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-color-warning)}.code__tab--bash:after{background:url(https://raw.githubusercontent.com/devicons/devicon/master/icons/linux/linux-original.svg)}.code__tab--bash.tabs__item--active{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-color-danger)}.code__tab--ruby:after{background:url(https://raw.githubusercontent.com/devicons/devicon/master/icons/ruby/ruby-plain.svg)}.code__tab--ruby.tabs__item--active{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-color-danger)}.code__tab--csharp:after{background:url(https://raw.githubusercontent.com/devicons/devicon/master/icons/csharp/csharp-original.svg)}.code__tab--csharp{color:var(--ifm-color-gray-500);padding-left:1.4rem;padding-right:1.4rem}.code__tab--csharp.tabs__item--active{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-color-gray-500)}.code__tab--nodejs:after{background:url(https://raw.githubusercontent.com/devicons/devicon/master/icons/nodejs/nodejs-original.svg)}.code__tab--nodejs{color:var(--ifm-color-success);padding-left:1.4rem;padding-right:1.4rem}.code__tab--nodejs.tabs__item--active{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-color-success)}.code__tab--php:after{background:url(https://raw.githubusercontent.com/devicons/devicon/master/icons/php/php-original.svg)}.code__tab--php{color:var(--ifm-color-gray-500);padding-left:1.4rem;padding-right:1.4rem}.code__tab--php.tabs__item--active{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-color-gray-500)}.prism-code.language-json{white-space:pre!important}.buttonDelete_vlNf:focus,.buttonGroup_SdX7 button:focus,.buttonThin_xRd9:focus,body:not(.navigation-with-keyboard) :not(input):focus{outline:0}.skipToContent_fXgn{background-color:var(--ifm-background-surface-color);color:var(--ifm-color-emphasis-900);left:100%;padding:calc(var(--ifm-global-spacing)/2) var(--ifm-global-spacing);position:fixed;top:1rem;z-index:calc(var(--ifm-z-index-fixed) + 1)}.skipToContent_fXgn:focus{box-shadow:var(--ifm-global-shadow-md);left:1rem}.closeButton_CVFx{line-height:0;padding:0}.content_knG7{font-size:85%;padding:5px 0;text-align:center}.content_knG7 a{color:inherit;text-decoration:underline}.DocSearch-Container a,.tag_zVej:hover{text-decoration:none}.announcementBar_mb4j{align-items:center;background-color:var(--ifm-color-white);border-bottom:1px solid var(--ifm-color-emphasis-100);color:var(--ifm-color-black);display:flex;height:var(--docusaurus-announcement-bar-height)}.announcementBarPlaceholder_vyr4{flex:0 0 10px}.announcementBarClose_gvF7{align-self:stretch;flex:0 0 30px}.toggle_vylO{height:2rem;width:2rem}.toggleButton_gllP{align-items:center;border-radius:50%;display:flex;height:100%;justify-content:center;transition:background var(--ifm-transition-fast);width:100%}.toggleButton_gllP:hover{background:var(--ifm-color-emphasis-200)}.toggleButtonDisabled_aARS{cursor:not-allowed}[data-theme=dark] .themedImage--dark_i4oU,[data-theme=light] .themedImage--light_HNdA{display:initial}.iconExternalLink_2l9O{margin-left:.3rem}.iconLanguage_nlXk{margin-right:5px;vertical-align:text-bottom}.navbarHideable_m1mJ{transition:transform var(--ifm-transition-fast) ease}.navbarHidden_jGov{transform:translate3d(0,calc(-100% - 2px),0)}.footerLogoLink_BH7S{opacity:.5;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.footerLogoLink_BH7S:hover,.hash-link:focus,:hover>.hash-link{opacity:1}.mainWrapper_z2l0{flex:1 0 auto}.docusaurus-mt-lg{margin-top:3rem}#__docusaurus{display:flex;flex-direction:column;min-height:100%}.tabItem_fIhq{align-items:center;border:1px solid var(--ifm-color-primary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-primary);display:flex;height:2.5rem;justify-content:center;margin-right:.5rem;margin-top:0!important}.tabItem_VIbn:not(.discriminatorTabActive_wwM1),.tabItem_es3Q:not(.schemaTabActive_dWHR),.tabItem_fIhq:not(.responseTabActive_5Lhs){opacity:.65}.tabItem_VIbn:hover,.tabItem_es3Q:hover,.tabItem_fIhq:hover{background-color:var(--ifm-color-emphasis-100);opacity:1}.responseTabsTopSection_jEoq{align-items:center;display:flex;justify-content:space-between;margin-top:2rem}.responseTabsContainer_XEhZ{align-items:center;display:flex;max-width:390px;overflow:hidden;padding-left:1rem}.discriminatorTabsListContainer_Nnai,.responseTabsListContainer_itgM{overflow-x:scroll;overflow-y:hidden;padding:0 .25rem;scroll-behavior:smooth}.responseTabsListContainer_itgM::-webkit-scrollbar{display:none}.mimeTabDot_NO24,.responseTabDot_mwcE{border-radius:50%;height:12.5px;margin-right:5px;width:12.5px}.mimeTabDotSuccess_M1bZ,.responseTabDotSuccess_PzA9{background-color:var(--ifm-color-success)}.mimeTabDotDanger_NBeV,.responseTabDotDanger_S1vm{background-color:var(--ifm-color-danger)}.mimeTabDotInfo_R3vj,.responseTabDotInfo_iyT3{background-color:var(--ifm-color-info)}.responseTabActive_5Lhs,.schemaTabActive_dWHR,.tabItem_AM8E:active,.tabItem_VIbn.discriminatorTabActive_wwM1{background-color:var(--ifm-color-emphasis-100)}.mimeSchemaContainer_yYbZ,.responseSchemaContainer_Sp_v{max-width:600px}.tabArrow_LyoO,.tabArrow_x5p_{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;border:none;content:"";height:1.25rem;min-width:1.25rem;width:1.25rem}.tabArrowLeft_Cztf,.tabArrowLeft_RQtH,.tabArrowLeft_RzDG,.tabArrowLeft_woLb{transform:rotate(270deg)}.tabItem_AM8E{align-items:center;display:flex;font-size:12px;height:2rem;justify-content:center;margin-right:.5rem;margin-top:0!important}.mimeTabsContainer_gZbZ{align-items:center;display:flex;max-width:390px;overflow:hidden}.mimeTabsListContainer_LPoX,.schemaTabsListContainer_wmy4{overflow-x:scroll;overflow-y:hidden;scroll-behavior:smooth}.mimeTabsListContainer_LPoX::-webkit-scrollbar{display:none}.mimeTabActive_nq7U{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}.cardContainer_fWXF,.cardContainer_p3e_{--ifm-link-color:var(--ifm-color-emphasis-800);--ifm-link-hover-color:var(--ifm-color-emphasis-700);--ifm-link-hover-decoration:none;border:1px solid var(--ifm-color-emphasis-200);box-shadow:0 1.5px 3px 0 #00000026;transition:all var(--ifm-transition-fast) ease;transition-property:border,box-shadow}.cardContainer_fWXF:hover,.cardContainer_p3e_:hover{border-color:var(--ifm-color-primary);box-shadow:0 3px 6px 0 #0003}.cardTitle_HnZ_,.cardTitle_rnsV{font-size:1.2rem}.cardDescription_DHsZ,.cardDescription_PWke{font-size:.8rem}.searchQueryInput_u2C7,.searchVersionInput_m0Ui{background:var(--docsearch-searchbox-focus-background);border:2px solid var(--ifm-toc-border-color);border-radius:var(--ifm-global-radius);color:var(--docsearch-text-color);font:var(--ifm-font-size-base) var(--ifm-font-family-base);margin-bottom:.5rem;padding:.8rem;transition:border var(--ifm-transition-fast) ease;width:100%}.searchQueryInput_u2C7:focus,.searchVersionInput_m0Ui:focus{border-color:var(--docsearch-primary-color);outline:0}.searchQueryInput_u2C7::placeholder{color:var(--docsearch-muted-color)}.searchResultsColumn_JPFH{font-size:.9rem;font-weight:700}.algoliaLogo_rT1R{max-width:150px}.algoliaLogoPathFill_WdUC{fill:var(--ifm-font-color-base)}.searchResultItem_Tv2o{border-bottom:1px solid var(--ifm-toc-border-color);padding:1rem 0}.searchResultItemHeading_KbCB{font-weight:400;margin-bottom:0}.searchResultItemPath_lhe1{--ifm-breadcrumb-separator-size-multiplier:1;color:var(--ifm-color-content-secondary);font-size:.8rem}.searchResultItemSummary_AEaO{font-style:italic;margin:.5rem 0 0}.loadingSpinner_XVxU{animation:1s linear infinite a;border:.4em solid #eee;border-radius:50%;border-top:.4em solid var(--ifm-color-primary);height:3rem;margin:0 auto;width:3rem}.paramsItem_PKlE,.schemaItem_P8yX{border-left:thin solid var(--ifm-color-gray-500)!important}@keyframes a{to{transform:rotate(1turn)}}.loader_vvXV,.responseSamplesContainer_ITGy{margin-top:2rem}.search-result-match{background:#ffd78e40;color:var(--docsearch-hit-color);padding:.09em 0}.backToTopButton_sjWU{background-color:var(--ifm-color-emphasis-200);border-radius:50%;bottom:1.3rem;box-shadow:var(--ifm-global-shadow-lw);height:3rem;opacity:0;position:fixed;right:1.3rem;transform:scale(0);transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);visibility:hidden;width:3rem;z-index:calc(var(--ifm-z-index-fixed) - 1)}.backToTopButton_sjWU:after{background-color:var(--ifm-color-emphasis-1000);content:" ";display:inline-block;height:100%;-webkit-mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;width:100%}.backToTopButtonShow_xfvO{opacity:1;transform:scale(1);visibility:visible}[data-theme=dark]:root{--docusaurus-collapse-button-bg:#ffffff0d;--docusaurus-collapse-button-bg-hover:#ffffff1a}.collapseSidebarButton_PEFL,.docSidebarContainer_b6E3,.sidebarLogo_isFc{display:none}.docMainContainer_gTbr,.docPage__5DB{display:flex;width:100%}.breadcrumbsContainer_Z_bl{--ifm-breadcrumb-size-multiplier:0.8;margin-bottom:.8rem}.codeBlockContainer_Ckt0,.playgroundContainer_X_Ta{margin-bottom:var(--ifm-leading);box-shadow:var(--ifm-global-shadow-lw)}.breadcrumbHomeIcon_OVgt{height:1.1rem;position:relative;top:1px;vertical-align:top;width:1.1rem}.anchorWithStickyNavbar_LWe7{scroll-margin-top:calc(var(--ifm-navbar-height) + .5rem)}.anchorWithHideOnScrollNavbar_WYt5{scroll-margin-top:.5rem}.hash-link{opacity:0;padding-left:.5rem;transition:opacity var(--ifm-transition-fast);-webkit-user-select:none;user-select:none}.hash-link:before{content:"#"}.playgroundContainer_X_Ta{border-radius:var(--ifm-global-radius);overflow:hidden}.playgroundHeader_dyrN,.playgroundHeader_yAq7{background:var(--ifm-color-emphasis-200);color:var(--ifm-color-content);font-size:var(--ifm-code-font-size);font-weight:700;letter-spacing:.08rem;padding:.75rem;text-transform:uppercase}.playgroundHeader_dyrN:first-of-type,.playgroundHeader_yAq7:first-of-type{background:var(--ifm-color-emphasis-600);color:var(--ifm-color-content-inverse)}.playgroundEditor_Q6Y7,.playgroundEditor_nWOY{direction:ltr;font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace)!important}.playgroundPreview_DzOI,.playgroundPreview_iGtG{background-color:var(--ifm-pre-background);padding:1rem}.buttonGroup__atx button,.codeBlockContainer_Ckt0{background:var(--prism-background-color);color:var(--prism-color)}.codeBlockContainer_Ckt0{border-radius:var(--ifm-code-border-radius)}.codeBlockContent_biex{border-radius:inherit;direction:ltr;position:relative}.codeBlockTitle_Ktv7{border-bottom:1px solid var(--ifm-color-emphasis-300);border-top-left-radius:inherit;border-top-right-radius:inherit;font-size:var(--ifm-code-font-size);font-weight:500;padding:.75rem var(--ifm-pre-padding)}.codeBlock_bY9V{--ifm-pre-background:var(--prism-background-color);margin:0;padding:0}.codeBlockLines_e6Vv{float:left;font:inherit;min-width:100%;padding:var(--ifm-pre-padding)}.deprecated_K3O1,.paramsRequired_UKPH,.required_Wlqr,.required_cVzG{font-size:var(--ifm-code-font-size)}.codeBlockLinesWithNumbering_o6Pm{display:table;padding:var(--ifm-pre-padding) 0}.buttonGroup__atx{column-gap:.2rem;display:flex;position:absolute;right:calc(var(--ifm-pre-padding)/2);top:calc(var(--ifm-pre-padding)/2)}.buttonGroup__atx button{align-items:center;border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-global-radius);display:flex;line-height:0;opacity:0;padding:.4rem;transition:opacity .2s ease-in-out}.buttonGroup__atx button:focus-visible,.buttonGroup__atx button:hover{opacity:1!important}.theme-code-block:hover .buttonGroup__atx button{opacity:.4}:where(:root){--docusaurus-highlighted-code-line-bg:#484d5b}:where([data-theme=dark]){--docusaurus-highlighted-code-line-bg:#646464}.theme-code-block-highlighted-line{background-color:var(--docusaurus-highlighted-code-line-bg);display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}.codeLine_lJS_{counter-increment:a;display:table-row}.codeLineNumber_Tfdd{background:var(--ifm-pre-background);display:table-cell;left:0;overflow-wrap:normal;padding:0 var(--ifm-pre-padding);position:sticky;text-align:right;width:1%}.codeLineNumber_Tfdd:before{content:counter(a);opacity:.4}.codeLineContent_feaV{padding-right:var(--ifm-pre-padding)}.theme-code-block:hover .copyButtonCopied_obH4{opacity:1!important}.copyButtonIcons_eSgA{height:1.125rem;position:relative;width:1.125rem}.copyButtonIcon_y97N,.copyButtonSuccessIcon_LjdS{fill:currentColor;height:inherit;left:0;opacity:inherit;position:absolute;top:0;transition:.15s;width:inherit}.copyButtonSuccessIcon_LjdS{color:#00d600;left:50%;opacity:0;top:50%;transform:translate(-50%,-50%) scale(.33)}.copyButtonCopied_obH4 .copyButtonIcon_y97N{opacity:0;transform:scale(.33)}.copyButtonCopied_obH4 .copyButtonSuccessIcon_LjdS{opacity:1;transform:translate(-50%,-50%) scale(1);transition-delay:75ms}.wordWrapButtonIcon_Bwma{height:1.2rem;width:1.2rem}.paramsItem_PKlE{margin:0 0 0 1rem!important;margin-top:unset!important;padding-left:1rem;position:relative}.paramsRequired_UKPH,.required_cVzG{color:var(--openapi-required)}.schemaItem_P8yX{list-style:none;margin:0!important;padding:5px 0 5px 1rem;position:relative}.required_Wlqr{color:var(--openapi-required)}.deprecated_K3O1{color:var(--openapi-deprecated)}.strikethrough_nBFj{text-decoration:line-through}.navbar{background:#fff}.navbar__link{font-weight:var(--ifm-font-weight-bold)}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-color)}.navbar kbd,.navbar__search-input{border:1px solid var(--ifm-navbar-search-input-color)}.navbar kbd{box-shadow:inset 0 -1px 0 var(--ifm-navbar-search-input-color)}.navbar__inner{margin:0 auto}.details_lb9f{--docusaurus-details-summary-arrow-size:0.38rem;--docusaurus-details-transition:transform 200ms ease;--docusaurus-details-decoration-color:grey}.details_lb9f>summary{cursor:pointer;list-style:none;padding-left:1rem;position:relative}.details_lb9f>summary::-webkit-details-marker{display:none}.details_lb9f>summary:before{border-color:#0000 #0000 #0000 var(--docusaurus-details-decoration-color);border-style:solid;border-width:var(--docusaurus-details-summary-arrow-size);content:"";left:0;position:absolute;top:.45rem;transform:rotate(0);transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transition:var(--docusaurus-details-transition)}.collapsibleContent_i85q{border-top:1px solid var(--docusaurus-details-decoration-color);margin-top:1rem;padding-top:1rem}.details_b_Ee{--docusaurus-details-decoration-color:var(--ifm-alert-border-color);--docusaurus-details-transition:transform var(--ifm-transition-fast) ease;border:1px solid var(--ifm-alert-border-color);margin:0 0 var(--ifm-spacing-vertical)}.containsTaskList_mC6p{list-style:none}.img_ev3q{height:auto}.admonition_LlT9{margin-bottom:1em}.admonitionHeading_tbUL{font:var(--ifm-heading-font-weight) var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.3rem}.admonitionIcon_kALy{display:inline-block;margin-right:.4em;vertical-align:middle}.admonitionIcon_kALy svg{fill:var(--ifm-alert-foreground-color);display:inline-block;height:1.6em;width:1.6em}.container_lyt7,.container_lyt7>svg{max-width:100%}.iconEdit_Z9Sw{margin-right:.3em;vertical-align:sub}.tag_zVej{border:1px solid var(--docusaurus-tag-list-border);transition:border var(--ifm-transition-fast)}.tag_zVej:hover{--docusaurus-tag-list-border:var(--ifm-link-color)}.tagRegular_sFm0{border-radius:var(--ifm-global-radius);font-size:90%;padding:.2rem .5rem .3rem}.tagWithCount_h2kH{align-items:center;border-left:0;display:flex;padding:0 .5rem 0 1rem;position:relative}.tagWithCount_h2kH:after,.tagWithCount_h2kH:before{border:1px solid var(--docusaurus-tag-list-border);content:"";position:absolute;top:50%;transition:inherit}.tagWithCount_h2kH:before{border-bottom:0;border-right:0;height:1.18rem;right:100%;transform:translate(50%,-50%) rotate(-45deg);width:1.18rem}.tagWithCount_h2kH:after{border-radius:50%;height:.5rem;left:0;transform:translateY(-50%);width:.5rem}.tagWithCount_h2kH span{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.7rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.tag_QGVx{display:inline-block;margin:0 .4rem .5rem 0}.lastUpdated_vwxv{font-size:smaller;font-style:italic;margin-top:.2rem}.tableOfContents_bqdL{max-height:calc(100vh - var(--ifm-navbar-height) - 2rem);overflow-y:auto;position:sticky;top:calc(var(--ifm-navbar-height) + 1rem)}.tocCollapsibleButton_TO0P{align-items:center;display:flex;font-size:inherit;justify-content:space-between;padding:.4rem .8rem;width:100%}.tocCollapsibleButton_TO0P:after{background:var(--ifm-menu-link-sublist-icon) 50% 50%/2rem 2rem no-repeat;content:"";height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast);width:1.25rem}.tocCollapsibleButtonExpanded_MG3E:after,.tocCollapsibleExpanded_sAul{transform:none}.tocCollapsible_ETCw{background-color:var(--ifm-menu-color-background-active);border-radius:var(--ifm-global-radius);margin:1rem 0}.tocCollapsibleContent_vkbj>ul{border-left:none;border-top:1px solid var(--ifm-color-emphasis-300);font-size:15px;padding:.2rem 0}.tocCollapsibleContent_vkbj ul li{margin:.4rem .8rem}.code__tabs_vqEd{display:table-row-group}.buttonGroup_SdX7{background:var(--openapi-card-background-color);border-radius:var(--openapi-card-border-radius) var(--openapi-card-border-radius) 2px 2px;color:var(--ifm-pre-color);display:flex;font-family:var(--ifm-font-family-monospace);justify-content:flex-end;margin-bottom:1px;margin-top:0}.buttonGroup_SdX7 button{--margin:0.25rem;-webkit-appearance:none;appearance:none;background:#0000;border:0 solid #0000;border-radius:calc(var(--margin));color:var(--ifm-menu-color);cursor:pointer;display:block;font-size:13.3333px;font-weight:var(--ifm-font-weight-semibold);line-height:var(--ifm-pre-line-height);margin:var(--margin);margin-right:0;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;transition:color var(--ifm-button-transition-duration) cubic-bezier(.08,.52,.52,1),background var(--ifm-button-transition-duration) cubic-bezier(.08,.52,.52,1),border-color var(--ifm-button-transition-duration) cubic-bezier(.08,.52,.52,1);-webkit-user-select:none;user-select:none;white-space:nowrap;width:100%}.buttonDelete_vlNf,.showMoreButton_ZGo2{cursor:pointer;-webkit-user-select:none}.buttonGroup_SdX7 button:last-child{margin-right:.25rem}.buttonGroup_SdX7 button.selected_VHjy{color:var(--ifm-menu-color-active)}.formItem_WgRa{margin-top:var(--ifm-pre-padding)}.inputBase_a3Vd,.inputBase_kdtO,.inputBase_p1em,html[data-theme=dark] .selectInput__VTP{border:none;margin-top:calc(var(--ifm-pre-padding)/2);background-color:var(--openapi-input-background);font-size:var(--ifm-code-font-size);width:100%;color:var(--ifm-pre-color);outline:0}.inputBase_kdtO{padding:12px 48px 12px var(--ifm-pre-padding)}.inputBase_kdtO,html[data-theme=dark] .selectInput__VTP{border-radius:4px}html[data-theme=dark] .selectInput__VTP{background-image:url('data:image/svg+xml;charset=US-ASCII,')}.selectInput__VTP,html[data-theme=dark] .selectInput__VTP{-webkit-appearance:none;appearance:none;background-position:right var(--ifm-pre-padding) top 50%;background-repeat:no-repeat;background-size:initial}.selectInput__VTP{background-image:url('data:image/svg+xml;charset=US-ASCII,')}.buttonDelete_vlNf:active,.input_CV2d:focus,.input_Ru3N:focus,.selectInput__VTP:focus{box-shadow:inset 0 0 0 2px var(--openapi-input-border)}.inputBase_a3Vd,.inputBase_p1em{border-radius:4px;padding:12px var(--ifm-pre-padding)}.floatingButton_oJlZ{position:relative}.floatingButton_oJlZ button{background:var(--ifm-color-emphasis-900);border:none;border-radius:var(--ifm-global-radius);color:var(--ifm-color-emphasis-100);cursor:pointer;opacity:0;padding:.4rem .5rem;position:absolute;right:calc(var(--ifm-pre-padding)/2);transition:opacity .2s ease-in-out,visibility .2s ease-in-out,bottom .2s ease-in-out;visibility:hidden}.floatingButton_oJlZ button:focus-visible,.floatingButton_oJlZ:focus-visible button,.floatingButton_oJlZ:hover button{opacity:1;visibility:visible}.dropzone_Y7D0{border:2px dashed var(--openapi-monaco-border-color)}.dropzoneHover_IkP6,.dropzone_Y7D0{align-items:center;background-color:var(--openapi-input-background);border-radius:4px;cursor:pointer;display:inline-flex;font-size:var(--ifm-code-font-size);justify-content:center;padding:var(--ifm-pre-padding);width:100%}.dropzoneHover_IkP6,.dropzone_Y7D0:hover{background:linear-gradient(var(--openapi-dropzone-hover-shim),var(--openapi-dropzone-hover-shim)),linear-gradient(var(--ifm-color-primary),var(--ifm-color-primary));border:2px dashed var(--ifm-color-primary)}.dropzoneContent_CEnm{align-items:center;color:var(--openapi-dropzone-color);display:flex;flex-wrap:wrap;justify-content:center;margin:var(--ifm-pre-padding) 0}.dropzone_Y7D0:hover .dropzoneContent_CEnm{color:var(--ifm-pre-color)}.dropzoneHover_IkP6 .dropzoneContent_CEnm{align-items:center;color:var(--ifm-pre-color);display:flex;flex-wrap:wrap;justify-content:center;margin:var(--ifm-pre-padding) 0}.discriminatorTabsTopSection_QeEp+hr,.schemaTabsTopSection_sc6Y+hr{display:none}.filename_FaIo{flex:1;margin:0 calc(var(--ifm-pre-padding)*1.5);overflow:hidden;text-overflow:ellipsis}.playgroundContainer_l4rC{border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-lw);margin-bottom:var(--ifm-leading);margin-top:1rem;max-height:500px;overflow:auto}.tabItem_VIbn,.tabItem_es3Q{align-items:center;border:1px solid var(--ifm-color-primary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-primary);display:flex;font-size:12px;height:1.8rem;justify-content:center;margin-right:.5rem;margin-top:0!important}.schemaTabsTopSection_sc6Y{align-items:center;display:flex;justify-content:space-between;margin-top:1rem}.schemaTabsListContainer_wmy4::-webkit-scrollbar{display:none}.schemaTabsContainer_HVyG{align-items:center;display:flex;max-width:600px;overflow:hidden}.tabArrow_WDKX,.tabArrow_zmvw{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;border:none;content:"";height:1.25rem;min-width:1.25rem;padding:0 .75rem;width:1.25rem}.inputBase_MRMh,.showMoreButton_ZGo2{font-size:var(--ifm-code-font-size);width:100%}.discriminatorTabsTopSection_QeEp{align-items:center;display:flex;justify-content:space-between;margin-left:.9rem;margin-top:1rem}.discriminatorTabsContainer_FMrl{align-items:center;display:flex;overflow:hidden;padding-left:3px;max-width:600px}.discriminatorTabsListContainer_Nnai::-webkit-scrollbar{display:none}.inputBase_MRMh{background-color:var(--openapi-input-background);border:2px solid #0000;border-radius:4px;color:var(--ifm-pre-color);margin-top:calc(var(--ifm-pre-padding)/2);outline:0;padding:12px var(--ifm-pre-padding)}.selectInput_xXUj{-webkit-appearance:none;appearance:none}.selectInput_xXUj option{border-radius:.25rem;color:var(--ifm-menu-color);margin:.25rem 0;padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.selectInput_xXUj:focus{border:2px solid var(--openapi-input-border)}.plus_Swon{display:inline-block;margin-right:6px;transform:rotate(0);transform-origin:center;transition:transform .2s}.plusExpanded_WYvI{transform:rotate(45deg)}.showMoreButton_ZGo2{-webkit-appearance:none;appearance:none;background-color:initial;border:0 solid #0000;color:var(--ifm-color-primary);display:block;margin-bottom:0;margin-top:var(--ifm-pre-padding);padding:0;text-align:left;user-select:none}.buttonDelete_vlNf,.buttonThin_xRd9{-webkit-appearance:none;font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:400;line-height:1.5;margin-top:calc(var(--ifm-pre-padding)/2);transition-duration:.1s,.1s,.1s,var(--ifm-button-transition-duration);transition-property:color,background,border-color,box-shadow;transition-timing-function:cubic-bezier(.08,.52,.52,1)}.showMoreButton_ZGo2:hover,.showMoreButton_jDKX:hover{color:var(--ifm-color-primary-hover)}.buttonDelete_vlNf{align-items:center;appearance:none;background-color:var(--openapi-input-background);border:none;border-radius:4px;color:var(--ifm-pre-color);display:flex;justify-content:center;margin-left:4px;outline:0;padding:0 12px;user-select:none;white-space:nowrap}.buttonThin_xRd9,.showMoreButton_jDKX{background-color:initial;-webkit-user-select:none;cursor:pointer;white-space:nowrap}.buttonThin_xRd9{appearance:none;border:1px solid var(--openapi-input-border);border-radius:var(--ifm-pre-border-radius);color:var(--openapi-input-border);display:block;margin-bottom:var(--ifm-pre-padding);padding:3px 60px 3px 12px;user-select:none}.buttonThin_xRd9:hover{background-color:var(--openapi-input-border);color:var(--openapi-inverse-color)}.buttonThin_xRd9:active{box-shadow:inset 0 0 0 1px var(--openapi-input-border),inset 0 0 0 2px var(--openapi-inverse-color)}.showOptions_Gv8N{margin-top:var(--ifm-pre-padding);visibility:visible}.hideOptions_JLDS{display:none;visibility:hidden}.showMoreButton_jDKX{-webkit-appearance:none;appearance:none;border:0 solid #0000;color:var(--ifm-color-primary);display:block;font-size:var(--ifm-code-font-size);margin-bottom:0;margin-top:var(--ifm-pre-padding);padding:0;text-align:left;user-select:none}.optionsPanel_s3ok,.optionsPanel_tfQ6{background:var(--openapi-card-background-color);border-radius:var(--openapi-card-border-radius);color:var(--ifm-pre-color);line-height:var(--ifm-pre-line-height);margin-bottom:var(--ifm-spacing-vertical);margin-top:0;overflow:auto;position:relative}.optionsPanel_s3ok:empty,.optionsPanel_tfQ6:empty{display:none}.optionsPanel_s3ok{padding-top:0!important;padding:var(--ifm-pre-padding)}.DocSearch-Button{align-items:center;background:var(--docsearch-searchbox-background);border:0;border-radius:40px;color:var(--docsearch-muted-color);cursor:pointer;display:flex;font-weight:500;height:36px;justify-content:space-between;padding:0 8px;-webkit-user-select:none;user-select:none}.DocSearch-Button:active,.DocSearch-Button:focus,.DocSearch-Button:hover{background:var(--docsearch-searchbox-focus-background);box-shadow:var(--docsearch-searchbox-shadow);color:var(--docsearch-text-color);outline:0}.DocSearch-Button-Container{align-items:center;display:flex}.DocSearch-Search-Icon{stroke-width:1.6}.DocSearch-Hit-Tree,.DocSearch-Hit-action,.DocSearch-Hit-icon,.DocSearch-Reset{stroke-width:var(--docsearch-icon-stroke-width)}.DocSearch-Button .DocSearch-Search-Icon{color:var(--docsearch-text-color)}.DocSearch-Button-Placeholder{font-size:1rem;padding:0 12px 0 6px}.DocSearch-Input,.DocSearch-Link{-webkit-appearance:none;font:inherit}.DocSearch-Button-Keys{display:flex;min-width:calc(40px + .8em)}.DocSearch-Button-Key{align-items:center;background:var(--docsearch-key-gradient);border:0;border-radius:3px;box-shadow:var(--docsearch-key-shadow);color:var(--docsearch-muted-color);display:flex;height:18px;justify-content:center;margin-right:.4em;padding:0 0 2px;position:relative;top:-1px;width:20px}.DocSearch--active{overflow:hidden!important}.DocSearch-Container{background-color:var(--docsearch-container-background);height:100vh;left:0;position:fixed;top:0;width:100vw;z-index:200}.DocSearch-Link{appearance:none;background:none;border:0;color:var(--docsearch-highlight-color);cursor:pointer;margin:0;padding:0}.DocSearch-Modal{background:var(--docsearch-modal-background);border-radius:6px;box-shadow:var(--docsearch-modal-shadow);flex-direction:column;margin:60px auto auto;max-width:var(--docsearch-modal-width);position:relative}.DocSearch-SearchBar{display:flex;padding:var(--docsearch-spacing) var(--docsearch-spacing) 0}.DocSearch-Form{align-items:center;background:var(--docsearch-searchbox-focus-background);border-radius:4px;box-shadow:var(--docsearch-searchbox-shadow);display:flex;height:var(--docsearch-searchbox-height);margin:0;padding:0 var(--docsearch-spacing);position:relative;width:100%}.DocSearch-Input{appearance:none;background:#0000;border:0;color:var(--docsearch-text-color);flex:1;font-size:1.2em;height:100%;outline:0;padding:0 0 0 8px;width:80%}.DocSearch-Hit-action-button,.DocSearch-Reset{-webkit-appearance:none;border:0;cursor:pointer}.DocSearch-Input::placeholder{color:var(--docsearch-muted-color);opacity:1}.DocSearch-Input::-webkit-search-cancel-button,.DocSearch-Input::-webkit-search-decoration,.DocSearch-Input::-webkit-search-results-button,.DocSearch-Input::-webkit-search-results-decoration{display:none}.DocSearch-LoadingIndicator,.DocSearch-MagnifierLabel,.DocSearch-Reset{margin:0;padding:0}.DocSearch-Container--Stalled .DocSearch-LoadingIndicator,.DocSearch-MagnifierLabel,.DocSearch-Reset{align-items:center;color:var(--docsearch-highlight-color);display:flex;justify-content:center}.DocSearch-Cancel,.DocSearch-Container--Stalled .DocSearch-MagnifierLabel,.DocSearch-LoadingIndicator,.DocSearch-Reset[hidden]{display:none}.DocSearch-Reset{animation:.1s ease-in forwards b;appearance:none;background:none;border-radius:50%;color:var(--docsearch-icon-color);padding:2px;right:0}.DocSearch-Help,.DocSearch-HitsFooter,.DocSearch-Label{color:var(--docsearch-muted-color)}.DocSearch-Reset:focus{outline:0}.DocSearch-Reset:hover{color:var(--docsearch-highlight-color)}.DocSearch-LoadingIndicator svg,.DocSearch-MagnifierLabel svg{height:24px;width:24px}.DocSearch-Dropdown{max-height:calc(var(--docsearch-modal-height) - var(--docsearch-searchbox-height) - var(--docsearch-spacing) - var(--docsearch-footer-height));min-height:var(--docsearch-spacing);overflow-y:auto;overflow-y:overlay;padding:0 var(--docsearch-spacing);scrollbar-color:var(--docsearch-muted-color) var(--docsearch-modal-background);scrollbar-width:thin}.DocSearch-Dropdown::-webkit-scrollbar{width:12px}.DocSearch-Dropdown::-webkit-scrollbar-track{background:#0000}.DocSearch-Dropdown::-webkit-scrollbar-thumb{background-color:var(--docsearch-muted-color);border:3px solid var(--docsearch-modal-background);border-radius:20px}.DocSearch-Dropdown ul{list-style:none;margin:0;padding:0}.DocSearch-Label{font-size:.75em;line-height:1.6em}.DocSearch-Help{font-size:.9em;margin:0;-webkit-user-select:none;user-select:none}.DocSearch-Title{font-size:1.2em}.DocSearch-Logo a{display:flex}.DocSearch-Logo svg{color:var(--docsearch-logo-color);margin-left:8px}.DocSearch-Hits:last-of-type{margin-bottom:24px}.DocSearch-Hits mark{background:none;color:var(--docsearch-highlight-color)}.DocSearch-HitsFooter{display:flex;font-size:.85em;justify-content:center;margin-bottom:var(--docsearch-spacing);padding:var(--docsearch-spacing)}.DocSearch-HitsFooter a{border-bottom:1px solid;color:inherit}.DocSearch-Hit{border-radius:4px;display:flex;padding-bottom:4px;position:relative}.DocSearch-Hit--deleting{opacity:0;transition:.25s linear}.DocSearch-Hit--favoriting{transform:scale(0);transform-origin:top center;transition:.25s linear .25s}.DocSearch-Hit a{background:var(--docsearch-hit-background);border-radius:4px;box-shadow:var(--docsearch-hit-shadow);display:block;padding-left:var(--docsearch-spacing);width:100%}.DocSearch-Hit-source{background:var(--docsearch-modal-background);color:var(--docsearch-highlight-color);font-size:.85em;font-weight:600;line-height:32px;margin:0 -4px;padding:8px 4px 0;position:sticky;top:0;z-index:10}.DocSearch-Hit-Tree{color:var(--docsearch-muted-color);height:var(--docsearch-hit-height);opacity:.5;width:24px}.DocSearch-Hit[aria-selected=true] a{background-color:var(--docsearch-highlight-color)}.DocSearch-Hit[aria-selected=true] mark{text-decoration:underline}.DocSearch-Hit-Container{align-items:center;color:var(--docsearch-hit-color);display:flex;flex-direction:row;height:var(--docsearch-hit-height);padding:0 var(--docsearch-spacing) 0 0}.DocSearch-Hit-icon{height:20px;width:20px}.DocSearch-Hit-action,.DocSearch-Hit-icon{color:var(--docsearch-muted-color)}.DocSearch-Hit-action{align-items:center;display:flex;height:22px;width:22px}.DocSearch-Hit-action svg{display:block;height:18px;width:18px}.DocSearch-Hit-action+.DocSearch-Hit-action{margin-left:6px}.DocSearch-Hit-action-button{appearance:none;background:none;border-radius:50%;color:inherit;padding:2px}svg.DocSearch-Hit-Select-Icon{display:none}.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-Select-Icon{display:block}.DocSearch-Hit-action-button:focus,.DocSearch-Hit-action-button:hover{background:#0003;transition:background-color .1s ease-in}.DocSearch-Hit-action-button:focus path,.DocSearch-Hit-action-button:hover path{fill:#fff}.DocSearch-Hit-content-wrapper{display:flex;flex:1 1 auto;flex-direction:column;font-weight:500;justify-content:center;line-height:1.2em;margin:0 8px;overflow-x:hidden;position:relative;text-overflow:ellipsis;white-space:nowrap;width:80%}.DocSearch-Hit-title{font-size:.9em}.DocSearch-Hit-path{color:var(--docsearch-muted-color);font-size:.75em}.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-Tree,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-action,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-icon,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-path,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-text,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-title,.DocSearch-Hit[aria-selected=true] mark{color:var(--docsearch-hit-active-color)!important}.DocSearch-ErrorScreen,.DocSearch-NoResults,.DocSearch-StartScreen{font-size:.9em;margin:0 auto;padding:36px 0;text-align:center;width:80%}.DocSearch-Screen-Icon{color:var(--docsearch-muted-color);padding-bottom:12px}.DocSearch-NoResults-Prefill-List{display:inline-block;padding-bottom:24px;text-align:left}.DocSearch-NoResults-Prefill-List ul{display:inline-block;padding:8px 0 0}.DocSearch-NoResults-Prefill-List li{list-style-position:inside;list-style-type:"» "}.DocSearch-Prefill{-webkit-appearance:none;appearance:none;background:none;border:0;border-radius:1em;color:var(--docsearch-highlight-color);cursor:pointer;display:inline-block;font-size:1em;font-weight:700;padding:0}.DocSearch-Prefill:focus,.DocSearch-Prefill:hover{outline:0;text-decoration:underline}.DocSearch-Footer{align-items:center;background:var(--docsearch-footer-background);border-radius:0 0 8px 8px;box-shadow:var(--docsearch-footer-shadow);display:flex;flex-direction:row-reverse;flex-shrink:0;height:var(--docsearch-footer-height);justify-content:space-between;padding:0 var(--docsearch-spacing);position:relative;-webkit-user-select:none;user-select:none;width:100%;z-index:300}.DocSearch-Commands{color:var(--docsearch-muted-color);display:flex;list-style:none;margin:0;padding:0}.DocSearch-Commands li{align-items:center;display:flex}.DocSearch-Commands li:not(:last-of-type){margin-right:.8em}.DocSearch-Commands-Key{align-items:center;background:var(--docsearch-key-gradient);border:0;border-radius:2px;box-shadow:var(--docsearch-key-shadow);color:var(--docsearch-muted-color);display:flex;height:18px;justify-content:center;margin-right:.4em;padding:0 0 1px;width:20px}@keyframes b{0%{opacity:0}to{opacity:1}}.DocSearch-Button{margin:0;transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.DocSearch-Container{z-index:calc(var(--ifm-z-index-fixed) + 1)}@media (min-width:640px){.sm\:flex-row{flex-direction:row}}@media (min-width:768px){.md\:mx-4{margin-left:1rem;margin-right:1rem}.md\:mt-16{margin-top:4rem}.md\:mb-0{margin-bottom:0}.md\:mt-10{margin-top:2.5rem}.md\:grid-cols-3{grid-template-columns:repeat(3,minmax(0,1fr))}.md\:place-content-center{place-content:center}.md\:place-items-center{place-items:center}.md\:justify-between{justify-content:space-between}.md\:gap-1{gap:.25rem}.md\:px-4{padding-left:1rem;padding-right:1rem}.md\:px-10{padding-left:2.5rem;padding-right:2.5rem}.md\:pr-24{padding-right:6rem}.navbar__inner{padding:0 2.5rem}}@media only screen and (min-width:768px) and (max-width:996px){.code__tabs_vqEd{justify-content:space-around}}@media (min-width:997px){.collapseSidebarButton_PEFL,.expandButton_m80_{background-color:var(--docusaurus-collapse-button-bg);position:sticky}.docItemCol,.docItemCol_zY_c{max-width:75%!important}.tocMobile,.tocMobile_ITEo{display:none}:root{--docusaurus-announcement-bar-height:30px}.announcementBarClose_gvF7,.announcementBarPlaceholder_vyr4{flex-basis:50px}.searchBox_ZlJk{padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.collapseSidebarButton_PEFL{border:1px solid var(--ifm-toc-border-color);border-radius:0;bottom:0;display:block!important;height:40px}.collapseSidebarButtonIcon_kv0_{margin-top:4px;transform:rotate(180deg)}.expandButtonIcon_BlDH,[dir=rtl] .collapseSidebarButtonIcon_kv0_{transform:rotate(0)}.collapseSidebarButton_PEFL:focus,.collapseSidebarButton_PEFL:hover,.expandButton_m80_:focus,.expandButton_m80_:hover{background-color:var(--docusaurus-collapse-button-bg-hover)}.menuHtmlItem_M9Kj{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu_SIkG{flex-grow:1;padding:.5rem}@supports (scrollbar-gutter:stable){.menu_SIkG{padding:.5rem 0 .5rem .5rem;scrollbar-gutter:stable}}.menuWithAnnouncementBar_GW3s{margin-bottom:var(--docusaurus-announcement-bar-height)}.sidebar_njMd{display:flex;flex-direction:column;height:100%;max-height:100vh;padding-top:var(--ifm-navbar-height);position:sticky;top:0;transition:opacity 50ms;width:var(--doc-sidebar-width)}.sidebarWithHideableNavbar_wUlq{padding-top:0}.sidebarHidden_VK0M{height:0;opacity:0;overflow:hidden;visibility:hidden}.sidebarLogo_isFc{align-items:center;color:inherit!important;display:flex!important;margin:0 var(--ifm-navbar-padding-horizontal);max-height:var(--ifm-navbar-height);min-height:var(--ifm-navbar-height);text-decoration:none!important}.sidebarLogo_isFc img{height:2rem;margin-right:.5rem}.expandButton_m80_{align-items:center;display:flex;height:100%;justify-content:center;max-height:100vh;top:0;transition:background-color var(--ifm-transition-fast) ease}[dir=rtl] .expandButtonIcon_BlDH{transform:rotate(180deg)}.docSidebarContainer_b6E3{border-right:1px solid var(--ifm-toc-border-color);-webkit-clip-path:inset(0);clip-path:inset(0);display:block;margin-top:calc(var(--ifm-navbar-height)*-1);transition:width var(--ifm-transition-fast) ease;width:var(--doc-sidebar-width);will-change:width}.docSidebarContainerHidden_b3ry{cursor:pointer;width:var(--doc-sidebar-hidden-width)}.docMainContainer_gTbr{flex-grow:1;max-width:calc(100% - var(--doc-sidebar-width))}.docMainContainerEnhanced_Uz_u{max-width:calc(100% - var(--doc-sidebar-hidden-width))}.docItemWrapperEnhanced_czyv{max-width:calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important}.lastUpdated_vwxv{text-align:right}}@media (min-width:1024px){.lg\:mb-8{margin-bottom:2rem}.lg\:h-\[90vh\]{height:90vh}.lg\:h-48{height:12rem}.lg\:w-full{width:100%}.lg\:w-\[500px\]{width:500px}.lg\:flex-1{flex:1 1 0%}.lg\:flex-row{flex-direction:row}.lg\:place-content-center{place-content:center}.lg\:gap-12{gap:3rem}.lg\:whitespace-nowrap{white-space:nowrap}.lg\:pb-24{padding-bottom:6rem}.lg\:pb-12{padding-bottom:3rem}}@media not all and (min-width:1024px){.max-lg\:hidden{display:none}}@media (min-width:1440px){.container{max-width:var(--ifm-container-width-xl)}}@media (max-width:1416px){.main-wrapper{max-width:100%;width:100%}}@media (max-width:1320px) and (min-width:997px){.container{max-width:calc(var(--ifm-container-width) - 125px - var(--ifm-spacing-horizontal)*2)}}@media (max-width:996px){.col{--ifm-col-width:100%;flex-basis:var(--ifm-col-width);margin-left:0}.footer{--ifm-footer-padding-horizontal:0}.colorModeToggle_x44X,.footer__link-separator,.navbar__item,.tableOfContents_bqdL{display:none}.footer__col{margin-bottom:calc(var(--ifm-spacing-vertical)*3)}.footer__link-item{display:block}.hero{padding-left:0;padding-right:0}.navbar>.container,.navbar>.container-fluid{padding:0}.navbar__toggle{display:inherit}.navbar__search-input{width:9rem}.pills--block,.tabs--block{flex-direction:column}.searchBox_ZlJk{position:absolute;right:var(--ifm-navbar-padding-horizontal)}.docItemContainer_F8PC{padding:0 .3rem}}@media only screen and (max-width:996px){.searchQueryColumn_RTkw,.searchResultsColumn_JPFH{max-width:60%!important}.searchLogoColumn_rJIA,.searchVersionColumn_ypXd{max-width:40%!important}.searchLogoColumn_rJIA{padding-left:0!important}}@media (max-width:768px){.DocSearch-Button-Keys,.DocSearch-Button-Placeholder,.DocSearch-Commands,.DocSearch-Hit-Tree{display:none}:root{--docsearch-spacing:10px;--docsearch-footer-height:40px}.DocSearch-Dropdown{height:100%;max-height:calc(var(--docsearch-vh,1vh)*100 - var(--docsearch-searchbox-height) - var(--docsearch-spacing) - var(--docsearch-footer-height))}.DocSearch-Container{height:100vh;height:-webkit-fill-available;height:calc(var(--docsearch-vh,1vh)*100);position:absolute}.DocSearch-Footer{border-radius:0;bottom:0;position:absolute}.DocSearch-Hit-content-wrapper{display:flex;position:relative;width:80%}.DocSearch-Modal{border-radius:0;box-shadow:none;height:100vh;height:-webkit-fill-available;height:calc(var(--docsearch-vh,1vh)*100);margin:0;max-width:100%;width:100%}.DocSearch-Cancel{-webkit-appearance:none;appearance:none;background:none;border:0;color:var(--docsearch-highlight-color);cursor:pointer;display:inline-block;flex:none;font:inherit;font-size:1em;font-weight:500;margin-left:var(--docsearch-spacing);outline:0;overflow:hidden;padding:0;-webkit-user-select:none;user-select:none;white-space:nowrap}}@media (max-width:576px){.markdown h1:first-child{--ifm-h1-font-size:2rem}.markdown>h2{--ifm-h2-font-size:1.5rem}.markdown>h3{--ifm-h3-font-size:1.25rem}}@media screen and (max-width:576px){.searchQueryColumn_RTkw{max-width:100%!important}.searchVersionColumn_ypXd{max-width:100%!important;padding-left:var(--ifm-spacing-horizontal)!important}}@media screen and (max-width:500px){.discriminatorTabsTopSection_QeEp,.mimeTabsTopSection_wt53,.responseTabsTopSection_jEoq,.schemaTabsTopSection_sc6Y{align-items:flex-start;flex-direction:column}.mimeTabsContainer_gZbZ,.responseTabsContainer_XEhZ{margin-top:var(--ifm-spacing-vertical);padding:0;width:100%}.discriminatorTabsContainer_FMrl,.schemaTabsContainer_HVyG{width:100%}.tabItem_VIbn{height:100%}}@media (hover:hover){.backToTopButton_sjWU:hover{background-color:var(--ifm-color-emphasis-300)}}@media (pointer:fine){.thin-scrollbar{scrollbar-width:thin}.thin-scrollbar::-webkit-scrollbar{height:var(--ifm-scrollbar-size);width:var(--ifm-scrollbar-size)}.thin-scrollbar::-webkit-scrollbar-track{background:var(--ifm-scrollbar-track-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb{background:var(--ifm-scrollbar-thumb-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb:hover{background:var(--ifm-scrollbar-thumb-hover-background-color)}}@media screen and (prefers-reduced-motion:reduce){.DocSearch-Reset{stroke-width:var(--docsearch-icon-stroke-width);animation:none;-webkit-appearance:none;appearance:none;background:none;border:0;border-radius:50%;color:var(--docsearch-icon-color);cursor:pointer;right:0}.DocSearch-Hit--deleting,.DocSearch-Hit--favoriting{transition:none}.DocSearch-Hit-action-button:focus,.DocSearch-Hit-action-button:hover{background:#0003;transition:none}}@media print{.announcementBar_mb4j,.footer,.menu,.navbar,.pagination-nav,.table-of-contents,.tocMobile_ITEo{display:none}.tabs{page-break-inside:avoid}.codeBlockLines_e6Vv{white-space:pre-wrap}} \ No newline at end of file diff --git a/assets/css/styles.80f651ad.css b/assets/css/styles.80f651ad.css deleted file mode 100644 index 94f9344a3..000000000 --- a/assets/css/styles.80f651ad.css +++ /dev/null @@ -1 +0,0 @@ -@import url(https://fonts.googleapis.com/css2?family=Manrope:wght@500;700&display=swap);.col,.container{padding:0 var(--ifm-spacing-horizontal);width:100%}.markdown>h2,.markdown>h3,.markdown>h4,.markdown>h5,.markdown>h6{margin-bottom:calc(var(--ifm-heading-vertical-rhythm-bottom)*var(--ifm-leading))}.breadcrumbs__link,.button{transition-timing-function:var(--ifm-transition-timing-default)}.button,code{vertical-align:middle}.button--outline.button--active,.button--outline:active,.button--outline:hover,:root{--ifm-button-color:var(--ifm-font-color-base-inverse)}.menu__link:hover,a{transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.navbar--dark,:root{--ifm-navbar-link-hover-color:var(--ifm-color-primary)}.menu,.navbar-sidebar{overflow-x:hidden}:root,html[data-theme=dark]{--ifm-color-emphasis-500:var(--ifm-color-gray-500)}progress,sub,sup{vertical-align:initial}.markdown li,body{word-wrap:break-word}.toggleButton_gllP,html{-webkit-tap-highlight-color:transparent}.button,.discriminatorTabLabel_dvfv,.dropdown__link,.filename_FaIo,.schemaTabLabel_clV0,.showMoreButton_ZGo2,.tabItem_AM8E,.text--truncate{white-space:nowrap}*,.DocSearch-Container,.DocSearch-Container *,:after,:before{box-sizing:border-box}:root{--ifm-color-scheme:light;--ifm-dark-value:10%;--ifm-darker-value:15%;--ifm-darkest-value:30%;--ifm-light-value:15%;--ifm-lighter-value:30%;--ifm-lightest-value:50%;--ifm-contrast-background-value:90%;--ifm-contrast-foreground-value:70%;--ifm-contrast-background-dark-value:70%;--ifm-contrast-foreground-dark-value:90%;--ifm-color-primary:#3578e5;--ifm-color-secondary:#ebedf0;--ifm-color-success:#00a400;--ifm-color-info:#54c7ec;--ifm-color-warning:#ffba00;--ifm-color-danger:#fa383e;--ifm-color-primary-dark:#306cce;--ifm-color-primary-darker:#2d66c3;--ifm-color-primary-darkest:#2554a0;--ifm-color-primary-light:#538ce9;--ifm-color-primary-lighter:#72a1ed;--ifm-color-primary-lightest:#9abcf2;--ifm-color-primary-contrast-background:#ebf2fc;--ifm-color-primary-contrast-foreground:#102445;--ifm-color-secondary-dark:#d4d5d8;--ifm-color-secondary-darker:#c8c9cc;--ifm-color-secondary-darkest:#a4a6a8;--ifm-color-secondary-light:#eef0f2;--ifm-color-secondary-lighter:#f1f2f5;--ifm-color-secondary-lightest:#f5f6f8;--ifm-color-secondary-contrast-background:#fdfdfe;--ifm-color-secondary-contrast-foreground:#474748;--ifm-color-success-dark:#009400;--ifm-color-success-darker:#008b00;--ifm-color-success-darkest:#007300;--ifm-color-success-light:#26b226;--ifm-color-success-lighter:#4dbf4d;--ifm-color-success-lightest:#80d280;--ifm-color-success-contrast-background:#e6f6e6;--ifm-color-success-contrast-foreground:#003100;--ifm-color-info-dark:#4cb3d4;--ifm-color-info-darker:#47a9c9;--ifm-color-info-darkest:#3b8ba5;--ifm-color-info-light:#6ecfef;--ifm-color-info-lighter:#87d8f2;--ifm-color-info-lightest:#aae3f6;--ifm-color-info-contrast-background:#eef9fd;--ifm-color-info-contrast-foreground:#193c47;--ifm-color-warning-dark:#e6a700;--ifm-color-warning-darker:#d99e00;--ifm-color-warning-darkest:#b38200;--ifm-color-warning-light:#ffc426;--ifm-color-warning-lighter:#ffcf4d;--ifm-color-warning-lightest:#ffdd80;--ifm-color-warning-contrast-background:#fff8e6;--ifm-color-warning-contrast-foreground:#4d3800;--ifm-color-danger-dark:#e13238;--ifm-color-danger-darker:#d53035;--ifm-color-danger-darkest:#af272b;--ifm-color-danger-light:#fb565b;--ifm-color-danger-lighter:#fb7478;--ifm-color-danger-lightest:#fd9c9f;--ifm-color-danger-contrast-background:#ffebec;--ifm-color-danger-contrast-foreground:#4b1113;--ifm-color-white:#fff;--ifm-color-black:#000;--ifm-color-gray-0:var(--ifm-color-white);--ifm-color-gray-100:#f5f6f7;--ifm-color-gray-200:#ebedf0;--ifm-color-gray-300:#dadde1;--ifm-color-gray-400:#ccd0d5;--ifm-color-gray-500:#bec3c9;--ifm-color-gray-600:#8d949e;--ifm-color-gray-700:#606770;--ifm-color-gray-800:#444950;--ifm-color-gray-900:#1c1e21;--ifm-color-gray-1000:var(--ifm-color-black);--ifm-color-emphasis-0:var(--ifm-color-gray-0);--ifm-color-emphasis-100:var(--ifm-color-gray-100);--ifm-color-emphasis-200:var(--ifm-color-gray-200);--ifm-color-emphasis-300:var(--ifm-color-gray-300);--ifm-color-emphasis-400:var(--ifm-color-gray-400);--ifm-color-emphasis-600:var(--ifm-color-gray-600);--ifm-color-emphasis-700:var(--ifm-color-gray-700);--ifm-color-emphasis-800:var(--ifm-color-gray-800);--ifm-color-emphasis-900:var(--ifm-color-gray-900);--ifm-color-emphasis-1000:var(--ifm-color-gray-1000);--ifm-color-content:var(--ifm-color-emphasis-900);--ifm-color-content-inverse:var(--ifm-color-emphasis-0);--ifm-color-content-secondary:#525860;--ifm-background-color:#0000;--ifm-background-surface-color:var(--ifm-color-content-inverse);--ifm-global-border-width:1px;--ifm-global-radius:0.4rem;--ifm-hover-overlay:#0000000d;--ifm-font-color-base:var(--ifm-color-content);--ifm-font-color-base-inverse:var(--ifm-color-content-inverse);--ifm-font-color-secondary:var(--ifm-color-content-secondary);--ifm-font-family-base:system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--ifm-font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--ifm-font-size-base:100%;--ifm-font-weight-light:300;--ifm-font-weight-normal:400;--ifm-font-weight-semibold:500;--ifm-font-weight-bold:700;--ifm-font-weight-base:var(--ifm-font-weight-normal);--ifm-line-height-base:1.65;--ifm-global-spacing:1rem;--ifm-spacing-vertical:var(--ifm-global-spacing);--ifm-spacing-horizontal:var(--ifm-global-spacing);--ifm-transition-fast:200ms;--ifm-transition-slow:400ms;--ifm-transition-timing-default:cubic-bezier(0.08,0.52,0.52,1);--ifm-global-shadow-lw:0 1px 2px 0 #0000001a;--ifm-global-shadow-md:0 5px 40px #0003;--ifm-global-shadow-tl:0 12px 28px 0 #0003,0 2px 4px 0 #0000001a;--ifm-z-index-dropdown:100;--ifm-z-index-fixed:200;--ifm-z-index-overlay:400;--ifm-container-width:1140px;--ifm-container-width-xl:1320px;--ifm-code-background:#f6f7f8;--ifm-code-border-radius:var(--ifm-global-radius);--ifm-code-padding-horizontal:0.1rem;--ifm-code-padding-vertical:0.1rem;--ifm-pre-background:var(--ifm-code-background);--ifm-pre-border-radius:var(--ifm-code-border-radius);--ifm-pre-color:inherit;--ifm-pre-line-height:1.45;--ifm-pre-padding:1rem;--ifm-heading-color:inherit;--ifm-heading-margin-top:0;--ifm-heading-margin-bottom:var(--ifm-spacing-vertical);--ifm-heading-font-family:var(--ifm-font-family-base);--ifm-heading-font-weight:var(--ifm-font-weight-bold);--ifm-heading-line-height:1.25;--ifm-h1-font-size:2rem;--ifm-h2-font-size:1.5rem;--ifm-h3-font-size:1.25rem;--ifm-h4-font-size:1rem;--ifm-h5-font-size:0.875rem;--ifm-h6-font-size:0.85rem;--ifm-image-alignment-padding:1.25rem;--ifm-leading-desktop:1.25;--ifm-leading:calc(var(--ifm-leading-desktop)*1rem);--ifm-list-left-padding:2rem;--ifm-list-margin:1rem;--ifm-list-item-margin:0.25rem;--ifm-list-paragraph-margin:1rem;--ifm-table-cell-padding:0.75rem;--ifm-table-background:#0000;--ifm-table-stripe-background:#00000008;--ifm-table-border-width:1px;--ifm-table-border-color:var(--ifm-color-emphasis-300);--ifm-table-head-background:inherit;--ifm-table-head-color:inherit;--ifm-table-head-font-weight:var(--ifm-font-weight-bold);--ifm-table-cell-color:inherit;--ifm-link-color:var(--ifm-color-primary);--ifm-link-decoration:none;--ifm-link-hover-color:var(--ifm-link-color);--ifm-link-hover-decoration:underline;--ifm-paragraph-margin-bottom:var(--ifm-leading);--ifm-blockquote-font-size:var(--ifm-font-size-base);--ifm-blockquote-border-left-width:2px;--ifm-blockquote-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-blockquote-padding-vertical:0;--ifm-blockquote-shadow:none;--ifm-blockquote-color:var(--ifm-color-emphasis-800);--ifm-blockquote-border-color:var(--ifm-color-emphasis-300);--ifm-hr-background-color:var(--ifm-color-emphasis-500);--ifm-hr-height:1px;--ifm-hr-margin-vertical:1.5rem;--ifm-scrollbar-size:7px;--ifm-scrollbar-track-background-color:#f1f1f1;--ifm-scrollbar-thumb-background-color:silver;--ifm-scrollbar-thumb-hover-background-color:#a7a7a7;--ifm-alert-background-color:inherit;--ifm-alert-border-color:inherit;--ifm-alert-border-radius:var(--ifm-global-radius);--ifm-alert-border-width:0px;--ifm-alert-border-left-width:5px;--ifm-alert-color:var(--ifm-font-color-base);--ifm-alert-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-alert-padding-vertical:var(--ifm-spacing-vertical);--ifm-alert-shadow:var(--ifm-global-shadow-lw);--ifm-avatar-intro-margin:1rem;--ifm-avatar-intro-alignment:inherit;--ifm-avatar-photo-size:3rem;--ifm-badge-background-color:inherit;--ifm-badge-border-color:inherit;--ifm-badge-border-radius:var(--ifm-global-radius);--ifm-badge-border-width:var(--ifm-global-border-width);--ifm-badge-color:var(--ifm-color-white);--ifm-badge-padding-horizontal:calc(var(--ifm-spacing-horizontal)*0.5);--ifm-badge-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-breadcrumb-border-radius:1.5rem;--ifm-breadcrumb-spacing:0.5rem;--ifm-breadcrumb-color-active:var(--ifm-color-primary);--ifm-breadcrumb-item-background-active:var(--ifm-hover-overlay);--ifm-breadcrumb-padding-horizontal:0.8rem;--ifm-breadcrumb-padding-vertical:0.4rem;--ifm-breadcrumb-size-multiplier:1;--ifm-breadcrumb-separator:url('data:image/svg+xml;utf8,');--ifm-breadcrumb-separator-filter:none;--ifm-breadcrumb-separator-size:0.5rem;--ifm-breadcrumb-separator-size-multiplier:1.25;--ifm-button-background-color:inherit;--ifm-button-border-color:var(--ifm-button-background-color);--ifm-button-border-width:var(--ifm-global-border-width);--ifm-button-font-weight:var(--ifm-font-weight-bold);--ifm-button-padding-horizontal:1.5rem;--ifm-button-padding-vertical:0.375rem;--ifm-button-size-multiplier:1;--ifm-button-transition-duration:var(--ifm-transition-fast);--ifm-button-border-radius:calc(var(--ifm-global-radius)*var(--ifm-button-size-multiplier));--ifm-button-group-spacing:2px;--ifm-card-background-color:var(--ifm-background-surface-color);--ifm-card-border-radius:calc(var(--ifm-global-radius)*2);--ifm-card-horizontal-spacing:var(--ifm-global-spacing);--ifm-card-vertical-spacing:var(--ifm-global-spacing);--ifm-toc-border-color:var(--ifm-color-emphasis-300);--ifm-toc-link-color:var(--ifm-color-content-secondary);--ifm-toc-padding-vertical:0.5rem;--ifm-toc-padding-horizontal:0.5rem;--ifm-dropdown-background-color:var(--ifm-background-surface-color);--ifm-dropdown-font-weight:var(--ifm-font-weight-semibold);--ifm-dropdown-link-color:var(--ifm-font-color-base);--ifm-dropdown-hover-background-color:var(--ifm-hover-overlay);--ifm-footer-background-color:var(--ifm-color-emphasis-100);--ifm-footer-color:inherit;--ifm-footer-link-color:var(--ifm-color-emphasis-700);--ifm-footer-link-hover-color:var(--ifm-color-primary);--ifm-footer-link-horizontal-spacing:0.5rem;--ifm-footer-padding-horizontal:calc(var(--ifm-spacing-horizontal)*2);--ifm-footer-padding-vertical:calc(var(--ifm-spacing-vertical)*2);--ifm-footer-title-color:inherit;--ifm-footer-logo-max-width:min(30rem,90vw);--ifm-hero-background-color:var(--ifm-background-surface-color);--ifm-hero-text-color:var(--ifm-color-emphasis-800);--ifm-menu-color:var(--ifm-color-emphasis-700);--ifm-menu-color-active:var(--ifm-color-primary);--ifm-menu-color-background-active:var(--ifm-hover-overlay);--ifm-menu-color-background-hover:var(--ifm-hover-overlay);--ifm-menu-link-padding-horizontal:0.75rem;--ifm-menu-link-padding-vertical:0.375rem;--ifm-menu-link-sublist-icon:url('data:image/svg+xml;utf8,');--ifm-menu-link-sublist-icon-filter:none;--ifm-navbar-background-color:var(--ifm-background-surface-color);--ifm-navbar-height:3.75rem;--ifm-navbar-item-padding-horizontal:0.75rem;--ifm-navbar-item-padding-vertical:0.25rem;--ifm-navbar-link-color:var(--ifm-font-color-base);--ifm-navbar-link-active-color:var(--ifm-link-color);--ifm-navbar-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-navbar-padding-vertical:calc(var(--ifm-spacing-vertical)*0.5);--ifm-navbar-shadow:var(--ifm-global-shadow-lw);--ifm-navbar-search-input-background-color:var(--ifm-color-emphasis-200);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-800);--ifm-navbar-search-input-placeholder-color:var(--ifm-color-emphasis-500);--ifm-navbar-search-input-icon:url('data:image/svg+xml;utf8,');--ifm-navbar-sidebar-width:83vw;--ifm-pagination-border-radius:var(--ifm-global-radius);--ifm-pagination-color-active:var(--ifm-color-primary);--ifm-pagination-font-size:1rem;--ifm-pagination-item-active-background:var(--ifm-hover-overlay);--ifm-pagination-page-spacing:0.2em;--ifm-pagination-padding-horizontal:calc(var(--ifm-spacing-horizontal)*1);--ifm-pagination-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-pagination-nav-border-radius:var(--ifm-global-radius);--ifm-pagination-nav-color-hover:var(--ifm-color-primary);--ifm-pills-color-active:var(--ifm-color-primary);--ifm-pills-color-background-active:var(--ifm-hover-overlay);--ifm-pills-spacing:0.125rem;--ifm-tabs-color:var(--ifm-font-color-secondary);--ifm-tabs-color-active:var(--ifm-color-primary);--ifm-tabs-color-active-border:var(--ifm-tabs-color-active);--ifm-tabs-padding-horizontal:1rem;--ifm-tabs-padding-vertical:1rem;--docusaurus-progress-bar-color:var(--ifm-color-primary)}:root,[data-theme=dark]{--ifm-color-primary:#27af86}.badge--danger,.badge--info,.badge--primary,.badge--secondary,.badge--success,.badge--warning{--ifm-badge-border-color:var(--ifm-badge-background-color)}.button--link,.button--outline{--ifm-button-background-color:#0000}html{-webkit-font-smoothing:antialiased;text-size-adjust:100%;background-color:var(--ifm-background-color);color:var(--ifm-font-color-base);color-scheme:var(--ifm-color-scheme);font:var(--ifm-font-size-base)/var(--ifm-line-height-base) var(--ifm-font-family-base);text-rendering:optimizelegibility}iframe{border:0;color-scheme:auto}.container{margin:0 auto;max-width:var(--ifm-container-width)}.container--fluid{max-width:inherit}.row{display:flex;flex-wrap:wrap;margin:0 calc(var(--ifm-spacing-horizontal)*-1)}.margin-bottom--none,.margin-vert--none,.markdown>:last-child{margin-bottom:0!important}.margin-top--none,.margin-vert--none,.tabItem_LNqP,.tabItem_kzG2{margin-top:0!important}.row--no-gutters{margin-left:0;margin-right:0}.margin-horiz--none,.margin-right--none,.tabItem_AM8E:last-child,.tabItem_VIbn:last-child,.tabItem_es3Q:last-child,.tabItem_fIhq:last-child{margin-right:0!important}.row--no-gutters>.col{padding-left:0;padding-right:0}.items-start,.row--align-top{align-items:flex-start}.row--align-bottom{align-items:flex-end}.items-center,.menuExternalLink_NmtK,.row--align-center{align-items:center}.row--align-stretch{align-items:stretch}.row--align-baseline{align-items:baseline}.col{--ifm-col-width:100%;flex:1 0;margin-left:0;max-width:var(--ifm-col-width)}.padding-bottom--none,.padding-vert--none{padding-bottom:0!important}.padding-top--none,.padding-vert--none{padding-top:0!important}.discriminatorTabsContainer,.padding-horiz--none,.padding-left--none{padding-left:0!important}.padding-horiz--none,.padding-right--none{padding-right:0!important}.col[class*=col--]{flex:0 0 var(--ifm-col-width)}.col--1{--ifm-col-width:8.33333%}.col--offset-1{margin-left:8.33333%}.col--2{--ifm-col-width:16.66667%}.col--offset-2{margin-left:16.66667%}.col--3{--ifm-col-width:25%}.col--offset-3{margin-left:25%}.col--4{--ifm-col-width:33.33333%}.col--offset-4{margin-left:33.33333%}.col--5{--ifm-col-width:41.66667%}.col--offset-5{margin-left:41.66667%}.col--6{--ifm-col-width:50%}.col--offset-6{margin-left:50%}.col--7{--ifm-col-width:58.33333%}.col--offset-7{margin-left:58.33333%}.col--8{--ifm-col-width:66.66667%}.col--offset-8{margin-left:66.66667%}.col--9{--ifm-col-width:75%}.col--offset-9{margin-left:75%}.col--10{--ifm-col-width:83.33333%}.col--offset-10{margin-left:83.33333%}.col--11{--ifm-col-width:91.66667%}.col--offset-11{margin-left:91.66667%}.col--12{--ifm-col-width:100%}.col--offset-12{margin-left:100%}.margin-horiz--none,.margin-left--none{margin-left:0!important}.margin--none{margin:0!important}.margin-bottom--xs,.margin-vert--xs{margin-bottom:.25rem!important}.margin-top--xs,.margin-vert--xs{margin-top:.25rem!important}.margin-horiz--xs,.margin-left--xs{margin-left:.25rem!important}.margin-horiz--xs,.margin-right--xs{margin-right:.25rem!important}.margin--xs{margin:.25rem!important}.margin-bottom--sm,.margin-vert--sm{margin-bottom:.5rem!important}.margin-top--sm,.margin-vert--sm{margin-top:.5rem!important}.margin-horiz--sm,.margin-left--sm{margin-left:.5rem!important}.margin-horiz--sm,.margin-right--sm{margin-right:.5rem!important}.margin--sm{margin:.5rem!important}.margin-bottom--md,.margin-vert--md{margin-bottom:1rem!important}.margin-top--md,.margin-vert--md{margin-top:1rem!important}.margin-horiz--md,.margin-left--md{margin-left:1rem!important}.margin-horiz--md,.margin-right--md{margin-right:1rem!important}.margin--md{margin:1rem!important}.margin-bottom--lg,.margin-vert--lg{margin-bottom:2rem!important}.margin-top--lg,.margin-vert--lg{margin-top:2rem!important}.margin-horiz--lg,.margin-left--lg{margin-left:2rem!important}.margin-horiz--lg,.margin-right--lg{margin-right:2rem!important}.margin--lg{margin:2rem!important}.margin-bottom--xl,.margin-vert--xl{margin-bottom:5rem!important}.margin-top--xl,.margin-vert--xl{margin-top:5rem!important}.margin-horiz--xl,.margin-left--xl{margin-left:5rem!important}.margin-horiz--xl,.margin-right--xl{margin-right:5rem!important}.margin--xl{margin:5rem!important}.padding--none{padding:0!important}.padding-bottom--xs,.padding-vert--xs{padding-bottom:.25rem!important}.padding-top--xs,.padding-vert--xs{padding-top:.25rem!important}.padding-horiz--xs,.padding-left--xs{padding-left:.25rem!important}.padding-horiz--xs,.padding-right--xs{padding-right:.25rem!important}.padding--xs{padding:.25rem!important}.padding-bottom--sm,.padding-vert--sm{padding-bottom:.5rem!important}.padding-top--sm,.padding-vert--sm{padding-top:.5rem!important}.padding-horiz--sm,.padding-left--sm{padding-left:.5rem!important}.padding-horiz--sm,.padding-right--sm{padding-right:.5rem!important}.padding--sm{padding:.5rem!important}.padding-bottom--md,.padding-vert--md{padding-bottom:1rem!important}.padding-top--md,.padding-vert--md{padding-top:1rem!important}.padding-horiz--md,.padding-left--md{padding-left:1rem!important}.padding-horiz--md,.padding-right--md{padding-right:1rem!important}.padding--md{padding:1rem!important}.padding-bottom--lg,.padding-vert--lg{padding-bottom:2rem!important}.padding-top--lg,.padding-vert--lg{padding-top:2rem!important}.padding-horiz--lg,.padding-left--lg{padding-left:2rem!important}.padding-horiz--lg,.padding-right--lg{padding-right:2rem!important}.padding--lg{padding:2rem!important}.padding-bottom--xl,.padding-vert--xl{padding-bottom:5rem!important}.padding-top--xl,.padding-vert--xl{padding-top:5rem!important}.padding-horiz--xl,.padding-left--xl{padding-left:5rem!important}.padding-horiz--xl,.padding-right--xl{padding-right:5rem!important}.padding--xl{padding:5rem!important}code{background-color:var(--ifm-code-background);border:.1rem solid #0000001a;border-radius:var(--ifm-code-border-radius);font-family:var(--ifm-font-family-monospace);font-size:var(--ifm-code-font-size);padding:var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal)}a code{color:inherit}pre{background-color:var(--ifm-pre-background);border-radius:var(--ifm-pre-border-radius);color:var(--ifm-pre-color);font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace);margin:0 0 var(--ifm-spacing-vertical);overflow:auto;padding:var(--ifm-pre-padding)}pre code{background-color:initial;border:none;font-size:100%;line-height:inherit;padding:0}kbd{background-color:var(--ifm-color-emphasis-0);border:1px solid var(--ifm-color-emphasis-400);border-radius:.2rem;box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-400);color:var(--ifm-color-emphasis-800);font:80% var(--ifm-font-family-monospace);padding:.15rem .3rem}img[align=right]{padding-left:var(--image-alignment-padding)}img[align=left]{padding-right:var(--image-alignment-padding)}.markdown:after,.markdown:before{content:"";display:table}.markdown:after{clear:both}.markdown>h2{--ifm-h2-font-size:2rem;margin-top:calc(var(--ifm-h2-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h3{--ifm-h3-font-size:1.5rem;margin-top:calc(var(--ifm-h3-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h4,.markdown>h5,.markdown>h6{margin-top:calc(var(--ifm-heading-vertical-rhythm-top)*var(--ifm-leading))}.markdown>p,.markdown>pre,.markdown>ul,.tabList_OQG4,.tabList__CuJ{margin-bottom:var(--ifm-leading)}.markdown li{text-align:justify}.markdown li>p{margin-top:var(--ifm-list-paragraph-margin)}.markdown li+li{margin-top:var(--ifm-list-item-margin)}ol,ul{margin:0 0 var(--ifm-list-margin);padding-left:var(--ifm-list-left-padding);list-style-position:inside}ol ol,ol ul,ul ol,ul ul{margin:0;list-style-position:inside}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}table thead tr{border-bottom:2px solid var(--ifm-table-border-color)}table thead,table tr:nth-child(2n){background-color:var(--ifm-table-stripe-background)}table tr{background-color:var(--ifm-table-background);border-top:var(--ifm-table-border-width) solid var(--ifm-table-border-color)}table td,table th{border:var(--ifm-table-border-width) solid var(--ifm-table-border-color);padding:var(--ifm-table-cell-padding)}table th{background-color:var(--ifm-table-head-background);color:var(--ifm-table-head-color);font-weight:var(--ifm-table-head-font-weight)}table td{color:var(--ifm-table-cell-color)}strong{font-weight:var(--ifm-font-weight-bold)}a{color:var(--ifm-link-color);text-decoration:inherit;color:#229573;text-align:left;-webkit-text-decoration:var(--ifm-link-decoration);text-decoration:var(--ifm-link-decoration)}a:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button:hover,.text--no-decoration,.text--no-decoration:hover,a:not([href]){text-decoration:none}.markdown p,p{margin:0 0 var(--ifm-paragraph-margin-bottom)}blockquote{border-left:var(--ifm-blockquote-border-left-width) solid var(--ifm-blockquote-border-color);box-shadow:var(--ifm-blockquote-shadow);color:var(--ifm-blockquote-color);font-size:var(--ifm-blockquote-font-size);margin:0 0 var(--ifm-spacing-vertical);padding:var(--ifm-blockquote-padding-vertical) var(--ifm-blockquote-padding-horizontal)}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}.markdown hr,hr{background-color:var(--ifm-hr-background-color);border:0;height:var(--ifm-hr-height);margin:var(--ifm-hr-margin-vertical) 0}.shadow--lw{box-shadow:var(--ifm-global-shadow-lw)!important}.shadow--md{box-shadow:var(--ifm-global-shadow-md)!important}.shadow--tl{box-shadow:var(--ifm-global-shadow-tl)!important}.text--primary,.wordWrapButtonEnabled_EoeP .wordWrapButtonIcon_Bwma{color:var(--ifm-color-primary)}.text--secondary{color:var(--ifm-color-secondary)}.text--success{color:var(--ifm-color-success)}.text--info{color:var(--ifm-color-info)}.text--warning{color:var(--ifm-color-warning)}.text--danger{color:var(--ifm-color-danger)}.clean-btn,hr{color:inherit}.text--center{text-align:center}.text--left{text-align:left}.text--justify,p{text-align:justify}.text--right{text-align:right}.text--capitalize{text-transform:capitalize}.text--lowercase{text-transform:lowercase}.admonitionHeading_tbUL,.alert__heading,.api-method>.menu__link:before,.text--uppercase{text-transform:uppercase}.text--light{font-weight:var(--ifm-font-weight-light)}.text--normal{font-weight:var(--ifm-font-weight-normal)}.text--semibold{font-weight:var(--ifm-font-weight-semibold)}.text--bold{font-weight:var(--ifm-font-weight-bold)}.text--italic{font-style:italic}.text--truncate{overflow:hidden;text-overflow:ellipsis}.text--break{word-wrap:break-word!important;word-break:break-word!important}.clean-btn{background:none;border:none;cursor:pointer;font-family:inherit;padding:0}.alert,.alert .close{color:var(--ifm-alert-foreground-color)}.clean-list{list-style:none;padding-left:0}.alert--primary{--ifm-alert-background-color:var(--ifm-color-primary-contrast-background);--ifm-alert-background-color-highlight:#3578e526;--ifm-alert-foreground-color:var(--ifm-color-primary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-primary-dark)}.alert--secondary{--ifm-alert-background-color:var(--ifm-color-secondary-contrast-background);--ifm-alert-background-color-highlight:#ebedf026;--ifm-alert-foreground-color:var(--ifm-color-secondary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-secondary-dark)}.alert--success{--ifm-alert-background-color:var(--ifm-color-success-contrast-background);--ifm-alert-background-color-highlight:#00a40026;--ifm-alert-foreground-color:var(--ifm-color-success-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-success-dark)}.alert--info{--ifm-alert-background-color:var(--ifm-color-info-contrast-background);--ifm-alert-background-color-highlight:#54c7ec26;--ifm-alert-foreground-color:var(--ifm-color-info-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-info-dark)}.alert--warning{--ifm-alert-background-color:var(--ifm-color-warning-contrast-background);--ifm-alert-background-color-highlight:#ffba0026;--ifm-alert-foreground-color:var(--ifm-color-warning-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-warning-dark)}.alert--danger{--ifm-alert-background-color:var(--ifm-color-danger-contrast-background);--ifm-alert-background-color-highlight:#fa383e26;--ifm-alert-foreground-color:var(--ifm-color-danger-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-danger-dark)}.alert{--ifm-code-background:var(--ifm-alert-background-color-highlight);--ifm-link-color:var(--ifm-alert-foreground-color);--ifm-link-hover-color:var(--ifm-alert-foreground-color);--ifm-link-decoration:underline;--ifm-tabs-color:var(--ifm-alert-foreground-color);--ifm-tabs-color-active:var(--ifm-alert-foreground-color);--ifm-tabs-color-active-border:var(--ifm-alert-border-color);background-color:var(--ifm-alert-background-color);border:var(--ifm-alert-border-width) solid var(--ifm-alert-border-color);border-left-width:var(--ifm-alert-border-left-width);border-radius:var(--ifm-alert-border-radius);box-shadow:var(--ifm-alert-shadow);padding:var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal)}.alert__heading{align-items:center;display:flex;font:700 var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.5rem}.alert__icon{display:inline-flex;margin-right:.4em}.alert__icon svg{fill:var(--ifm-alert-foreground-color);stroke:var(--ifm-alert-foreground-color);stroke-width:0}.alert .close{margin:calc(var(--ifm-alert-padding-vertical)*-1) calc(var(--ifm-alert-padding-horizontal)*-1) 0 0;opacity:.75}.alert .close:focus,.alert .close:hover{opacity:1}.alert a{text-decoration-color:var(--ifm-alert-border-color)}.alert a:hover{text-decoration-thickness:2px}.avatar{column-gap:var(--ifm-avatar-intro-margin);display:flex}.avatar__photo{border-radius:50%;display:block;height:var(--ifm-avatar-photo-size);overflow:hidden;width:var(--ifm-avatar-photo-size)}.avatar__photo--sm{--ifm-avatar-photo-size:2rem}.avatar__photo--lg{--ifm-avatar-photo-size:4rem}.avatar__photo--xl{--ifm-avatar-photo-size:6rem}.avatar__intro{display:flex;flex:1 1;flex-direction:column;justify-content:center;text-align:var(--ifm-avatar-intro-alignment)}.badge,.breadcrumbs__item,.breadcrumbs__link,.button,.dropdown>.navbar__link:after{display:inline-block}.avatar__name{font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base)}.avatar__subtitle{margin-top:.25rem}.avatar--vertical{--ifm-avatar-intro-alignment:center;--ifm-avatar-intro-margin:0.5rem;align-items:center;flex-direction:column}.badge{background-color:var(--ifm-badge-background-color);border:var(--ifm-badge-border-width) solid var(--ifm-badge-border-color);border-radius:var(--ifm-badge-border-radius);color:var(--ifm-badge-color);font-size:75%;font-weight:var(--ifm-font-weight-bold);line-height:1;padding:var(--ifm-badge-padding-vertical) var(--ifm-badge-padding-horizontal)}.badge--primary{--ifm-badge-background-color:var(--ifm-color-primary)}.badge--secondary{--ifm-badge-background-color:var(--ifm-color-secondary);color:var(--ifm-color-black)}.breadcrumbs__link,.button.button--secondary.button--outline:not(.button--active):not(:hover){color:var(--ifm-font-color-base)}.badge--success{--ifm-badge-background-color:var(--ifm-color-success)}.badge--info{--ifm-badge-background-color:var(--ifm-color-info)}.badge--warning{--ifm-badge-background-color:var(--ifm-color-warning)}.badge--danger{--ifm-badge-background-color:var(--ifm-color-danger)}.breadcrumbs{margin-bottom:0;padding-left:0}.breadcrumbs__item:not(:last-child):after{background:var(--ifm-breadcrumb-separator) center;content:" ";display:inline-block;filter:var(--ifm-breadcrumb-separator-filter);height:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));margin:0 var(--ifm-breadcrumb-spacing);opacity:.5;width:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier))}.breadcrumbs__item--active .breadcrumbs__link{background:var(--ifm-breadcrumb-item-background-active);color:var(--ifm-breadcrumb-color-active)}.breadcrumbs__link{border-radius:var(--ifm-breadcrumb-border-radius);font-size:calc(1rem*var(--ifm-breadcrumb-size-multiplier));padding:calc(var(--ifm-breadcrumb-padding-vertical)*var(--ifm-breadcrumb-size-multiplier)) calc(var(--ifm-breadcrumb-padding-horizontal)*var(--ifm-breadcrumb-size-multiplier));transition-duration:var(--ifm-transition-fast);transition-property:background,color}.breadcrumbs__link:any-link:hover,.breadcrumbs__link:link:hover,.breadcrumbs__link:visited:hover,area.breadcrumbs__link[href]:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs--sm{--ifm-breadcrumb-size-multiplier:0.8}.breadcrumbs--lg{--ifm-breadcrumb-size-multiplier:1.2}.button{background-color:var(--ifm-button-background-color);border:var(--ifm-button-border-width) solid var(--ifm-button-border-color);border-radius:var(--ifm-button-border-radius);cursor:pointer;font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:var(--ifm-button-font-weight);line-height:1.5;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;transition-duration:var(--ifm-button-transition-duration);transition-property:color,background,border-color;-webkit-user-select:none;user-select:none}.button,.button:hover{color:var(--ifm-button-color)}.button--outline{--ifm-button-color:var(--ifm-button-border-color)}.button--outline:hover{--ifm-button-background-color:var(--ifm-button-border-color)}.button--link{--ifm-button-border-color:#0000;color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}.button--link.button--active,.button--link:active,.button--link:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button.disabled,.button:disabled,.button[disabled]{opacity:.65;pointer-events:none}.button--sm{--ifm-button-size-multiplier:0.8}.button--lg{--ifm-button-size-multiplier:1.35}.button--block{display:block;width:100%}.button.button--secondary{color:var(--ifm-color-gray-900)}:where(.button--primary){--ifm-button-background-color:var(--ifm-color-primary);--ifm-button-border-color:var(--ifm-color-primary)}:where(.button--primary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-primary-dark);--ifm-button-border-color:var(--ifm-color-primary-dark)}.button--primary.button--active,.button--primary:active{--ifm-button-background-color:var(--ifm-color-primary-darker);--ifm-button-border-color:var(--ifm-color-primary-darker)}:where(.button--secondary){--ifm-button-background-color:var(--ifm-color-secondary);--ifm-button-border-color:var(--ifm-color-secondary)}:where(.button--secondary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-secondary-dark);--ifm-button-border-color:var(--ifm-color-secondary-dark)}.button--secondary.button--active,.button--secondary:active{--ifm-button-background-color:var(--ifm-color-secondary-darker);--ifm-button-border-color:var(--ifm-color-secondary-darker)}:where(.button--success){--ifm-button-background-color:var(--ifm-color-success);--ifm-button-border-color:var(--ifm-color-success)}:where(.button--success):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-success-dark);--ifm-button-border-color:var(--ifm-color-success-dark)}.button--success.button--active,.button--success:active{--ifm-button-background-color:var(--ifm-color-success-darker);--ifm-button-border-color:var(--ifm-color-success-darker)}:where(.button--info){--ifm-button-background-color:var(--ifm-color-info);--ifm-button-border-color:var(--ifm-color-info)}:where(.button--info):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-info-dark);--ifm-button-border-color:var(--ifm-color-info-dark)}.button--info.button--active,.button--info:active{--ifm-button-background-color:var(--ifm-color-info-darker);--ifm-button-border-color:var(--ifm-color-info-darker)}:where(.button--warning){--ifm-button-background-color:var(--ifm-color-warning);--ifm-button-border-color:var(--ifm-color-warning)}:where(.button--warning):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-warning-dark);--ifm-button-border-color:var(--ifm-color-warning-dark)}.button--warning.button--active,.button--warning:active{--ifm-button-background-color:var(--ifm-color-warning-darker);--ifm-button-border-color:var(--ifm-color-warning-darker)}:where(.button--danger){--ifm-button-background-color:var(--ifm-color-danger);--ifm-button-border-color:var(--ifm-color-danger)}:where(.button--danger):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-danger-dark);--ifm-button-border-color:var(--ifm-color-danger-dark)}.button--danger.button--active,.button--danger:active{--ifm-button-background-color:var(--ifm-color-danger-darker);--ifm-button-border-color:var(--ifm-color-danger-darker)}.button-group{display:inline-flex;gap:var(--ifm-button-group-spacing)}.button-group>.button:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.button-group>.button:not(:last-child){border-bottom-right-radius:0;border-top-right-radius:0}.button-group--block{display:flex;justify-content:stretch}.button-group--block>.button{flex-grow:1}.card{background-color:var(--ifm-card-background-color);border-radius:var(--ifm-card-border-radius);box-shadow:var(--ifm-global-shadow-lw);display:flex;flex-direction:column;overflow:hidden}.card--full-height{height:100%}.card__image{padding-top:var(--ifm-card-vertical-spacing)}.card__image:first-child{padding-top:0}.card__body,.card__footer,.card__header{padding:var(--ifm-card-vertical-spacing) var(--ifm-card-horizontal-spacing)}.card__body:not(:last-child),.card__footer:not(:last-child),.card__header:not(:last-child){padding-bottom:0}.card__body>:last-child,.card__footer>:last-child,.card__header>:last-child{margin-bottom:0}.card__footer{margin-top:auto}.table-of-contents{font-size:.8rem;margin-bottom:0;padding:var(--ifm-toc-padding-vertical) 0}.table-of-contents,.table-of-contents ul{list-style:none;padding-left:var(--ifm-toc-padding-horizontal)}.table-of-contents li{margin:var(--ifm-toc-padding-vertical) var(--ifm-toc-padding-horizontal)}.table-of-contents__left-border{border-left:1px solid var(--ifm-toc-border-color)}.table-of-contents__link{color:var(--ifm-toc-link-color);display:block}.table-of-contents__link--active,.table-of-contents__link--active code,.table-of-contents__link:hover,.table-of-contents__link:hover code{color:var(--ifm-color-primary);text-decoration:none}.close{color:var(--ifm-color-black);float:right;font-size:1.5rem;font-weight:var(--ifm-font-weight-bold);line-height:1;opacity:.5;padding:1rem;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.close:hover{opacity:.7}.close:focus,.theme-code-block-highlighted-line .codeLineNumber_Tfdd:before{opacity:.8}.dropdown{display:inline-flex;font-weight:var(--ifm-dropdown-font-weight);position:relative;vertical-align:top}.dropdown--hoverable:hover .dropdown__menu,.dropdown--show .dropdown__menu{opacity:1;pointer-events:all;transform:translateY(-1px);visibility:visible}#nprogress,.dropdown__menu,.navbar__item.dropdown .navbar__link:not([href]){pointer-events:none}.dropdown--right .dropdown__menu{left:inherit;right:0}.dropdown--nocaret .navbar__link:after{content:none!important}.dropdown__menu{background-color:var(--ifm-dropdown-background-color);border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-md);left:0;list-style:none;max-height:80vh;min-width:10rem;opacity:0;overflow-y:auto;padding:.5rem;position:absolute;top:calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);transform:translateY(-.625rem);transition-duration:var(--ifm-transition-fast);transition-property:opacity,transform,visibility;transition-timing-function:var(--ifm-transition-timing-default);visibility:hidden;z-index:var(--ifm-z-index-dropdown)}.language-bash,.language-csharp,.language-go,.language-javascript,.language-nodejs,.language-php,.language-python,.language-ruby,.theme-api-markdown code{max-height:500px;overflow:auto}.menu__caret,.menu__link,.menu__list-item-collapsible{border-radius:.25rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.dropdown__link{border-radius:.25rem;color:var(--ifm-dropdown-link-color);display:block;font-size:.875rem;margin-top:.2rem;padding:.25rem .5rem}.dropdown__link--active,.dropdown__link:hover{background-color:var(--ifm-dropdown-hover-background-color);color:var(--ifm-dropdown-link-color);text-decoration:none}.dropdown__link--active,.dropdown__link--active:hover{--ifm-dropdown-link-color:var(--ifm-link-color)}.dropdown>.navbar__link:after{border-color:currentcolor #0000;border-style:solid;border-width:.4em .4em 0;content:"";margin-left:.3em;position:relative;top:2px;transform:translateY(-50%)}.footer{background-color:var(--ifm-footer-background-color);color:var(--ifm-footer-color);padding:var(--ifm-footer-padding-vertical) var(--ifm-footer-padding-horizontal)}.footer--dark{--ifm-footer-background-color:#303846;--ifm-footer-color:var(--ifm-footer-link-color);--ifm-footer-link-color:var(--ifm-color-secondary);--ifm-footer-title-color:var(--ifm-color-white)}.footer__links,.theme-api-markdown pre{margin-bottom:1rem}.footer__link-item{color:var(--ifm-footer-link-color);line-height:2}.footer__link-item:hover{color:var(--ifm-footer-link-hover-color)}.footer__link-separator{margin:0 var(--ifm-footer-link-horizontal-spacing)}.footer__logo{margin-top:1rem;max-width:var(--ifm-footer-logo-max-width)}.footer__title{color:var(--ifm-footer-title-color);font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base);margin-bottom:var(--ifm-heading-margin-bottom)}.menu,.navbar__link{font-weight:var(--ifm-font-weight-semibold)}.apiItemContainer article>:first-child,.apiItemContainer header+*,.docItemContainer article>:first-child,.docItemContainer header+*,.docItemContainer_joH8 article>:first-child,.docItemContainer_joH8 header+*,.footer__item,.formItem_WgRa:first-child,.showMoreButton_ZGo2:first-child,.showMoreButton_jDKX:first-child{margin-top:0}.admonitionContent_S0QG>:last-child,.cardContainer_fWXF :last-child,.cardContainer_p3e_ :last-child,.collapsibleContent_i85q>:last-child,.footer__items,.markdown [class^=codeBlock]>pre,.tabItem_Ymn6>:last-child,.theme-api-markdown details p{margin-bottom:0}.codeBlockStandalone_MEMb,[type=checkbox],fieldset,legend{padding:0}.hero{align-items:center;background-color:var(--ifm-hero-background-color);color:var(--ifm-hero-text-color);display:flex;padding:4rem 2rem}.hero--primary{--ifm-hero-background-color:var(--ifm-color-primary);--ifm-hero-text-color:var(--ifm-font-color-base-inverse)}.hero--dark{--ifm-hero-background-color:#303846;--ifm-hero-text-color:var(--ifm-color-white)}.hero__title{font-size:3rem}.hero__subtitle{font-size:1.5rem}.menu__list{list-style:none;margin:0;padding-left:0}.menu__caret,.menu__link{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu__list .menu__list{flex:0 0 100%;margin-top:.25rem;padding-left:var(--ifm-menu-link-padding-horizontal)}.menu__list-item:not(:first-child){margin-top:.25rem}.menu__list-item--collapsed .menu__list{height:0;overflow:hidden}.details_lb9f[data-collapsed=false].isBrowser_bmU9>summary:before,.details_lb9f[open]:not(.isBrowser_bmU9)>summary:before,.menu__list-item--collapsed .menu__caret:before,.menu__list-item--collapsed .menu__link--sublist:after,.tabArrowRight_X4Xu,.tabArrowRight_oN04,.tabArrowRight_qsDv,.tabArrowRight_x8Ix{transform:rotate(90deg)}.menu__list-item-collapsible{display:flex;flex-wrap:wrap;position:relative}.menu__caret:hover,.menu__link:hover,.menu__list-item-collapsible--active,.menu__list-item-collapsible:hover{background:var(--ifm-menu-color-background-hover)}.menu__list-item-collapsible .menu__link--active,.menu__list-item-collapsible .menu__link:hover{background:none!important}.menu__caret,.menu__link{align-items:center;display:flex}.navbar-sidebar,.navbar-sidebar__backdrop{bottom:0;opacity:0;transition-timing-function:ease-in-out;top:0;left:0;visibility:hidden}.menu__link{color:var(--ifm-menu-color);flex:1;line-height:1.25}.menu__link:hover{color:var(--ifm-menu-color);text-decoration:none}.menu__caret:before,.menu__link--sublist-caret:after{content:"";filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast) linear;width:1.25rem}.menu__link--sublist-caret:after{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;margin-left:auto;min-width:1.25rem}.navbar__items--center .navbar__brand,blockquote,body,dd,dl,fieldset,figure,h1,h2,h3,h4,h5,h6,hr,menu,ol,p,pre,ul{margin:0}.menu__link--active,.menu__link--active:hover{color:var(--ifm-menu-color-active)}.navbar__brand,.navbar__link{color:var(--ifm-navbar-link-color)}.menu__link--active:not(.menu__link--sublist),.paramsItem:focus,.paramsItem:hover,.paramsItem_PKlE:focus,.paramsItem_PKlE:hover,.schemaItem:focus,.schemaItem:hover,.schemaItem_P8yX:focus,.schemaItem_P8yX:hover{background-color:var(--ifm-menu-color-background-active)}.menu__caret:before{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem}.navbar--dark,html[data-theme=dark]{--ifm-menu-link-sublist-icon-filter:invert(100%) sepia(94%) saturate(17%) hue-rotate(223deg) brightness(104%) contrast(98%)}.navbar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-navbar-shadow);height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.docsWrapper_BCFX,.flex,.navbar,.navbar>.container,.navbar>.container-fluid,.theme-edit-this-page{display:flex}.navbar--fixed-top{position:sticky;top:0;z-index:var(--ifm-z-index-fixed)}.navbar__inner{display:flex;flex-wrap:wrap;justify-content:space-between;width:100%}.navbar__brand{align-items:center;display:flex;margin-right:1rem;min-width:0}.navbar__brand:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.announcementBarContent_xLdY,.navbar__title{flex:1 1 auto}.navbar__toggle{display:none;margin-right:.5rem}.navbar__logo{flex:0 0 auto;height:2rem;margin-right:.5rem}.docs-wrapper,.navbar__logo img,body,html{height:100%}.navbar__items{align-items:center;display:flex;flex:1;min-width:0}.navbar__items--center{flex:0 0 auto}.navbar__items--center+.navbar__items--right{flex:1}.navbar__items--right{flex:0 0 auto;justify-content:flex-end}.navbar__items--right>:last-child,.pr-0{padding-right:0}.navbar__item{display:inline-block;padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.navbar__link--active,.navbar__link:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.navbar--dark,.navbar--primary{--ifm-menu-color:var(--ifm-color-gray-300);--ifm-navbar-link-color:var(--ifm-color-gray-100);--ifm-navbar-search-input-background-color:#ffffff1a;--ifm-navbar-search-input-placeholder-color:#ffffff80;color:var(--ifm-color-white)}.navbar--dark{--ifm-navbar-background-color:#242526;--ifm-menu-color-background-active:#ffffff0d;--ifm-navbar-search-input-color:var(--ifm-color-white)}.navbar--primary{--ifm-navbar-background-color:var(--ifm-color-primary);--ifm-navbar-link-hover-color:var(--ifm-color-white);--ifm-menu-color-active:var(--ifm-color-white);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-500)}.navbar__search-input{-webkit-appearance:none;appearance:none;background:var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat .75rem center/1rem 1rem;border:none;border-radius:2rem;color:var(--ifm-navbar-search-input-color);cursor:text;display:inline-block;font-size:.9rem;height:2rem;padding:0 .5rem 0 2.25rem;width:12.5rem}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar-sidebar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-global-shadow-md);position:fixed;transform:translate3d(-100%,0,0);transition-duration:.25s;transition-property:opacity,visibility,transform;width:var(--ifm-navbar-sidebar-width)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar__items{transform:translateZ(0)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar--show .navbar-sidebar__backdrop{opacity:1;visibility:visible}.navbar-sidebar__backdrop{background-color:#0009;position:fixed;right:0;transition-duration:.1s;transition-property:opacity,visibility}.buttonGroup_SdX7 button.selected_VHjy,.buttonGroup_SdX7 button:hover,.navbar-sidebar__back{background:var(--ifm-menu-color-background-active)}.navbar-sidebar__brand{align-items:center;box-shadow:var(--ifm-navbar-shadow);display:flex;flex:1;height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar-sidebar__items{display:flex;height:calc(100% - var(--ifm-navbar-height));transition:transform var(--ifm-transition-fast) ease-in-out}.navbar-sidebar__items--show-secondary{transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0)}.navbar-sidebar__item{flex-shrink:0;padding:.5rem;width:calc(var(--ifm-navbar-sidebar-width))}.navbar-sidebar__back{font-size:15px;font-weight:var(--ifm-button-font-weight);margin:0 0 .2rem -.5rem;padding:.6rem 1.5rem;position:relative;text-align:left;top:-.5rem;width:calc(100% + 1rem)}.navbar-sidebar__close{display:flex;margin-left:auto}.pagination{column-gap:var(--ifm-pagination-page-spacing);display:flex;font-size:var(--ifm-pagination-font-size);padding-left:0}.pagination--sm{--ifm-pagination-font-size:0.8rem;--ifm-pagination-padding-horizontal:0.8rem;--ifm-pagination-padding-vertical:0.2rem}.pagination--lg{--ifm-pagination-font-size:1.2rem;--ifm-pagination-padding-horizontal:1.2rem;--ifm-pagination-padding-vertical:0.3rem}.inline-flex,.pagination__item{display:inline-flex}.pagination__item>span{padding:var(--ifm-pagination-padding-vertical)}.pagination__item--active .pagination__link{color:var(--ifm-pagination-color-active)}.pagination__item--active .pagination__link,.pagination__item:not(.pagination__item--active):hover .pagination__link{background:var(--ifm-pagination-item-active-background)}.pagination__item--disabled,.pagination__item[disabled]{opacity:.25;pointer-events:none}.pagination__link{border-radius:var(--ifm-pagination-border-radius);color:var(--ifm-font-color-base);display:inline-block;padding:var(--ifm-pagination-padding-vertical) var(--ifm-pagination-padding-horizontal);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination__link:hover{text-decoration:none}.pagination-nav{grid-gap:var(--ifm-spacing-horizontal);display:grid;gap:var(--ifm-spacing-horizontal);grid-template-columns:repeat(2,1fr)}.pagination-nav__link{border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-pagination-nav-border-radius);display:block;height:100%;line-height:var(--ifm-heading-line-height);padding:var(--ifm-global-spacing);transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav__link:hover{border-color:var(--ifm-pagination-nav-color-hover);text-decoration:none}.pagination-nav__link--next{grid-column:2/3;text-align:right}.pagination-nav__label{font-size:var(--ifm-h4-font-size);font-weight:var(--ifm-heading-font-weight);word-break:break-word}.pagination-nav__link--prev .pagination-nav__label:before{content:"« "}.pagination-nav__link--next .pagination-nav__label:after{content:" »"}.pagination-nav__sublabel{color:var(--ifm-color-content-secondary);font-size:var(--ifm-h5-font-size);font-weight:var(--ifm-font-weight-semibold);margin-bottom:.25rem}.pills__item,.tabs{font-weight:var(--ifm-font-weight-bold)}.pills{display:flex;gap:var(--ifm-pills-spacing);padding-left:0}.pills__item{border-radius:.5rem;cursor:pointer;display:inline-block;padding:.25rem 1rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.menu__list li,.tabs,.theme-api-markdown ul,:not(.containsTaskList_mC6p>li)>.containsTaskList_mC6p{padding-left:0}.pills__item--active{color:var(--ifm-pills-color-active)}.pills__item--active,.pills__item:not(.pills__item--active):hover{background:var(--ifm-pills-color-background-active)}.pills--block{justify-content:stretch}.pills--block .pills__item{flex-grow:1;text-align:center}.tabs{color:var(--ifm-tabs-color);display:flex;margin-bottom:0;overflow-x:auto}.mb-6,.my-6{margin-bottom:1.5rem}.tabs__item{border-bottom:3px solid #0000;border-radius:var(--ifm-global-radius);cursor:pointer;display:inline-flex;padding:var(--ifm-tabs-padding-vertical) var(--ifm-tabs-padding-horizontal);transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs__item--active{border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}.tabs__item:hover{background-color:var(--ifm-hover-overlay)}.tabs--block{justify-content:stretch}.tabs--block .tabs__item{flex-grow:1;justify-content:center}html[data-theme=dark]{--ifm-color-scheme:dark;--ifm-color-emphasis-0:var(--ifm-color-gray-1000);--ifm-color-emphasis-100:var(--ifm-color-gray-900);--ifm-color-emphasis-200:var(--ifm-color-gray-800);--ifm-color-emphasis-300:var(--ifm-color-gray-700);--ifm-color-emphasis-400:var(--ifm-color-gray-600);--ifm-color-emphasis-600:var(--ifm-color-gray-400);--ifm-color-emphasis-700:var(--ifm-color-gray-300);--ifm-color-emphasis-800:var(--ifm-color-gray-200);--ifm-color-emphasis-900:var(--ifm-color-gray-100);--ifm-color-emphasis-1000:var(--ifm-color-gray-0);--ifm-background-color:#1b1b1d;--ifm-background-surface-color:#242526;--ifm-hover-overlay:#ffffff0d;--ifm-color-content:#e3e3e3;--ifm-color-content-secondary:#fff;--ifm-breadcrumb-separator-filter:invert(64%) sepia(11%) saturate(0%) hue-rotate(149deg) brightness(99%) contrast(95%);--ifm-code-background:#ffffff1a;--ifm-scrollbar-track-background-color:#444;--ifm-scrollbar-thumb-background-color:#686868;--ifm-scrollbar-thumb-hover-background-color:#7a7a7a;--ifm-table-stripe-background:#ffffff12;--ifm-toc-border-color:var(--ifm-color-emphasis-200);--ifm-color-primary-contrast-background:#102445;--ifm-color-primary-contrast-foreground:#ebf2fc;--ifm-color-secondary-contrast-background:#474748;--ifm-color-secondary-contrast-foreground:#fdfdfe;--ifm-color-success-contrast-background:#003100;--ifm-color-success-contrast-foreground:#e6f6e6;--ifm-color-info-contrast-background:#193c47;--ifm-color-info-contrast-foreground:#eef9fd;--ifm-color-warning-contrast-background:#4d3800;--ifm-color-warning-contrast-foreground:#fff8e6;--ifm-color-danger-contrast-background:#4b1113;--ifm-color-danger-contrast-foreground:#ffebec;--docsearch-text-color:#f5f6f7;--docsearch-container-background:#090a11cc;--docsearch-modal-background:#15172a;--docsearch-modal-shadow:inset 1px 1px 0 0 #2c2e40,0 3px 8px 0 #000309;--docsearch-searchbox-background:#090a11;--docsearch-searchbox-focus-background:#000;--docsearch-hit-color:#bec3c9;--docsearch-hit-shadow:none;--docsearch-hit-background:#090a11;--docsearch-key-gradient:linear-gradient(-26.5deg,#565872,#31355b);--docsearch-key-shadow:inset 0 -2px 0 0 #282d55,inset 0 0 1px 1px #51577d,0 2px 2px 0 #0304094d;--docsearch-footer-background:#1e2136;--docsearch-footer-shadow:inset 0 1px 0 0 #494c6a80,0 -4px 8px 0 #0003;--docsearch-logo-color:#fff;--docsearch-muted-color:#7f8497}#nprogress .bar{background:var(--docusaurus-progress-bar-color);height:2px;left:0;position:fixed;top:0;width:100%;z-index:1031}#nprogress .peg,.absolute{position:absolute}#nprogress .peg{box-shadow:0 0 10px var(--docusaurus-progress-bar-color),0 0 5px var(--docusaurus-progress-bar-color);height:100%;opacity:1;right:0;transform:rotate(3deg) translateY(-4px);width:100px}*,:after,:before{border:0 solid #e5e7eb;--tw-border-spacing-x:0;--tw-border-spacing-y:0;--tw-translate-x:0;--tw-translate-y:0;--tw-rotate:0;--tw-skew-x:0;--tw-skew-y:0;--tw-scale-x:1;--tw-scale-y:1;--tw-pan-x: ;--tw-pan-y: ;--tw-pinch-zoom: ;--tw-scroll-snap-strictness:proximity;--tw-ordinal: ;--tw-slashed-zero: ;--tw-numeric-figure: ;--tw-numeric-spacing: ;--tw-numeric-fraction: ;--tw-ring-inset: ;--tw-ring-offset-width:0px;--tw-ring-offset-color:#fff;--tw-ring-color:#3b82f680;--tw-ring-offset-shadow:0 0 #0000;--tw-ring-shadow:0 0 #0000;--tw-shadow:0 0 #0000;--tw-shadow-colored:0 0 #0000;--tw-blur: ;--tw-brightness: ;--tw-contrast: ;--tw-grayscale: ;--tw-hue-rotate: ;--tw-invert: ;--tw-saturate: ;--tw-sepia: ;--tw-drop-shadow: ;--tw-backdrop-blur: ;--tw-backdrop-brightness: ;--tw-backdrop-contrast: ;--tw-backdrop-grayscale: ;--tw-backdrop-hue-rotate: ;--tw-backdrop-invert: ;--tw-backdrop-opacity: ;--tw-backdrop-saturate: ;--tw-backdrop-sepia: }:after,:before{--tw-content:""}html{-webkit-text-size-adjust:100%;font-feature-settings:normal;font-family:ui-sans-serif,system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji;line-height:1.5;tab-size:4}body{line-height:inherit}hr{border-top-width:1px;height:0}abbr:where([title]){-webkit-text-decoration:underline dotted;text-decoration:underline dotted}h1,h2,h3,h4,h5,h6{font-size:inherit;font-weight:inherit}b,strong{font-weight:bolder}code,kbd,pre,samp{font-family:ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;font-size:1em}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative}sub{bottom:-.25em}sup{top:-.5em}table{display:block;margin-bottom:var(--ifm-spacing-vertical);overflow:auto;border-collapse:collapse;border-color:inherit;text-indent:0}button,input,optgroup,select,textarea{color:inherit;font-family:inherit;font-size:100%;font-weight:inherit;line-height:inherit;margin:0;padding:0}.admonitionHeading_tbUL code,button,select{text-transform:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button;background-color:initial;background-image:none}:-moz-focusring{outline:auto}:-moz-ui-invalid{box-shadow:none}::-webkit-inner-spin-button,::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}summary{display:list-item}menu,ol,ul{list-style:none;padding:0}textarea{resize:vertical}input::placeholder,textarea::placeholder{color:#9ca3af;opacity:1}.tabArrow_LyoO:hover,.tabArrow_WDKX:hover,.tabArrow_x5p_:hover,.tabArrow_zmvw:hover,[role=button],button{cursor:pointer}:disabled{cursor:default}audio,canvas,embed,iframe,img,object,svg,video{display:block;vertical-align:middle}img,video{height:auto;max-width:100%}#docusaurus-base-url-issue-banner-container,.hidden,.markdown #authentication,.markdown #authentication+div,.themedImage_ToTc,[data-theme=dark] .lightToggleIcon_pyhR,[data-theme=light] .darkToggleIcon_wfgR,[hidden],html[data-announcement-bar-initially-dismissed=true] .announcementBar_mb4j{display:none}::backdrop{--tw-border-spacing-x:0;--tw-border-spacing-y:0;--tw-translate-x:0;--tw-translate-y:0;--tw-rotate:0;--tw-skew-x:0;--tw-skew-y:0;--tw-scale-x:1;--tw-scale-y:1;--tw-pan-x: ;--tw-pan-y: ;--tw-pinch-zoom: ;--tw-scroll-snap-strictness:proximity;--tw-ordinal: ;--tw-slashed-zero: ;--tw-numeric-figure: ;--tw-numeric-spacing: ;--tw-numeric-fraction: ;--tw-ring-inset: ;--tw-ring-offset-width:0px;--tw-ring-offset-color:#fff;--tw-ring-color:#3b82f680;--tw-ring-offset-shadow:0 0 #0000;--tw-ring-shadow:0 0 #0000;--tw-shadow:0 0 #0000;--tw-shadow-colored:0 0 #0000;--tw-blur: ;--tw-brightness: ;--tw-contrast: ;--tw-grayscale: ;--tw-hue-rotate: ;--tw-invert: ;--tw-saturate: ;--tw-sepia: ;--tw-drop-shadow: ;--tw-backdrop-blur: ;--tw-backdrop-brightness: ;--tw-backdrop-contrast: ;--tw-backdrop-grayscale: ;--tw-backdrop-hue-rotate: ;--tw-backdrop-invert: ;--tw-backdrop-opacity: ;--tw-backdrop-saturate: ;--tw-backdrop-sepia: }.my-6{margin-top:1.5rem}.-mt-1{margin-top:-.25rem}.ml-1{margin-left:.25rem}.mt-4{margin-top:1rem}.mb-2{margin-bottom:.5rem}.mb-3{margin-bottom:.75rem}.mt-5{margin-top:1.25rem}.mb-8{margin-bottom:2rem}.grid{display:grid}.\!hidden{display:none!important}.h-72{height:18rem}.w-auto{width:auto}.responseSamplesTabItem_f_p_,.w-full{width:100%}.w-\[480px\]{width:480px}.min-w-\[480px\]{min-width:480px}.max-w-lg{max-width:32rem}.max-w-sm{max-width:24rem}.transform{transform:translate(var(--tw-translate-x),var(--tw-translate-y)) rotate(var(--tw-rotate)) skewX(var(--tw-skew-x)) skewY(var(--tw-skew-y)) scaleX(var(--tw-scale-x)) scaleY(var(--tw-scale-y))}.cursor-wait{cursor:wait}.flex-row{flex-direction:row}.flex-col{flex-direction:column}.flex-wrap{flex-wrap:wrap}.place-content-center{place-content:center}.place-items-end{place-items:end}.content-center{align-content:center}.justify-start{justify-content:flex-start}.justify-end{justify-content:flex-end}.justify-center{justify-content:center}.justify-between{justify-content:space-between}.gap-2{gap:.5rem}.gap-1{gap:.25rem}.gap-8{gap:2rem}.gap-3{gap:.75rem}.gap-4{gap:1rem}.rounded{border-radius:.25rem}.border{border-width:1px}.border-b{border-bottom-width:1px}.border-b-2{border-bottom-width:2px}.border-black{--tw-border-opacity:1;border-color:rgb(0 0 0/var(--tw-border-opacity))}.bg-white{--tw-bg-opacity:1;background-color:rgb(255 255 255/var(--tw-bg-opacity))}.p-5{padding:1.25rem}.px-4{padding-left:1rem;padding-right:1rem}.py-4{padding-bottom:1rem;padding-top:1rem}.py-8{padding-bottom:2rem;padding-top:2rem}.px-8{padding-left:2rem;padding-right:2rem}.px-3{padding-left:.75rem;padding-right:.75rem}.py-2{padding-bottom:.5rem;padding-top:.5rem}.pt-5{padding-top:1.25rem}.pb-3{padding-bottom:.75rem}.pb-10{padding-bottom:2.5rem}.pt-7{padding-top:1.75rem}.pl-5{padding-left:1.25rem}.text-left{text-align:left}.text-sm{font-size:.875rem;line-height:1.25rem}.text-xs{font-size:.75rem;line-height:1rem}.text-base{font-size:1rem;line-height:1.5rem}.text-4xl{font-size:2.25rem;line-height:2.5rem}.font-bold{font-weight:700}.font-normal{font-weight:400}.tabItem_AM8E,.tabItem_fIhq{font-weight:var(--ifm-font-weight-normal)}.leading-6{line-height:1.5rem}.text-black{--tw-text-opacity:1;color:rgb(0 0 0/var(--tw-text-opacity))}.text-gray-600{--tw-text-opacity:1;color:rgb(75 85 99/var(--tw-text-opacity))}.shadow-md{--tw-shadow:0 4px 6px -1px #0000001a,0 2px 4px -2px #0000001a;--tw-shadow-colored:0 4px 6px -1px var(--tw-shadow-color),0 2px 4px -2px var(--tw-shadow-color);box-shadow:var(--tw-ring-offset-shadow,0 0 #0000),var(--tw-ring-shadow,0 0 #0000),var(--tw-shadow)}.blur{--tw-blur:blur(8px)}.blur,.drop-shadow,.drop-shadow-lg,.filter{filter:var(--tw-blur) var(--tw-brightness) var(--tw-contrast) var(--tw-grayscale) var(--tw-hue-rotate) var(--tw-invert) var(--tw-saturate) var(--tw-sepia) var(--tw-drop-shadow)}.tabArrow_LyoO,.tabArrow_WDKX,.tabArrow_x5p_,.tabArrow_zmvw,.tocCollapsibleButton_TO0P:after{filter:var(--ifm-menu-link-sublist-icon-filter)}.drop-shadow{--tw-drop-shadow:drop-shadow(0 1px 2px #0000001a) drop-shadow(0 1px 1px #0000000f)}.drop-shadow-lg{--tw-drop-shadow:drop-shadow(0 10px 8px #0000000a) drop-shadow(0 4px 3px #0000001a)}.backdrop-filter{-webkit-backdrop-filter:var(--tw-backdrop-blur) var(--tw-backdrop-brightness) var(--tw-backdrop-contrast) var(--tw-backdrop-grayscale) var(--tw-backdrop-hue-rotate) var(--tw-backdrop-invert) var(--tw-backdrop-opacity) var(--tw-backdrop-saturate) var(--tw-backdrop-sepia);backdrop-filter:var(--tw-backdrop-blur) var(--tw-backdrop-brightness) var(--tw-backdrop-contrast) var(--tw-backdrop-grayscale) var(--tw-backdrop-hue-rotate) var(--tw-backdrop-invert) var(--tw-backdrop-opacity) var(--tw-backdrop-saturate) var(--tw-backdrop-sepia)}.transition{transition-duration:.15s;transition-property:color,background-color,border-color,text-decoration-color,fill,stroke,opacity,box-shadow,transform,filter,backdrop-filter,-webkit-backdrop-filter;transition-timing-function:cubic-bezier(.4,0,.2,1)}[data-theme=dark]{--ifm-color-primary-dark:#b4eedd;--ifm-color-primary-darker:#8ae5ca;--ifm-color-primary-darkest:#61dcb7;--ifm-color-primary-light:#27af86;--ifm-color-primary-lighter:#37d2a4;--ifm-color-primary-lightest:#61dcb7;--docusaurus-highlighted-code-line-bg:#0000004d;--openapi-card-background-color:var(--ifm-color-gray-900)!important}a:any-link:hover{text-decoration:none}h1,h2,h3,h4,h5,h6{color:var(--ifm-heading-color);font-family:var(--ifm-heading-font-family);font-weight:var(--ifm-heading-font-weight);line-height:var(--ifm-heading-line-height);margin:var(--ifm-heading-margin-top) 0 var(--ifm-heading-margin-bottom) 0}.markdown ol,.markdown ul,p{line-height:var(--voc-line-height)}h1{font-size:var(--ifm-h1-font-size)}h2{font-size:var(--ifm-h2-font-size)}h3{font-size:var(--ifm-h3-font-size)}h4{font-size:var(--ifm-h4-font-size)}h5{font-size:var(--ifm-h5-font-size)}h6{font-size:var(--ifm-h6-font-size)}p{margin-bottom:25px}ul{list-style-type:disc}ol{list-style-type:decimal}ol ul,ul ul{list-style-type:circle}ol ol,ul ol{list-style-type:lower-latin}li{padding-left:10px}.header-github-link:hover,.header-medium-link:hover,.schemaName_KIS9,.schemaName_MpGo{opacity:.6}.header-medium-link:before{content:"\f37d";font-family:Font Awesome\ 5 Brands;font-size:x-large}.main-wrapper h1[class^=docTitle]{font-size:2.8rem}.imgBanner{border:3px solid #fff;border-radius:12px;max-width:250px;width:250px}.hover\:underline:hover{text-decoration-line:underline}.docItemCol_node_modules-docusaurus-theme-openapi-docs-lib-next-theme-ApiItem-Layout-styles-module .card>h2{overflow:unset;text-overflow:unset;white-space:unset}.breadcrumbs svg,.navbar__item svg,.tags_jXut{display:inline}.api-method>.menu__link{align-items:center;justify-content:start}.api-method>.menu__link:before{border:1px solid #0000;border-radius:.25rem;color:#fff;flex-shrink:0;font-size:12px;font-weight:600;height:20px;line-height:20px;margin-right:var(--ifm-spacing-horizontal);text-align:center;width:50px}.get>.menu__link:before{background-color:#3465a4;content:"get"}.post>.menu__link:before{background-color:var(--openapi-code-green);content:"post"}.delete>.menu__link:before{background-color:var(--openapi-code-red);content:"del"}.put>.menu__link:before{background-color:var(--openapi-code-blue);content:"put"}.patch>.menu__link:before{background-color:var(--openapi-code-orange);content:"patch"}.head>.menu__link:before{background-color:var(--ifm-color-secondary-darkest);content:"head"}.header-github-link:before{background:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat;content:"";display:flex;height:24px;width:24px}html[data-theme=dark] .header-github-link:before{background:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='%23fff' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat}.badge+span{vertical-align:middle}.formItem_node_modules-docusaurus-theme-openapi-docs-lib-next-theme-ApiDemoPanel-FormItem-styles-module>code{padding:5px 8px}.required_node_modules-docusaurus-theme-openapi-docs-lib-next-theme-ApiDemoPanel-FormItem-styles-module{margin-left:8px}.markdown{--ifm-h1-vertical-rhythm-top:3;--ifm-h2-vertical-rhythm-top:2;--ifm-h3-vertical-rhythm-top:1.5;--ifm-heading-vertical-rhythm-top:1.25;--ifm-h1-vertical-rhythm-bottom:1.25;--ifm-heading-vertical-rhythm-bottom:1}.markdown h1:first-child{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-h1-vertical-rhythm-bottom)*var(--ifm-leading));font-size:2.5rem;margin-top:0}.markdown h1{border-top:1px dotted #bbb;margin-top:35px;padding-top:30px}.markdown h2,.markdown h3{padding-top:20px}.markdown h4{padding-top:15px}.markdown ol,.markdown ul{margin:0 0 var(--ifm-paragraph-margin-bottom) 30px}.docusaurus-mermaid-container{margin:50px 10px}.inline-img-container{margin-bottom:var(--ifm-heading-margin-bottom);width:100%}div[class*=" announcementBar"],div[class^=announcementBar]{-webkit-backdrop-filter:blur(12px);backdrop-filter:blur(12px);background:linear-gradient(90deg,#e7ff0000 -.01%,#00ddb3);border-bottom:none;height:-moz-fit-content;height:fit-content;padding:0;text-align:left}div[class*=" announcementBar"] p,div[class^=announcementBar] p{background:linear-gradient(90deg,#00ddb300 -.01%,#ff005d 125%);color:#000;font-size:13px;margin-bottom:0;padding:0 20px}.feedback-wrapper{align-items:center;color:#69757a;display:inline-flex;font-size:1.125rem;margin-bottom:10px;margin-top:10px;padding-bottom:10px;padding-top:10px;position:relative}.feedback-wrapper .confirmation-content,.feedback-wrapper .feedback-button i svg{height:100%;width:100%}.feedback-wrapper .confirmationMessage{display:block;text-align:center;width:100%}.feedback-wrapper .cta-content{align-items:center;display:flex;text-align:center;width:100%}.feedback-wrapper .cta-text{margin-right:1rem}.feedback-wrapper .feedback-options{display:contents;grid-template-columns:1fr;list-style:none;margin:0;padding:0}.feedback-wrapper .feedback-button{align-items:center;background:#e8eced;border:0;border-radius:50%;cursor:pointer;display:flex;height:3rem;justify-content:center;width:3rem}.feedback-wrapper .feedback-button:hover{background:#afb0b0}.feedback-wrapper .feedback-button i{color:#69757a;display:inherit}:root{--ifm-color-primary-dark:#1e8666;--ifm-color-primary-darker:#145c46;--ifm-color-primary-darkest:#0b3226;--ifm-color-primary-light:#007575;--ifm-color-primary-lighter:#00a7a7;--ifm-color-primary-lightest:#00dbdb;--docusaurus-highlighted-code-line-bg:#0000001a;--ifm-background-color:var(--ifm-color-emphasis-0)!important;--ifm-footer-background-color:#0000;--ifm-font-family-monospace:"Fira Code",monospace;--ifm-font-family-base:Manrope,sans-serif;--ifm-code-font-size:90%;--voc-line-height:28px;--ifm-font-size-base:17px;--feedback-component-button-size:3rem;--voc-landing-background-gradient:linear-gradient(90deg,#e7ff0000 -0.01%,#00ddb3);--voc-navbar-landing-background-gradient:linear-gradient(90deg,#e7ff0000 -0.01%,#00ddb3 200%),#ffffff40;--ifm-navbar-shadow:#ffffff80 0px 1px 1px 0px;--ifm-navbar-search-input-background-color:#0000;--ifm-navbar-search-input-color:#000;--ifm-navbar-search-input-placeholder-color:var(--ifm-navbar-search-input-color);font-family:Manrope,sans-serif;--openapi-required:var(--ifm-color-danger);--openapi-deprecated:var(--ifm-color-warning);--openapi-code-blue:var(--ifm-color-info);--openapi-code-red:var(--ifm-color-danger);--openapi-code-orange:var(--ifm-color-warning);--openapi-code-green:var(--ifm-color-success);--openapi-card-background-color:var(--ifm-color-gray-100);--openapi-card-border-radius:var(--ifm-pre-border-radius);--openapi-input-border:var(--ifm-color-primary);--openapi-input-background:var(--openapi-card-background-color);--docusaurus-announcement-bar-height:auto;--docusaurus-collapse-button-bg:#0000;--docusaurus-collapse-button-bg-hover:#0000001a;--doc-sidebar-width:300px;--doc-sidebar-hidden-width:30px;--docusaurus-tag-list-border:var(--ifm-color-emphasis-300);--docsearch-primary-color:#5468ff;--docsearch-text-color:#1c1e21;--docsearch-spacing:12px;--docsearch-icon-stroke-width:1.4;--docsearch-highlight-color:var(--docsearch-primary-color);--docsearch-muted-color:#969faf;--docsearch-container-background:#656c85cc;--docsearch-logo-color:#5468ff;--docsearch-modal-width:560px;--docsearch-modal-height:600px;--docsearch-modal-background:#f5f6f7;--docsearch-modal-shadow:inset 1px 1px 0 0 #ffffff80,0 3px 8px 0 #555a64;--docsearch-searchbox-height:56px;--docsearch-searchbox-background:#ebedf0;--docsearch-searchbox-focus-background:#fff;--docsearch-searchbox-shadow:inset 0 0 0 2px var(--docsearch-primary-color);--docsearch-hit-height:56px;--docsearch-hit-color:#444950;--docsearch-hit-active-color:#fff;--docsearch-hit-background:#fff;--docsearch-hit-shadow:0 1px 3px 0 #d4d9e1;--docsearch-key-gradient:linear-gradient(-225deg,#d5dbe4,#f8f8f8);--docsearch-key-shadow:inset 0 -2px 0 0 #cdcde6,inset 0 0 1px 1px #fff,0 1px 2px 1px #1e235a66;--docsearch-footer-height:44px;--docsearch-footer-background:#fff;--docsearch-footer-shadow:0 -1px 0 0 #e0e3e8,0 -3px 6px 0 #45629b1f;--docsearch-primary-color:var(--ifm-color-primary);--docsearch-text-color:var(--ifm-font-color-base)}.theme-api-markdown div[class^=collapsibleContent]{margin-top:0!important;padding-left:2px}.theme-api-markdown details{--docusaurus-details-decoration-color:var(--ifm-font-color-base);background-color:initial;border:unset!important;box-shadow:unset!important;color:var(--ifm-font-color-base);margin:unset;max-width:600px;padding:unset}.theme-api-markdown details ul{font-size:14px;padding-left:0}.theme-api-markdown details li{list-style:none;padding-bottom:5px;padding-top:5px}.theme-api-markdown details>div>div{border-top:unset!important;padding-top:unset!important}.theme-api-markdown .details__demo-panel{background:var(--openapi-card-background-color);border-radius:var(--openapi-card-border-radius);margin-bottom:1rem}.theme-api-markdown .details__demo-panel>summary{cursor:pointer;padding-left:1rem;padding-top:1rem}.codeBlockTitle_Ktv7+.codeBlockContent_biex .codeBlock_bY9V,.theme-api-markdown .details__demo-panel>div>div>pre{border-top-left-radius:0;border-top-right-radius:0}.theme-api-markdown .details__demo-panel>summary::marker{content:"";display:none}.theme-api-markdown .details__demo-panel>summary::-webkit-details-marker{content:"";display:none}.theme-api-markdown .details__demo-panel>pre{margin-bottom:0;padding-top:0}.theme-api-markdown .details__request-summary>button,.theme-api-markdown .details__response-summary>button{margin-bottom:1rem;margin-right:1rem}.mimeTabsTopSection_wt53,.theme-api-markdown .details__request-summary,.theme-api-markdown .details__response-summary{align-items:center;display:flex;justify-content:space-between}.theme-api-markdown code{max-width:600px}.tocCollapsibleContent_vkbj a,.version-button div{display:block}.version-button div>button>span:after{border-color:currentcolor #0000;border-style:solid;border-width:.4em .4em 0;content:"";display:inline-block;font-size:.8rem;margin-left:.3em;position:relative;top:1px;transform:translateY(-50%)}[class^=paramsItem]:before,[class^=schemaItem]:before{border-bottom:thin solid var(--ifm-color-gray-500);content:"";display:inline-block;height:.5rem;left:0;position:absolute;top:10px;vertical-align:top;width:.7rem}.code__tab--bash:after,.code__tab--csharp:after,.code__tab--go:after,.code__tab--javascript:after,.code__tab--nodejs:after,.code__tab--php:after,.code__tab--python:after,.code__tab--ruby:after{height:28px;margin-block:auto;width:28px;content:""}.schemaItem{padding:5px 0 5px 1rem}.discriminatorItem,.schemaItem{border-left:thin solid var(--ifm-color-gray-500)!important;list-style:none;margin:0!important;position:relative}.discriminatorItem{padding:5px 0!important}.code__tab--go,.code__tab--python{padding-left:1.4rem;padding-right:1.4rem}.code__tab--python:after{background:url(https://raw.githubusercontent.com/devicons/devicon/master/icons/python/python-original.svg)}.code__tab--python{color:var(--ifm-color-success)}.code__tab--python.tabs__item--active{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-color-success)}.code__tab--go:after{background:url(https://raw.githubusercontent.com/devicons/devicon/master/icons/go/go-original-wordmark.svg)}.code__tab--go{color:var(--ifm-color-info)}.code__tab--go.tabs__item--active{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-color-info)}.code__tab--javascript:after{background:url(https://raw.githubusercontent.com/devicons/devicon/master/icons/javascript/javascript-original.svg)}.code__tab--javascript{color:var(--ifm-color-warning);padding-left:1.4rem;padding-right:1.4rem}.code__tab--bash,.code__tab--ruby{color:var(--ifm-color-danger);padding-left:1.4rem;padding-right:1.4rem}.code__tab--javascript.tabs__item--active{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-color-warning)}.code__tab--bash:after{background:url(https://raw.githubusercontent.com/devicons/devicon/master/icons/linux/linux-original.svg)}.code__tab--bash.tabs__item--active{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-color-danger)}.code__tab--ruby:after{background:url(https://raw.githubusercontent.com/devicons/devicon/master/icons/ruby/ruby-plain.svg)}.code__tab--ruby.tabs__item--active{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-color-danger)}.code__tab--csharp:after{background:url(https://raw.githubusercontent.com/devicons/devicon/master/icons/csharp/csharp-original.svg)}.code__tab--csharp{color:var(--ifm-color-gray-500);padding-left:1.4rem;padding-right:1.4rem}.code__tab--csharp.tabs__item--active{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-color-gray-500)}.code__tab--nodejs:after{background:url(https://raw.githubusercontent.com/devicons/devicon/master/icons/nodejs/nodejs-original.svg)}.code__tab--nodejs{color:var(--ifm-color-success);padding-left:1.4rem;padding-right:1.4rem}.code__tab--nodejs.tabs__item--active{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-color-success)}.code__tab--php:after{background:url(https://raw.githubusercontent.com/devicons/devicon/master/icons/php/php-original.svg)}.code__tab--php{color:var(--ifm-color-gray-500);padding-left:1.4rem;padding-right:1.4rem}.code__tab--php.tabs__item--active{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-color-gray-500)}.prism-code.language-json{white-space:pre!important}.buttonDelete_vlNf:focus,.buttonGroup_SdX7 button:focus,.buttonThin_xRd9:focus,body:not(.navigation-with-keyboard) :not(input):focus{outline:0}.skipToContent_fXgn{background-color:var(--ifm-background-surface-color);color:var(--ifm-color-emphasis-900);left:100%;padding:calc(var(--ifm-global-spacing)/2) var(--ifm-global-spacing);position:fixed;top:1rem;z-index:calc(var(--ifm-z-index-fixed) + 1)}.skipToContent_fXgn:focus{box-shadow:var(--ifm-global-shadow-md);left:1rem}.closeButton_CVFx{line-height:0;padding:0}.content_knG7{font-size:85%;padding:5px 0;text-align:center}.content_knG7 a{color:inherit;text-decoration:underline}.DocSearch-Container a,.tag_zVej:hover{text-decoration:none}.announcementBar_mb4j{align-items:center;background-color:var(--ifm-color-white);border-bottom:1px solid var(--ifm-color-emphasis-100);color:var(--ifm-color-black);display:flex;height:var(--docusaurus-announcement-bar-height)}.announcementBarPlaceholder_vyr4{flex:0 0 10px}.announcementBarClose_gvF7{align-self:stretch;flex:0 0 30px}.toggle_vylO{height:2rem;width:2rem}.toggleButton_gllP{align-items:center;border-radius:50%;display:flex;height:100%;justify-content:center;transition:background var(--ifm-transition-fast);width:100%}.toggleButton_gllP:hover{background:var(--ifm-color-emphasis-200)}.toggleButtonDisabled_aARS{cursor:not-allowed}[data-theme=dark] .themedImage--dark_i4oU,[data-theme=light] .themedImage--light_HNdA{display:initial}.iconExternalLink_2l9O{margin-left:.3rem}.iconLanguage_nlXk{margin-right:5px;vertical-align:text-bottom}.navbarHideable_m1mJ{transition:transform var(--ifm-transition-fast) ease}.navbarHidden_jGov{transform:translate3d(0,calc(-100% - 2px),0)}.footerLogoLink_BH7S{opacity:.5;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.footerLogoLink_BH7S:hover,.hash-link:focus,:hover>.hash-link{opacity:1}.mainWrapper_z2l0{flex:1 0 auto}.docusaurus-mt-lg{margin-top:3rem}#__docusaurus{display:flex;flex-direction:column;min-height:100%}.tabItem_fIhq{align-items:center;border:1px solid var(--ifm-color-primary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-primary);display:flex;height:2.5rem;justify-content:center;margin-right:.5rem;margin-top:0!important}.tabItem_VIbn:not(.discriminatorTabActive_wwM1),.tabItem_es3Q:not(.schemaTabActive_dWHR),.tabItem_fIhq:not(.responseTabActive_5Lhs){opacity:.65}.tabItem_VIbn:hover,.tabItem_es3Q:hover,.tabItem_fIhq:hover{background-color:var(--ifm-color-emphasis-100);opacity:1}.responseTabsTopSection_jEoq{align-items:center;display:flex;justify-content:space-between;margin-top:2rem}.responseTabsContainer_XEhZ{align-items:center;display:flex;max-width:390px;overflow:hidden;padding-left:1rem}.discriminatorTabsListContainer_Nnai,.responseTabsListContainer_itgM{overflow-x:scroll;overflow-y:hidden;padding:0 .25rem;scroll-behavior:smooth}.responseTabsListContainer_itgM::-webkit-scrollbar{display:none}.mimeTabDot_NO24,.responseTabDot_mwcE{border-radius:50%;height:12.5px;margin-right:5px;width:12.5px}.mimeTabDotSuccess_M1bZ,.responseTabDotSuccess_PzA9{background-color:var(--ifm-color-success)}.mimeTabDotDanger_NBeV,.responseTabDotDanger_S1vm{background-color:var(--ifm-color-danger)}.mimeTabDotInfo_R3vj,.responseTabDotInfo_iyT3{background-color:var(--ifm-color-info)}.responseTabActive_5Lhs,.schemaTabActive_dWHR,.tabItem_AM8E:active,.tabItem_VIbn.discriminatorTabActive_wwM1{background-color:var(--ifm-color-emphasis-100)}.mimeSchemaContainer_yYbZ,.responseSchemaContainer_Sp_v{max-width:600px}.tabArrow_LyoO,.tabArrow_x5p_{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;border:none;content:"";height:1.25rem;min-width:1.25rem;width:1.25rem}.tabArrowLeft_Cztf,.tabArrowLeft_RQtH,.tabArrowLeft_RzDG,.tabArrowLeft_woLb{transform:rotate(270deg)}.tabItem_AM8E{align-items:center;display:flex;font-size:12px;height:2rem;justify-content:center;margin-right:.5rem;margin-top:0!important}.mimeTabsContainer_gZbZ{align-items:center;display:flex;max-width:390px;overflow:hidden}.mimeTabsListContainer_LPoX,.schemaTabsListContainer_wmy4{overflow-x:scroll;overflow-y:hidden;scroll-behavior:smooth}.mimeTabsListContainer_LPoX::-webkit-scrollbar{display:none}.mimeTabActive_nq7U{background-color:var(--ifm-color-emphasis-100);border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}.cardContainer_fWXF,.cardContainer_p3e_{--ifm-link-color:var(--ifm-color-emphasis-800);--ifm-link-hover-color:var(--ifm-color-emphasis-700);--ifm-link-hover-decoration:none;border:1px solid var(--ifm-color-emphasis-200);box-shadow:0 1.5px 3px 0 #00000026;transition:all var(--ifm-transition-fast) ease;transition-property:border,box-shadow}.cardContainer_fWXF:hover,.cardContainer_p3e_:hover{border-color:var(--ifm-color-primary);box-shadow:0 3px 6px 0 #0003}.cardTitle_HnZ_,.cardTitle_rnsV{font-size:1.2rem}.cardDescription_DHsZ,.cardDescription_PWke{font-size:.8rem}.searchQueryInput_u2C7,.searchVersionInput_m0Ui{background:var(--docsearch-searchbox-focus-background);border:2px solid var(--ifm-toc-border-color);border-radius:var(--ifm-global-radius);color:var(--docsearch-text-color);font:var(--ifm-font-size-base) var(--ifm-font-family-base);margin-bottom:.5rem;padding:.8rem;transition:border var(--ifm-transition-fast) ease;width:100%}.searchQueryInput_u2C7:focus,.searchVersionInput_m0Ui:focus{border-color:var(--docsearch-primary-color);outline:0}.searchQueryInput_u2C7::placeholder{color:var(--docsearch-muted-color)}.searchResultsColumn_JPFH{font-size:.9rem;font-weight:700}.algoliaLogo_rT1R{max-width:150px}.algoliaLogoPathFill_WdUC{fill:var(--ifm-font-color-base)}.searchResultItem_Tv2o{border-bottom:1px solid var(--ifm-toc-border-color);padding:1rem 0}.searchResultItemHeading_KbCB{font-weight:400;margin-bottom:0}.searchResultItemPath_lhe1{--ifm-breadcrumb-separator-size-multiplier:1;color:var(--ifm-color-content-secondary);font-size:.8rem}.searchResultItemSummary_AEaO{font-style:italic;margin:.5rem 0 0}.loadingSpinner_XVxU{animation:1s linear infinite a;border:.4em solid #eee;border-radius:50%;border-top:.4em solid var(--ifm-color-primary);height:3rem;margin:0 auto;width:3rem}.paramsItem_PKlE,.schemaItem_P8yX{border-left:thin solid var(--ifm-color-gray-500)!important}@keyframes a{to{transform:rotate(1turn)}}.loader_vvXV,.responseSamplesContainer_ITGy{margin-top:2rem}.search-result-match{background:#ffd78e40;color:var(--docsearch-hit-color);padding:.09em 0}.backToTopButton_sjWU{background-color:var(--ifm-color-emphasis-200);border-radius:50%;bottom:1.3rem;box-shadow:var(--ifm-global-shadow-lw);height:3rem;opacity:0;position:fixed;right:1.3rem;transform:scale(0);transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);visibility:hidden;width:3rem;z-index:calc(var(--ifm-z-index-fixed) - 1)}.backToTopButton_sjWU:after{background-color:var(--ifm-color-emphasis-1000);content:" ";display:inline-block;height:100%;-webkit-mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;width:100%}.backToTopButtonShow_xfvO{opacity:1;transform:scale(1);visibility:visible}[data-theme=dark]:root{--docusaurus-collapse-button-bg:#ffffff0d;--docusaurus-collapse-button-bg-hover:#ffffff1a}.collapseSidebarButton_PEFL,.docSidebarContainer_b6E3,.sidebarLogo_isFc{display:none}.docMainContainer_gTbr,.docPage__5DB{display:flex;width:100%}.breadcrumbsContainer_Z_bl{--ifm-breadcrumb-size-multiplier:0.8;margin-bottom:.8rem}.codeBlockContainer_Ckt0,.playgroundContainer_X_Ta{margin-bottom:var(--ifm-leading);box-shadow:var(--ifm-global-shadow-lw)}.breadcrumbHomeIcon_OVgt{height:1.1rem;position:relative;top:1px;vertical-align:top;width:1.1rem}.anchorWithStickyNavbar_LWe7{scroll-margin-top:calc(var(--ifm-navbar-height) + .5rem)}.anchorWithHideOnScrollNavbar_WYt5{scroll-margin-top:.5rem}.hash-link{opacity:0;padding-left:.5rem;transition:opacity var(--ifm-transition-fast);-webkit-user-select:none;user-select:none}.hash-link:before{content:"#"}.playgroundContainer_X_Ta{border-radius:var(--ifm-global-radius);overflow:hidden}.playgroundHeader_dyrN,.playgroundHeader_yAq7{background:var(--ifm-color-emphasis-200);color:var(--ifm-color-content);font-size:var(--ifm-code-font-size);font-weight:700;letter-spacing:.08rem;padding:.75rem;text-transform:uppercase}.playgroundHeader_dyrN:first-of-type,.playgroundHeader_yAq7:first-of-type{background:var(--ifm-color-emphasis-600);color:var(--ifm-color-content-inverse)}.playgroundEditor_Q6Y7,.playgroundEditor_nWOY{direction:ltr;font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace)!important}.playgroundPreview_DzOI,.playgroundPreview_iGtG{background-color:var(--ifm-pre-background);padding:1rem}.buttonGroup__atx button,.codeBlockContainer_Ckt0{background:var(--prism-background-color);color:var(--prism-color)}.codeBlockContainer_Ckt0{border-radius:var(--ifm-code-border-radius)}.codeBlockContent_biex{border-radius:inherit;direction:ltr;position:relative}.codeBlockTitle_Ktv7{border-bottom:1px solid var(--ifm-color-emphasis-300);border-top-left-radius:inherit;border-top-right-radius:inherit;font-size:var(--ifm-code-font-size);font-weight:500;padding:.75rem var(--ifm-pre-padding)}.codeBlock_bY9V{--ifm-pre-background:var(--prism-background-color);margin:0;padding:0}.codeBlockLines_e6Vv{float:left;font:inherit;min-width:100%;padding:var(--ifm-pre-padding)}.deprecated_K3O1,.paramsRequired_UKPH,.required_Wlqr,.required_cVzG{font-size:var(--ifm-code-font-size)}.codeBlockLinesWithNumbering_o6Pm{display:table;padding:var(--ifm-pre-padding) 0}.buttonGroup__atx{column-gap:.2rem;display:flex;position:absolute;right:calc(var(--ifm-pre-padding)/2);top:calc(var(--ifm-pre-padding)/2)}.buttonGroup__atx button{align-items:center;border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-global-radius);display:flex;line-height:0;opacity:0;padding:.4rem;transition:opacity .2s ease-in-out}.buttonGroup__atx button:focus-visible,.buttonGroup__atx button:hover{opacity:1!important}.theme-code-block:hover .buttonGroup__atx button{opacity:.4}:where(:root){--docusaurus-highlighted-code-line-bg:#484d5b}:where([data-theme=dark]){--docusaurus-highlighted-code-line-bg:#646464}.theme-code-block-highlighted-line{background-color:var(--docusaurus-highlighted-code-line-bg);display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}.codeLine_lJS_{counter-increment:a;display:table-row}.codeLineNumber_Tfdd{background:var(--ifm-pre-background);display:table-cell;left:0;overflow-wrap:normal;padding:0 var(--ifm-pre-padding);position:sticky;text-align:right;width:1%}.codeLineNumber_Tfdd:before{content:counter(a);opacity:.4}.codeLineContent_feaV{padding-right:var(--ifm-pre-padding)}.theme-code-block:hover .copyButtonCopied_obH4{opacity:1!important}.copyButtonIcons_eSgA{height:1.125rem;position:relative;width:1.125rem}.copyButtonIcon_y97N,.copyButtonSuccessIcon_LjdS{fill:currentColor;height:inherit;left:0;opacity:inherit;position:absolute;top:0;transition:.15s;width:inherit}.copyButtonSuccessIcon_LjdS{color:#00d600;left:50%;opacity:0;top:50%;transform:translate(-50%,-50%) scale(.33)}.copyButtonCopied_obH4 .copyButtonIcon_y97N{opacity:0;transform:scale(.33)}.copyButtonCopied_obH4 .copyButtonSuccessIcon_LjdS{opacity:1;transform:translate(-50%,-50%) scale(1);transition-delay:75ms}.wordWrapButtonIcon_Bwma{height:1.2rem;width:1.2rem}.paramsItem_PKlE{margin:0 0 0 1rem!important;margin-top:unset!important;padding-left:1rem;position:relative}.paramsRequired_UKPH,.required_cVzG{color:var(--openapi-required)}.schemaItem_P8yX{list-style:none;margin:0!important;padding:5px 0 5px 1rem;position:relative}.required_Wlqr{color:var(--openapi-required)}.deprecated_K3O1{color:var(--openapi-deprecated)}.strikethrough_nBFj{text-decoration:line-through}.navbar{background:#fff}.navbar__link{font-weight:var(--ifm-font-weight-bold)}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-color)}.navbar kbd,.navbar__search-input{border:1px solid var(--ifm-navbar-search-input-color)}.navbar kbd{box-shadow:inset 0 -1px 0 var(--ifm-navbar-search-input-color)}.navbar__inner{margin:0 auto}.details_lb9f{--docusaurus-details-summary-arrow-size:0.38rem;--docusaurus-details-transition:transform 200ms ease;--docusaurus-details-decoration-color:grey}.details_lb9f>summary{cursor:pointer;list-style:none;padding-left:1rem;position:relative}.details_lb9f>summary::-webkit-details-marker{display:none}.details_lb9f>summary:before{border-color:#0000 #0000 #0000 var(--docusaurus-details-decoration-color);border-style:solid;border-width:var(--docusaurus-details-summary-arrow-size);content:"";left:0;position:absolute;top:.45rem;transform:rotate(0);transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transition:var(--docusaurus-details-transition)}.collapsibleContent_i85q{border-top:1px solid var(--docusaurus-details-decoration-color);margin-top:1rem;padding-top:1rem}.details_b_Ee{--docusaurus-details-decoration-color:var(--ifm-alert-border-color);--docusaurus-details-transition:transform var(--ifm-transition-fast) ease;border:1px solid var(--ifm-alert-border-color);margin:0 0 var(--ifm-spacing-vertical)}.containsTaskList_mC6p{list-style:none}.img_ev3q{height:auto}.admonition_LlT9{margin-bottom:1em}.admonitionHeading_tbUL{font:var(--ifm-heading-font-weight) var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.3rem}.admonitionIcon_kALy{display:inline-block;margin-right:.4em;vertical-align:middle}.admonitionIcon_kALy svg{fill:var(--ifm-alert-foreground-color);display:inline-block;height:1.6em;width:1.6em}.container_lyt7,.container_lyt7>svg{max-width:100%}.iconEdit_Z9Sw{margin-right:.3em;vertical-align:sub}.tag_zVej{border:1px solid var(--docusaurus-tag-list-border);transition:border var(--ifm-transition-fast)}.tag_zVej:hover{--docusaurus-tag-list-border:var(--ifm-link-color)}.tagRegular_sFm0{border-radius:var(--ifm-global-radius);font-size:90%;padding:.2rem .5rem .3rem}.tagWithCount_h2kH{align-items:center;border-left:0;display:flex;padding:0 .5rem 0 1rem;position:relative}.tagWithCount_h2kH:after,.tagWithCount_h2kH:before{border:1px solid var(--docusaurus-tag-list-border);content:"";position:absolute;top:50%;transition:inherit}.tagWithCount_h2kH:before{border-bottom:0;border-right:0;height:1.18rem;right:100%;transform:translate(50%,-50%) rotate(-45deg);width:1.18rem}.tagWithCount_h2kH:after{border-radius:50%;height:.5rem;left:0;transform:translateY(-50%);width:.5rem}.tagWithCount_h2kH span{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.7rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.tag_QGVx{display:inline-block;margin:0 .4rem .5rem 0}.lastUpdated_vwxv{font-size:smaller;font-style:italic;margin-top:.2rem}.tableOfContents_bqdL{max-height:calc(100vh - var(--ifm-navbar-height) - 2rem);overflow-y:auto;position:sticky;top:calc(var(--ifm-navbar-height) + 1rem)}.tocCollapsibleButton_TO0P{align-items:center;display:flex;font-size:inherit;justify-content:space-between;padding:.4rem .8rem;width:100%}.tocCollapsibleButton_TO0P:after{background:var(--ifm-menu-link-sublist-icon) 50% 50%/2rem 2rem no-repeat;content:"";height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast);width:1.25rem}.tocCollapsibleButtonExpanded_MG3E:after,.tocCollapsibleExpanded_sAul{transform:none}.tocCollapsible_ETCw{background-color:var(--ifm-menu-color-background-active);border-radius:var(--ifm-global-radius);margin:1rem 0}.tocCollapsibleContent_vkbj>ul{border-left:none;border-top:1px solid var(--ifm-color-emphasis-300);font-size:15px;padding:.2rem 0}.tocCollapsibleContent_vkbj ul li{margin:.4rem .8rem}.code__tabs_vqEd{display:table-row-group}.buttonGroup_SdX7{background:var(--openapi-card-background-color);border-radius:var(--openapi-card-border-radius) var(--openapi-card-border-radius) 2px 2px;color:var(--ifm-pre-color);display:flex;font-family:var(--ifm-font-family-monospace);justify-content:flex-end;margin-bottom:1px;margin-top:0}.buttonGroup_SdX7 button{--margin:0.25rem;-webkit-appearance:none;appearance:none;background:#0000;border:0 solid #0000;border-radius:calc(var(--margin));color:var(--ifm-menu-color);cursor:pointer;display:block;font-size:13.3333px;font-weight:var(--ifm-font-weight-semibold);line-height:var(--ifm-pre-line-height);margin:var(--margin);margin-right:0;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;transition:color var(--ifm-button-transition-duration) cubic-bezier(.08,.52,.52,1),background var(--ifm-button-transition-duration) cubic-bezier(.08,.52,.52,1),border-color var(--ifm-button-transition-duration) cubic-bezier(.08,.52,.52,1);-webkit-user-select:none;user-select:none;white-space:nowrap;width:100%}.buttonDelete_vlNf,.showMoreButton_ZGo2{cursor:pointer;-webkit-user-select:none}.buttonGroup_SdX7 button:last-child{margin-right:.25rem}.buttonGroup_SdX7 button.selected_VHjy{color:var(--ifm-menu-color-active)}.formItem_WgRa{margin-top:var(--ifm-pre-padding)}.inputBase_a3Vd,.inputBase_kdtO,.inputBase_p1em,html[data-theme=dark] .selectInput__VTP{border:none;margin-top:calc(var(--ifm-pre-padding)/2);background-color:var(--openapi-input-background);font-size:var(--ifm-code-font-size);width:100%;color:var(--ifm-pre-color);outline:0}.inputBase_kdtO{padding:12px 48px 12px var(--ifm-pre-padding)}.inputBase_kdtO,html[data-theme=dark] .selectInput__VTP{border-radius:4px}html[data-theme=dark] .selectInput__VTP{background-image:url('data:image/svg+xml;charset=US-ASCII,')}.selectInput__VTP,html[data-theme=dark] .selectInput__VTP{-webkit-appearance:none;appearance:none;background-position:right var(--ifm-pre-padding) top 50%;background-repeat:no-repeat;background-size:initial}.selectInput__VTP{background-image:url('data:image/svg+xml;charset=US-ASCII,')}.buttonDelete_vlNf:active,.input_CV2d:focus,.input_Ru3N:focus,.selectInput__VTP:focus{box-shadow:inset 0 0 0 2px var(--openapi-input-border)}.inputBase_a3Vd,.inputBase_p1em{border-radius:4px;padding:12px var(--ifm-pre-padding)}.floatingButton_oJlZ{position:relative}.floatingButton_oJlZ button{background:var(--ifm-color-emphasis-900);border:none;border-radius:var(--ifm-global-radius);color:var(--ifm-color-emphasis-100);cursor:pointer;opacity:0;padding:.4rem .5rem;position:absolute;right:calc(var(--ifm-pre-padding)/2);transition:opacity .2s ease-in-out,visibility .2s ease-in-out,bottom .2s ease-in-out;visibility:hidden}.floatingButton_oJlZ button:focus-visible,.floatingButton_oJlZ:focus-visible button,.floatingButton_oJlZ:hover button{opacity:1;visibility:visible}.dropzone_Y7D0{border:2px dashed var(--openapi-monaco-border-color)}.dropzoneHover_IkP6,.dropzone_Y7D0{align-items:center;background-color:var(--openapi-input-background);border-radius:4px;cursor:pointer;display:inline-flex;font-size:var(--ifm-code-font-size);justify-content:center;padding:var(--ifm-pre-padding);width:100%}.dropzoneHover_IkP6,.dropzone_Y7D0:hover{background:linear-gradient(var(--openapi-dropzone-hover-shim),var(--openapi-dropzone-hover-shim)),linear-gradient(var(--ifm-color-primary),var(--ifm-color-primary));border:2px dashed var(--ifm-color-primary)}.dropzoneContent_CEnm{align-items:center;color:var(--openapi-dropzone-color);display:flex;flex-wrap:wrap;justify-content:center;margin:var(--ifm-pre-padding) 0}.dropzone_Y7D0:hover .dropzoneContent_CEnm{color:var(--ifm-pre-color)}.dropzoneHover_IkP6 .dropzoneContent_CEnm{align-items:center;color:var(--ifm-pre-color);display:flex;flex-wrap:wrap;justify-content:center;margin:var(--ifm-pre-padding) 0}.discriminatorTabsTopSection_QeEp+hr,.schemaTabsTopSection_sc6Y+hr{display:none}.filename_FaIo{flex:1;margin:0 calc(var(--ifm-pre-padding)*1.5);overflow:hidden;text-overflow:ellipsis}.playgroundContainer_l4rC{border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-lw);margin-bottom:var(--ifm-leading);margin-top:1rem;max-height:500px;overflow:auto}.tabItem_VIbn,.tabItem_es3Q{align-items:center;border:1px solid var(--ifm-color-primary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-primary);display:flex;font-size:12px;height:1.8rem;justify-content:center;margin-right:.5rem;margin-top:0!important}.schemaTabsTopSection_sc6Y{align-items:center;display:flex;justify-content:space-between;margin-top:1rem}.schemaTabsListContainer_wmy4::-webkit-scrollbar{display:none}.schemaTabsContainer_HVyG{align-items:center;display:flex;max-width:600px;overflow:hidden}.tabArrow_WDKX,.tabArrow_zmvw{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;border:none;content:"";height:1.25rem;min-width:1.25rem;padding:0 .75rem;width:1.25rem}.inputBase_MRMh,.showMoreButton_ZGo2{font-size:var(--ifm-code-font-size);width:100%}.discriminatorTabsTopSection_QeEp{align-items:center;display:flex;justify-content:space-between;margin-left:.9rem;margin-top:1rem}.discriminatorTabsContainer_FMrl{align-items:center;display:flex;overflow:hidden;padding-left:3px;max-width:600px}.discriminatorTabsListContainer_Nnai::-webkit-scrollbar{display:none}.inputBase_MRMh{background-color:var(--openapi-input-background);border:2px solid #0000;border-radius:4px;color:var(--ifm-pre-color);margin-top:calc(var(--ifm-pre-padding)/2);outline:0;padding:12px var(--ifm-pre-padding)}.selectInput_xXUj{-webkit-appearance:none;appearance:none}.selectInput_xXUj option{border-radius:.25rem;color:var(--ifm-menu-color);margin:.25rem 0;padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.selectInput_xXUj:focus{border:2px solid var(--openapi-input-border)}.plus_Swon{display:inline-block;margin-right:6px;transform:rotate(0);transform-origin:center;transition:transform .2s}.plusExpanded_WYvI{transform:rotate(45deg)}.showMoreButton_ZGo2{-webkit-appearance:none;appearance:none;background-color:initial;border:0 solid #0000;color:var(--ifm-color-primary);display:block;margin-bottom:0;margin-top:var(--ifm-pre-padding);padding:0;text-align:left;user-select:none}.buttonDelete_vlNf,.buttonThin_xRd9{-webkit-appearance:none;font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:400;line-height:1.5;margin-top:calc(var(--ifm-pre-padding)/2);transition-duration:.1s,.1s,.1s,var(--ifm-button-transition-duration);transition-property:color,background,border-color,box-shadow;transition-timing-function:cubic-bezier(.08,.52,.52,1)}.showMoreButton_ZGo2:hover,.showMoreButton_jDKX:hover{color:var(--ifm-color-primary-hover)}.buttonDelete_vlNf{align-items:center;appearance:none;background-color:var(--openapi-input-background);border:none;border-radius:4px;color:var(--ifm-pre-color);display:flex;justify-content:center;margin-left:4px;outline:0;padding:0 12px;user-select:none;white-space:nowrap}.buttonThin_xRd9,.showMoreButton_jDKX{background-color:initial;-webkit-user-select:none;cursor:pointer;white-space:nowrap}.buttonThin_xRd9{appearance:none;border:1px solid var(--openapi-input-border);border-radius:var(--ifm-pre-border-radius);color:var(--openapi-input-border);display:block;margin-bottom:var(--ifm-pre-padding);padding:3px 60px 3px 12px;user-select:none}.buttonThin_xRd9:hover{background-color:var(--openapi-input-border);color:var(--openapi-inverse-color)}.buttonThin_xRd9:active{box-shadow:inset 0 0 0 1px var(--openapi-input-border),inset 0 0 0 2px var(--openapi-inverse-color)}.showOptions_Gv8N{margin-top:var(--ifm-pre-padding);visibility:visible}.hideOptions_JLDS{display:none;visibility:hidden}.showMoreButton_jDKX{-webkit-appearance:none;appearance:none;border:0 solid #0000;color:var(--ifm-color-primary);display:block;font-size:var(--ifm-code-font-size);margin-bottom:0;margin-top:var(--ifm-pre-padding);padding:0;text-align:left;user-select:none}.optionsPanel_s3ok,.optionsPanel_tfQ6{background:var(--openapi-card-background-color);border-radius:var(--openapi-card-border-radius);color:var(--ifm-pre-color);line-height:var(--ifm-pre-line-height);margin-bottom:var(--ifm-spacing-vertical);margin-top:0;overflow:auto;position:relative}.optionsPanel_s3ok:empty,.optionsPanel_tfQ6:empty{display:none}.optionsPanel_s3ok{padding-top:0!important;padding:var(--ifm-pre-padding)}.DocSearch-Button{align-items:center;background:var(--docsearch-searchbox-background);border:0;border-radius:40px;color:var(--docsearch-muted-color);cursor:pointer;display:flex;font-weight:500;height:36px;justify-content:space-between;padding:0 8px;-webkit-user-select:none;user-select:none}.DocSearch-Button:active,.DocSearch-Button:focus,.DocSearch-Button:hover{background:var(--docsearch-searchbox-focus-background);box-shadow:var(--docsearch-searchbox-shadow);color:var(--docsearch-text-color);outline:0}.DocSearch-Button-Container{align-items:center;display:flex}.DocSearch-Search-Icon{stroke-width:1.6}.DocSearch-Hit-Tree,.DocSearch-Hit-action,.DocSearch-Hit-icon,.DocSearch-Reset{stroke-width:var(--docsearch-icon-stroke-width)}.DocSearch-Button .DocSearch-Search-Icon{color:var(--docsearch-text-color)}.DocSearch-Button-Placeholder{font-size:1rem;padding:0 12px 0 6px}.DocSearch-Input,.DocSearch-Link{-webkit-appearance:none;font:inherit}.DocSearch-Button-Keys{display:flex;min-width:calc(40px + .8em)}.DocSearch-Button-Key{align-items:center;background:var(--docsearch-key-gradient);border:0;border-radius:3px;box-shadow:var(--docsearch-key-shadow);color:var(--docsearch-muted-color);display:flex;height:18px;justify-content:center;margin-right:.4em;padding:0 0 2px;position:relative;top:-1px;width:20px}.DocSearch--active{overflow:hidden!important}.DocSearch-Container{background-color:var(--docsearch-container-background);height:100vh;left:0;position:fixed;top:0;width:100vw;z-index:200}.DocSearch-Link{appearance:none;background:none;border:0;color:var(--docsearch-highlight-color);cursor:pointer;margin:0;padding:0}.DocSearch-Modal{background:var(--docsearch-modal-background);border-radius:6px;box-shadow:var(--docsearch-modal-shadow);flex-direction:column;margin:60px auto auto;max-width:var(--docsearch-modal-width);position:relative}.DocSearch-SearchBar{display:flex;padding:var(--docsearch-spacing) var(--docsearch-spacing) 0}.DocSearch-Form{align-items:center;background:var(--docsearch-searchbox-focus-background);border-radius:4px;box-shadow:var(--docsearch-searchbox-shadow);display:flex;height:var(--docsearch-searchbox-height);margin:0;padding:0 var(--docsearch-spacing);position:relative;width:100%}.DocSearch-Input{appearance:none;background:#0000;border:0;color:var(--docsearch-text-color);flex:1;font-size:1.2em;height:100%;outline:0;padding:0 0 0 8px;width:80%}.DocSearch-Hit-action-button,.DocSearch-Reset{-webkit-appearance:none;border:0;cursor:pointer}.DocSearch-Input::placeholder{color:var(--docsearch-muted-color);opacity:1}.DocSearch-Input::-webkit-search-cancel-button,.DocSearch-Input::-webkit-search-decoration,.DocSearch-Input::-webkit-search-results-button,.DocSearch-Input::-webkit-search-results-decoration{display:none}.DocSearch-LoadingIndicator,.DocSearch-MagnifierLabel,.DocSearch-Reset{margin:0;padding:0}.DocSearch-Container--Stalled .DocSearch-LoadingIndicator,.DocSearch-MagnifierLabel,.DocSearch-Reset{align-items:center;color:var(--docsearch-highlight-color);display:flex;justify-content:center}.DocSearch-Cancel,.DocSearch-Container--Stalled .DocSearch-MagnifierLabel,.DocSearch-LoadingIndicator,.DocSearch-Reset[hidden]{display:none}.DocSearch-Reset{animation:.1s ease-in forwards b;appearance:none;background:none;border-radius:50%;color:var(--docsearch-icon-color);padding:2px;right:0}.DocSearch-Help,.DocSearch-HitsFooter,.DocSearch-Label{color:var(--docsearch-muted-color)}.DocSearch-Reset:focus{outline:0}.DocSearch-Reset:hover{color:var(--docsearch-highlight-color)}.DocSearch-LoadingIndicator svg,.DocSearch-MagnifierLabel svg{height:24px;width:24px}.DocSearch-Dropdown{max-height:calc(var(--docsearch-modal-height) - var(--docsearch-searchbox-height) - var(--docsearch-spacing) - var(--docsearch-footer-height));min-height:var(--docsearch-spacing);overflow-y:auto;overflow-y:overlay;padding:0 var(--docsearch-spacing);scrollbar-color:var(--docsearch-muted-color) var(--docsearch-modal-background);scrollbar-width:thin}.DocSearch-Dropdown::-webkit-scrollbar{width:12px}.DocSearch-Dropdown::-webkit-scrollbar-track{background:#0000}.DocSearch-Dropdown::-webkit-scrollbar-thumb{background-color:var(--docsearch-muted-color);border:3px solid var(--docsearch-modal-background);border-radius:20px}.DocSearch-Dropdown ul{list-style:none;margin:0;padding:0}.DocSearch-Label{font-size:.75em;line-height:1.6em}.DocSearch-Help{font-size:.9em;margin:0;-webkit-user-select:none;user-select:none}.DocSearch-Title{font-size:1.2em}.DocSearch-Logo a{display:flex}.DocSearch-Logo svg{color:var(--docsearch-logo-color);margin-left:8px}.DocSearch-Hits:last-of-type{margin-bottom:24px}.DocSearch-Hits mark{background:none;color:var(--docsearch-highlight-color)}.DocSearch-HitsFooter{display:flex;font-size:.85em;justify-content:center;margin-bottom:var(--docsearch-spacing);padding:var(--docsearch-spacing)}.DocSearch-HitsFooter a{border-bottom:1px solid;color:inherit}.DocSearch-Hit{border-radius:4px;display:flex;padding-bottom:4px;position:relative}.DocSearch-Hit--deleting{opacity:0;transition:.25s linear}.DocSearch-Hit--favoriting{transform:scale(0);transform-origin:top center;transition:.25s linear .25s}.DocSearch-Hit a{background:var(--docsearch-hit-background);border-radius:4px;box-shadow:var(--docsearch-hit-shadow);display:block;padding-left:var(--docsearch-spacing);width:100%}.DocSearch-Hit-source{background:var(--docsearch-modal-background);color:var(--docsearch-highlight-color);font-size:.85em;font-weight:600;line-height:32px;margin:0 -4px;padding:8px 4px 0;position:sticky;top:0;z-index:10}.DocSearch-Hit-Tree{color:var(--docsearch-muted-color);height:var(--docsearch-hit-height);opacity:.5;width:24px}.DocSearch-Hit[aria-selected=true] a{background-color:var(--docsearch-highlight-color)}.DocSearch-Hit[aria-selected=true] mark{text-decoration:underline}.DocSearch-Hit-Container{align-items:center;color:var(--docsearch-hit-color);display:flex;flex-direction:row;height:var(--docsearch-hit-height);padding:0 var(--docsearch-spacing) 0 0}.DocSearch-Hit-icon{height:20px;width:20px}.DocSearch-Hit-action,.DocSearch-Hit-icon{color:var(--docsearch-muted-color)}.DocSearch-Hit-action{align-items:center;display:flex;height:22px;width:22px}.DocSearch-Hit-action svg{display:block;height:18px;width:18px}.DocSearch-Hit-action+.DocSearch-Hit-action{margin-left:6px}.DocSearch-Hit-action-button{appearance:none;background:none;border-radius:50%;color:inherit;padding:2px}svg.DocSearch-Hit-Select-Icon{display:none}.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-Select-Icon{display:block}.DocSearch-Hit-action-button:focus,.DocSearch-Hit-action-button:hover{background:#0003;transition:background-color .1s ease-in}.DocSearch-Hit-action-button:focus path,.DocSearch-Hit-action-button:hover path{fill:#fff}.DocSearch-Hit-content-wrapper{display:flex;flex:1 1 auto;flex-direction:column;font-weight:500;justify-content:center;line-height:1.2em;margin:0 8px;overflow-x:hidden;position:relative;text-overflow:ellipsis;white-space:nowrap;width:80%}.DocSearch-Hit-title{font-size:.9em}.DocSearch-Hit-path{color:var(--docsearch-muted-color);font-size:.75em}.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-Tree,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-action,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-icon,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-path,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-text,.DocSearch-Hit[aria-selected=true] .DocSearch-Hit-title,.DocSearch-Hit[aria-selected=true] mark{color:var(--docsearch-hit-active-color)!important}.DocSearch-ErrorScreen,.DocSearch-NoResults,.DocSearch-StartScreen{font-size:.9em;margin:0 auto;padding:36px 0;text-align:center;width:80%}.DocSearch-Screen-Icon{color:var(--docsearch-muted-color);padding-bottom:12px}.DocSearch-NoResults-Prefill-List{display:inline-block;padding-bottom:24px;text-align:left}.DocSearch-NoResults-Prefill-List ul{display:inline-block;padding:8px 0 0}.DocSearch-NoResults-Prefill-List li{list-style-position:inside;list-style-type:"» "}.DocSearch-Prefill{-webkit-appearance:none;appearance:none;background:none;border:0;border-radius:1em;color:var(--docsearch-highlight-color);cursor:pointer;display:inline-block;font-size:1em;font-weight:700;padding:0}.DocSearch-Prefill:focus,.DocSearch-Prefill:hover{outline:0;text-decoration:underline}.DocSearch-Footer{align-items:center;background:var(--docsearch-footer-background);border-radius:0 0 8px 8px;box-shadow:var(--docsearch-footer-shadow);display:flex;flex-direction:row-reverse;flex-shrink:0;height:var(--docsearch-footer-height);justify-content:space-between;padding:0 var(--docsearch-spacing);position:relative;-webkit-user-select:none;user-select:none;width:100%;z-index:300}.DocSearch-Commands{color:var(--docsearch-muted-color);display:flex;list-style:none;margin:0;padding:0}.DocSearch-Commands li{align-items:center;display:flex}.DocSearch-Commands li:not(:last-of-type){margin-right:.8em}.DocSearch-Commands-Key{align-items:center;background:var(--docsearch-key-gradient);border:0;border-radius:2px;box-shadow:var(--docsearch-key-shadow);color:var(--docsearch-muted-color);display:flex;height:18px;justify-content:center;margin-right:.4em;padding:0 0 1px;width:20px}@keyframes b{0%{opacity:0}to{opacity:1}}.DocSearch-Button{margin:0;transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.DocSearch-Container{z-index:calc(var(--ifm-z-index-fixed) + 1)}@media (min-width:640px){.sm\:flex-row{flex-direction:row}}@media (min-width:768px){.md\:mx-4{margin-left:1rem;margin-right:1rem}.md\:mt-16{margin-top:4rem}.md\:mb-0{margin-bottom:0}.md\:mt-10{margin-top:2.5rem}.md\:grid-cols-3{grid-template-columns:repeat(3,minmax(0,1fr))}.md\:place-content-center{place-content:center}.md\:place-items-center{place-items:center}.md\:justify-between{justify-content:space-between}.md\:gap-1{gap:.25rem}.md\:px-4{padding-left:1rem;padding-right:1rem}.md\:px-10{padding-left:2.5rem;padding-right:2.5rem}.md\:pr-24{padding-right:6rem}.navbar__inner{padding:0 2.5rem}}@media only screen and (min-width:768px) and (max-width:996px){.code__tabs_vqEd{justify-content:space-around}}@media (min-width:997px){.collapseSidebarButton_PEFL,.expandButton_m80_{background-color:var(--docusaurus-collapse-button-bg);position:sticky}.docItemCol,.docItemCol_zY_c{max-width:75%!important}.tocMobile,.tocMobile_ITEo{display:none}:root{--docusaurus-announcement-bar-height:30px}.announcementBarClose_gvF7,.announcementBarPlaceholder_vyr4{flex-basis:50px}.searchBox_ZlJk{padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.collapseSidebarButton_PEFL{border:1px solid var(--ifm-toc-border-color);border-radius:0;bottom:0;display:block!important;height:40px}.collapseSidebarButtonIcon_kv0_{margin-top:4px;transform:rotate(180deg)}.expandButtonIcon_BlDH,[dir=rtl] .collapseSidebarButtonIcon_kv0_{transform:rotate(0)}.collapseSidebarButton_PEFL:focus,.collapseSidebarButton_PEFL:hover,.expandButton_m80_:focus,.expandButton_m80_:hover{background-color:var(--docusaurus-collapse-button-bg-hover)}.menuHtmlItem_M9Kj{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu_SIkG{flex-grow:1;padding:.5rem}@supports (scrollbar-gutter:stable){.menu_SIkG{padding:.5rem 0 .5rem .5rem;scrollbar-gutter:stable}}.menuWithAnnouncementBar_GW3s{margin-bottom:var(--docusaurus-announcement-bar-height)}.sidebar_njMd{display:flex;flex-direction:column;height:100%;max-height:100vh;padding-top:var(--ifm-navbar-height);position:sticky;top:0;transition:opacity 50ms;width:var(--doc-sidebar-width)}.sidebarWithHideableNavbar_wUlq{padding-top:0}.sidebarHidden_VK0M{height:0;opacity:0;overflow:hidden;visibility:hidden}.sidebarLogo_isFc{align-items:center;color:inherit!important;display:flex!important;margin:0 var(--ifm-navbar-padding-horizontal);max-height:var(--ifm-navbar-height);min-height:var(--ifm-navbar-height);text-decoration:none!important}.sidebarLogo_isFc img{height:2rem;margin-right:.5rem}.expandButton_m80_{align-items:center;display:flex;height:100%;justify-content:center;max-height:100vh;top:0;transition:background-color var(--ifm-transition-fast) ease}[dir=rtl] .expandButtonIcon_BlDH{transform:rotate(180deg)}.docSidebarContainer_b6E3{border-right:1px solid var(--ifm-toc-border-color);-webkit-clip-path:inset(0);clip-path:inset(0);display:block;margin-top:calc(var(--ifm-navbar-height)*-1);transition:width var(--ifm-transition-fast) ease;width:var(--doc-sidebar-width);will-change:width}.docSidebarContainerHidden_b3ry{cursor:pointer;width:var(--doc-sidebar-hidden-width)}.docMainContainer_gTbr{flex-grow:1;max-width:calc(100% - var(--doc-sidebar-width))}.docMainContainerEnhanced_Uz_u{max-width:calc(100% - var(--doc-sidebar-hidden-width))}.docItemWrapperEnhanced_czyv{max-width:calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important}.lastUpdated_vwxv{text-align:right}}@media (min-width:1024px){.lg\:mb-8{margin-bottom:2rem}.lg\:h-\[90vh\]{height:90vh}.lg\:h-48{height:12rem}.lg\:w-full{width:100%}.lg\:w-\[500px\]{width:500px}.lg\:flex-1{flex:1 1 0%}.lg\:flex-row{flex-direction:row}.lg\:place-content-center{place-content:center}.lg\:gap-12{gap:3rem}.lg\:whitespace-nowrap{white-space:nowrap}.lg\:pb-24{padding-bottom:6rem}.lg\:pb-12{padding-bottom:3rem}}@media not all and (min-width:1024px){.max-lg\:hidden{display:none}}@media (min-width:1440px){.container{max-width:var(--ifm-container-width-xl)}}@media (max-width:1416px){.main-wrapper{max-width:100%;width:100%}}@media (max-width:1320px) and (min-width:997px){.container{max-width:calc(var(--ifm-container-width) - 125px - var(--ifm-spacing-horizontal)*2)}}@media (max-width:996px){.col{--ifm-col-width:100%;flex-basis:var(--ifm-col-width);margin-left:0}.footer{--ifm-footer-padding-horizontal:0}.colorModeToggle_x44X,.footer__link-separator,.navbar__item,.tableOfContents_bqdL{display:none}.footer__col{margin-bottom:calc(var(--ifm-spacing-vertical)*3)}.footer__link-item{display:block}.hero{padding-left:0;padding-right:0}.navbar>.container,.navbar>.container-fluid{padding:0}.navbar__toggle{display:inherit}.navbar__search-input{width:9rem}.pills--block,.tabs--block{flex-direction:column}.searchBox_ZlJk{position:absolute;right:var(--ifm-navbar-padding-horizontal)}.docItemContainer_F8PC{padding:0 .3rem}}@media only screen and (max-width:996px){.searchQueryColumn_RTkw,.searchResultsColumn_JPFH{max-width:60%!important}.searchLogoColumn_rJIA,.searchVersionColumn_ypXd{max-width:40%!important}.searchLogoColumn_rJIA{padding-left:0!important}}@media (max-width:768px){.DocSearch-Button-Keys,.DocSearch-Button-Placeholder,.DocSearch-Commands,.DocSearch-Hit-Tree{display:none}:root{--docsearch-spacing:10px;--docsearch-footer-height:40px}.DocSearch-Dropdown{height:100%;max-height:calc(var(--docsearch-vh,1vh)*100 - var(--docsearch-searchbox-height) - var(--docsearch-spacing) - var(--docsearch-footer-height))}.DocSearch-Container{height:100vh;height:-webkit-fill-available;height:calc(var(--docsearch-vh,1vh)*100);position:absolute}.DocSearch-Footer{border-radius:0;bottom:0;position:absolute}.DocSearch-Hit-content-wrapper{display:flex;position:relative;width:80%}.DocSearch-Modal{border-radius:0;box-shadow:none;height:100vh;height:-webkit-fill-available;height:calc(var(--docsearch-vh,1vh)*100);margin:0;max-width:100%;width:100%}.DocSearch-Cancel{-webkit-appearance:none;appearance:none;background:none;border:0;color:var(--docsearch-highlight-color);cursor:pointer;display:inline-block;flex:none;font:inherit;font-size:1em;font-weight:500;margin-left:var(--docsearch-spacing);outline:0;overflow:hidden;padding:0;-webkit-user-select:none;user-select:none;white-space:nowrap}}@media (max-width:576px){.markdown h1:first-child{--ifm-h1-font-size:2rem}.markdown>h2{--ifm-h2-font-size:1.5rem}.markdown>h3{--ifm-h3-font-size:1.25rem}}@media screen and (max-width:576px){.searchQueryColumn_RTkw{max-width:100%!important}.searchVersionColumn_ypXd{max-width:100%!important;padding-left:var(--ifm-spacing-horizontal)!important}}@media screen and (max-width:500px){.discriminatorTabsTopSection_QeEp,.mimeTabsTopSection_wt53,.responseTabsTopSection_jEoq,.schemaTabsTopSection_sc6Y{align-items:flex-start;flex-direction:column}.mimeTabsContainer_gZbZ,.responseTabsContainer_XEhZ{margin-top:var(--ifm-spacing-vertical);padding:0;width:100%}.discriminatorTabsContainer_FMrl,.schemaTabsContainer_HVyG{width:100%}.tabItem_VIbn{height:100%}}@media (hover:hover){.backToTopButton_sjWU:hover{background-color:var(--ifm-color-emphasis-300)}}@media (pointer:fine){.thin-scrollbar{scrollbar-width:thin}.thin-scrollbar::-webkit-scrollbar{height:var(--ifm-scrollbar-size);width:var(--ifm-scrollbar-size)}.thin-scrollbar::-webkit-scrollbar-track{background:var(--ifm-scrollbar-track-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb{background:var(--ifm-scrollbar-thumb-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb:hover{background:var(--ifm-scrollbar-thumb-hover-background-color)}}@media screen and (prefers-reduced-motion:reduce){.DocSearch-Reset{stroke-width:var(--docsearch-icon-stroke-width);animation:none;-webkit-appearance:none;appearance:none;background:none;border:0;border-radius:50%;color:var(--docsearch-icon-color);cursor:pointer;right:0}.DocSearch-Hit--deleting,.DocSearch-Hit--favoriting{transition:none}.DocSearch-Hit-action-button:focus,.DocSearch-Hit-action-button:hover{background:#0003;transition:none}}@media print{.announcementBar_mb4j,.footer,.menu,.navbar,.pagination-nav,.table-of-contents,.tocMobile_ITEo{display:none}.tabs{page-break-inside:avoid}.codeBlockLines_e6Vv{white-space:pre-wrap}} \ No newline at end of file diff --git a/assets/js/0032f96f.e6ed8874.js b/assets/js/0032f96f.bf6736e1.js similarity index 66% rename from assets/js/0032f96f.e6ed8874.js rename to assets/js/0032f96f.bf6736e1.js index bfcc3c9d8..e53584a24 100644 --- a/assets/js/0032f96f.e6ed8874.js +++ b/assets/js/0032f96f.bf6736e1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[100],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>m});var r=t(67294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function a(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var s=r.createContext({}),p=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},c=function(e){var n=p(e.components);return r.createElement(s.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},u=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,o=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),u=p(t),m=i,f=u["".concat(s,".").concat(m)]||u[m]||d[m]||o;return t?r.createElement(f,a(a({ref:n},c),{},{components:t})):r.createElement(f,a({ref:n},c))}));function m(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var o=t.length,a=new Array(o);a[0]=u;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l.mdxType="string"==typeof e?e:i,a[1]=l;for(var p=2;p{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var r=t(87462),i=(t(67294),t(3905));const o={},a=void 0,l={unversionedId:"sdk/reference/enums/EnvOptions",id:"sdk/reference/enums/EnvOptions",title:"EnvOptions",description:"@vocdoni/sdk / Exports / EnvOptions",source:"@site/docs/sdk/reference/enums/EnvOptions.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/EnvOptions",permalink:"/sdk/reference/enums/EnvOptions",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ElectionStatusReady",permalink:"/sdk/reference/enums/ElectionStatusReady"},next:{title:"TransactionType",permalink:"/sdk/reference/enums/TransactionType"}},s={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"DEV",id:"dev",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"PROD",id:"prod",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"STG",id:"stg",level:3},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:p};function d(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / EnvOptions"),(0,i.kt)("h1",{id:"enumeration-envoptions"},"Enumeration: EnvOptions"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/EnvOptions#dev"},"DEV")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/EnvOptions#prod"},"PROD")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/EnvOptions#stg"},"STG"))),(0,i.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,i.kt)("h3",{id:"dev"},"DEV"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"DEV")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"dev"')),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L58"},"client.ts:58")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"prod"},"PROD"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"PROD")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"prod"')),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L60"},"client.ts:60")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"stg"},"STG"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"STG")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"stg"')),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L59"},"client.ts:59")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[100],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>m});var r=t(67294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function a(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var s=r.createContext({}),p=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},c=function(e){var n=p(e.components);return r.createElement(s.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},u=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,o=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),u=p(t),m=i,f=u["".concat(s,".").concat(m)]||u[m]||d[m]||o;return t?r.createElement(f,a(a({ref:n},c),{},{components:t})):r.createElement(f,a({ref:n},c))}));function m(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var o=t.length,a=new Array(o);a[0]=u;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l.mdxType="string"==typeof e?e:i,a[1]=l;for(var p=2;p{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var r=t(87462),i=(t(67294),t(3905));const o={},a=void 0,l={unversionedId:"sdk/reference/enums/EnvOptions",id:"sdk/reference/enums/EnvOptions",title:"EnvOptions",description:"@vocdoni/sdk / Exports / EnvOptions",source:"@site/docs/sdk/reference/enums/EnvOptions.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/EnvOptions",permalink:"/sdk/reference/enums/EnvOptions",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ElectionStatusReady",permalink:"/sdk/reference/enums/ElectionStatusReady"},next:{title:"TransactionType",permalink:"/sdk/reference/enums/TransactionType"}},s={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"DEV",id:"dev",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"PROD",id:"prod",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"STG",id:"stg",level:3},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:p};function d(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / EnvOptions"),(0,i.kt)("h1",{id:"enumeration-envoptions"},"Enumeration: EnvOptions"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"EnvOptions#dev"},"DEV")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"EnvOptions#prod"},"PROD")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"EnvOptions#stg"},"STG"))),(0,i.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,i.kt)("h3",{id:"dev"},"DEV"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"DEV")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"dev"')),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L58"},"client.ts:58")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"prod"},"PROD"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"PROD")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"prod"')),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L60"},"client.ts:60")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"stg"},"STG"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"STG")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"stg"')),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L59"},"client.ts:59")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0128e05f.901c3987.js b/assets/js/0128e05f.901c3987.js deleted file mode 100644 index b7e167e99..000000000 --- a/assets/js/0128e05f.901c3987.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2636],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>m});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var d=n.createContext({}),s=function(e){var t=n.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},p=function(e){var t=s(e.components);return n.createElement(d.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),k=s(r),m=a,u=k["".concat(d,".").concat(m)]||k[m]||c[m]||i;return r?n.createElement(u,l(l({ref:t},p),{},{components:r})):n.createElement(u,l({ref:t},p))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=k;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var s=2;s{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>s});var n=r(87462),a=(r(67294),r(3905));const i={},l=void 0,o={unversionedId:"sdk/reference/classes/FileAPI",id:"sdk/reference/classes/FileAPI",title:"FileAPI",description:"@vocdoni/sdk / Exports / FileAPI",source:"@site/docs/sdk/reference/classes/FileAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/FileAPI",permalink:"/sdk/reference/classes/FileAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"FaucetService",permalink:"/sdk/reference/classes/FaucetService"},next:{title:"FileService",permalink:"/sdk/reference/classes/FileService"}},d={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"cid",id:"cid",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4}],p={toc:s};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / FileAPI"),(0,a.kt)("h1",{id:"class-fileapi"},"Class: FileAPI"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"API")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"FileAPI"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FileAPI#constructor"},"constructor"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FileAPI#cid"},"cid")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FileAPI#isapierror"},"isApiError")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FileAPI#isundefinederror"},"isUndefinedError"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new FileAPI"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/FileAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"FileAPI"))),(0,a.kt)("p",null,"Cannot be constructed."),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/FileAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"FileAPI"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"API.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/file.ts#L19"},"api/file.ts:19")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"cid"},"cid"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"cid"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"IFileCIDResponse"),">"),(0,a.kt)("p",null,"CID generator method via API."),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"url")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"payload")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"Full payload string of which we want the CID of")))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"IFileCIDResponse"),">"),(0,a.kt)("p",null,"promised IFileCIDResponse"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/file.ts#L30"},"api/file.ts:30")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isapierror"},"isApiError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"API.isApiError"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L21"},"api/api.ts:21")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"API.isUndefinedError"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L64"},"api/api.ts:64")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0128e05f.bc318884.js b/assets/js/0128e05f.bc318884.js new file mode 100644 index 000000000..a9db5a83f --- /dev/null +++ b/assets/js/0128e05f.bc318884.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2636],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>c});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var d=n.createContext({}),p=function(e){var t=n.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(d.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),m=p(r),c=a,u=m["".concat(d,".").concat(c)]||m[c]||k[c]||i;return r?n.createElement(u,l(l({ref:t},s),{},{components:r})):n.createElement(u,l({ref:t},s))}));function c(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var p=2;p{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var n=r(87462),a=(r(67294),r(3905));const i={},l=void 0,o={unversionedId:"sdk/reference/classes/FileAPI",id:"sdk/reference/classes/FileAPI",title:"FileAPI",description:"@vocdoni/sdk / Exports / FileAPI",source:"@site/docs/sdk/reference/classes/FileAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/FileAPI",permalink:"/sdk/reference/classes/FileAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"FaucetService",permalink:"/sdk/reference/classes/FaucetService"},next:{title:"FileService",permalink:"/sdk/reference/classes/FileService"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"cid",id:"cid",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4}],s={toc:p};function k(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / FileAPI"),(0,a.kt)("h1",{id:"class-fileapi"},"Class: FileAPI"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"API")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"FileAPI"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"FileAPI#constructor"},"constructor"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"FileAPI#cid"},"cid")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"FileAPI#isapierror"},"isApiError")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"FileAPI#isundefinederror"},"isUndefinedError"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new FileAPI"),"(): ",(0,a.kt)("a",{parentName:"p",href:"FileAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"FileAPI"))),(0,a.kt)("p",null,"Cannot be constructed."),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"FileAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"FileAPI"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"API.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/file.ts#L19"},"api/file.ts:19")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"cid"},"cid"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"cid"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"IFileCIDResponse"),">"),(0,a.kt)("p",null,"CID generator method via API."),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"url")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"payload")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"Full payload string of which we want the CID of")))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"IFileCIDResponse"),">"),(0,a.kt)("p",null,"promised IFileCIDResponse"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/file.ts#L30"},"api/file.ts:30")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isapierror"},"isApiError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"API.isApiError"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L21"},"api/api.ts:21")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"API.isUndefinedError"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L64"},"api/api.ts:64")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/03c6674d.a80b6518.js b/assets/js/03c6674d.a80b6518.js deleted file mode 100644 index a813b67c5..000000000 --- a/assets/js/03c6674d.a80b6518.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4720],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>c});var i=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=i.createContext({}),s=function(e){var t=i.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},o=function(e){var t=s(e.components);return i.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},u=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,p=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),u=s(n),c=a,m=u["".concat(p,".").concat(c)]||u[c]||k[c]||r;return n?i.createElement(m,l(l({ref:t},o),{},{components:n})):i.createElement(m,l({ref:t},o))}));function c(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,l=new Array(r);l[0]=u;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:a,l[1]=d;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>k,frontMatter:()=>r,metadata:()=>d,toc:()=>s});var i=n(87462),a=(n(67294),n(3905));const r={},l=void 0,d={unversionedId:"sdk/reference/classes/MultiChoiceElection",id:"sdk/reference/classes/MultiChoiceElection",title:"MultiChoiceElection",description:"@vocdoni/sdk / Exports / MultiChoiceElection",source:"@site/docs/sdk/reference/classes/MultiChoiceElection.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/MultiChoiceElection",permalink:"/sdk/reference/classes/MultiChoiceElection",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"InvalidElection",permalink:"/sdk/reference/classes/InvalidElection"},next:{title:"OffchainCensus",permalink:"/sdk/reference/classes/OffchainCensus"}},p={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_addSDKVersion",id:"_addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_canAbstain",id:"_canabstain",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"_census",id:"_census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"_description",id:"_description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"_electionType",id:"_electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"_endDate",id:"_enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"_header",id:"_header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"_maxCensusSize",id:"_maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"_meta",id:"_meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"_questions",id:"_questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"_startDate",id:"_startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"_streamUri",id:"_streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"_temporarySecretIdentity",id:"_temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"_title",id:"_title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"_voteType",id:"_votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"canAbstain",id:"canabstain",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"canRepeatChoices",id:"canrepeatchoices",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"census",id:"census",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"description",id:"description",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"duration",id:"duration",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"endDate",id:"enddate",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"header",id:"header",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-25",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-26",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-27",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-28",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"maxNumberOfChoices",id:"maxnumberofchoices",level:3},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"meta",id:"meta",level:3},{value:"Returns",id:"returns-22",level:4},{value:"Inherited from",id:"inherited-from-29",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Inherited from",id:"inherited-from-30",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"questions",id:"questions",level:3},{value:"Returns",id:"returns-24",level:4},{value:"Inherited from",id:"inherited-from-31",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Inherited from",id:"inherited-from-32",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"startDate",id:"startdate",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Inherited from",id:"inherited-from-33",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Inherited from",id:"inherited-from-34",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Returns",id:"returns-28",level:4},{value:"Inherited from",id:"inherited-from-35",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Inherited from",id:"inherited-from-36",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Returns",id:"returns-30",level:4},{value:"Inherited from",id:"inherited-from-37",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Inherited from",id:"inherited-from-38",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"title",id:"title",level:3},{value:"Returns",id:"returns-32",level:4},{value:"Inherited from",id:"inherited-from-39",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Inherited from",id:"inherited-from-40",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"voteType",id:"votetype",level:3},{value:"Returns",id:"returns-34",level:4},{value:"Inherited from",id:"inherited-from-41",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Inherited from",id:"inherited-from-42",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"Methods",id:"methods-1",level:2},{value:"addQuestion",id:"addquestion",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"generateEnvelopeType",id:"generateenvelopetype",level:3},{value:"Returns",id:"returns-37",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"generateMetadata",id:"generatemetadata",level:3},{value:"Returns",id:"returns-38",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"generateMode",id:"generatemode",level:3},{value:"Returns",id:"returns-39",level:4},{value:"Inherited from",id:"inherited-from-43",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"generateVoteOptions",id:"generatevoteoptions",level:3},{value:"Returns",id:"returns-40",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-41",level:4},{value:"Inherited from",id:"inherited-from-44",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"removeQuestion",id:"removequestion",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-42",level:4},{value:"Inherited from",id:"inherited-from-45",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"checkVote",id:"checkvote",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-43",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"from",id:"from",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-44",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-59",level:4}],o={toc:s};function k(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / MultiChoiceElection"),(0,a.kt)("h1",{id:"class-multichoiceelection"},"Class: MultiChoiceElection"),(0,a.kt)("p",null,"Represents a multi choice election"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"MultiChoiceElection"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_addsdkversion"},"_","addSDKVersion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_canabstain"},"_","canAbstain")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_census"},"_","census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_description"},"_","description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_electiontype"},"_","electionType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_enddate"},"_","endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_header"},"_","header")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_maxcensussize"},"_","maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_meta"},"_","meta")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_questions"},"_","questions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_startdate"},"_","startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_streamuri"},"_","streamUri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_temporarysecretidentity"},"_","temporarySecretIdentity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_title"},"_","title")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_votetype"},"_","voteType"))),(0,a.kt)("h3",{id:"accessors"},"Accessors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#addsdkversion"},"addSDKVersion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#canabstain"},"canAbstain")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#canrepeatchoices"},"canRepeatChoices")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#census"},"census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#description"},"description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#duration"},"duration")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#electiontype"},"electionType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#enddate"},"endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#header"},"header")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#maxcensussize"},"maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#maxnumberofchoices"},"maxNumberOfChoices")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#meta"},"meta")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#questions"},"questions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#startdate"},"startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#streamuri"},"streamUri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#temporarysecretidentity"},"temporarySecretIdentity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#title"},"title")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#votetype"},"voteType"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#addquestion"},"addQuestion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#generateenvelopetype"},"generateEnvelopeType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#generatemetadata"},"generateMetadata")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#generatemode"},"generateMode")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#generatevoteoptions"},"generateVoteOptions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#get"},"get")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#removequestion"},"removeQuestion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#checkvote"},"checkVote")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#from"},"from"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new MultiChoiceElection"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/MultiChoiceElection"},(0,a.kt)("inlineCode",{parentName:"a"},"MultiChoiceElection"))),(0,a.kt)("p",null,"Constructs a multi choice election"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IMultiChoiceElectionParameters"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"Multi choice election parameters")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/MultiChoiceElection"},(0,a.kt)("inlineCode",{parentName:"a"},"MultiChoiceElection"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L24"},"types/election/multichoice.ts:24")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"_addsdkversion"},"_","addSDKVersion"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","addSDKVersion"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_addsdkversion"},"_addSDKVersion")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L175"},"types/election/election.ts:175")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_canabstain"},"_","canAbstain"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","canAbstain"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L17"},"types/election/multichoice.ts:17")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_census"},"_","census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","census"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_census"},"_census")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L172"},"types/election/election.ts:172")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_description"},"_","description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_description"},"_description")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L163"},"types/election/election.ts:163")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_electiontype"},"_","electionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","electionType"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_electiontype"},"_electionType")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L169"},"types/election/election.ts:169")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_enddate"},"_","endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","endDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_enddate"},"_endDate")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L168"},"types/election/election.ts:168")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_header"},"_","header"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","header"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_header"},"_header")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L164"},"types/election/election.ts:164")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_maxcensussize"},"_","maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","maxCensusSize"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_maxcensussize"},"_maxCensusSize")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L173"},"types/election/election.ts:173")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_meta"},"_","meta"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","meta"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_meta"},"_meta")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L166"},"types/election/election.ts:166")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_questions"},"_","questions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","questions"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_questions"},"_questions")),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L171"},"types/election/election.ts:171")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_startdate"},"_","startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","startDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_startdate"},"_startDate")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L167"},"types/election/election.ts:167")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_streamuri"},"_","streamUri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","streamUri"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_streamuri"},"_streamUri")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L165"},"types/election/election.ts:165")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_temporarysecretidentity"},"_","temporarySecretIdentity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","temporarySecretIdentity"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_temporarysecretidentity"},"_temporarySecretIdentity")),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L174"},"types/election/election.ts:174")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_title"},"_","title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","title"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_title"},"_title")),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L162"},"types/election/election.ts:162")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_votetype"},"_","voteType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","voteType"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_votetype"},"_voteType")),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L170"},"types/election/election.ts:170")),(0,a.kt)("h2",{id:"accessors-1"},"Accessors"),(0,a.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"addSDKVersion"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.addSDKVersion"),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L275"},"types/election/unpublished.ts:275")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"addSDKVersion"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.addSDKVersion"),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L279"},"types/election/unpublished.ts:279")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"canabstain"},"canAbstain"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"canAbstain"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L124"},"types/election/multichoice.ts:124")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"canAbstain"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L128"},"types/election/multichoice.ts:128")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"canrepeatchoices"},"canRepeatChoices"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"canRepeatChoices"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L116"},"types/election/multichoice.ts:116")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"canRepeatChoices"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L120"},"types/election/multichoice.ts:120")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"census"},"census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"census"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.census"),(0,a.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L249"},"types/election/unpublished.ts:249")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"census"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-4"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census")))))),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.census"),(0,a.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L253"},"types/election/unpublished.ts:253")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"description"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"returns-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.description"),(0,a.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L173"},"types/election/unpublished.ts:173")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"description"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-5"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,a.kt)("h4",{id:"returns-10"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.description"),(0,a.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L177"},"types/election/unpublished.ts:177")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"duration"},"duration"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"duration"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-11"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.duration"),(0,a.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L138"},"types/election/unpublished.ts:138")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"electiontype"},"electionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"electionType"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"returns-12"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"inherited-from-21"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.electionType"),(0,a.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L225"},"types/election/unpublished.ts:225")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"electionType"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-6"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType")))))),(0,a.kt)("h4",{id:"returns-13"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-22"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.electionType"),(0,a.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L229"},"types/election/unpublished.ts:229")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enddate"},"endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"endDate"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"returns-14"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-23"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.endDate"),(0,a.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L215"},"types/election/unpublished.ts:215")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"endDate"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-7"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,a.kt)("h4",{id:"returns-15"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-24"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.endDate"),(0,a.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L219"},"types/election/unpublished.ts:219")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"header"},"header"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"header"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-16"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-25"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.header"),(0,a.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L181"},"types/election/unpublished.ts:181")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"header"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-8"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-17"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-26"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.header"),(0,a.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L185"},"types/election/unpublished.ts:185")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-18"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-27"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.maxCensusSize"),(0,a.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L258"},"types/election/unpublished.ts:258")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-9"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-19"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-28"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.maxCensusSize"),(0,a.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L262"},"types/election/unpublished.ts:262")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxnumberofchoices"},"maxNumberOfChoices"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"maxNumberOfChoices"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-20"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L108"},"types/election/multichoice.ts:108")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"maxNumberOfChoices"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-10"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-21"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L112"},"types/election/multichoice.ts:112")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"meta"},"meta"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"meta"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"returns-22"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-29"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.meta"),(0,a.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L197"},"types/election/unpublished.ts:197")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"meta"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-11"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"any"))))),(0,a.kt)("h4",{id:"returns-23"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-30"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.meta"),(0,a.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L201"},"types/election/unpublished.ts:201")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"questions"},"questions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"questions"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"returns-24"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"inherited-from-31"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.questions"),(0,a.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L241"},"types/election/unpublished.ts:241")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"questions"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-12"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]")))),(0,a.kt)("h4",{id:"returns-25"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-32"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.questions"),(0,a.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L245"},"types/election/unpublished.ts:245")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"startdate"},"startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"startDate"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"returns-26"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-33"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.startDate"),(0,a.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L206"},"types/election/unpublished.ts:206")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"startDate"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-13"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,a.kt)("h4",{id:"returns-27"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-34"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.startDate"),(0,a.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L210"},"types/election/unpublished.ts:210")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"streamuri"},"streamUri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"streamUri"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-28"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-35"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.streamUri"),(0,a.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L189"},"types/election/unpublished.ts:189")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"streamUri"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-14"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-29"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-36"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.streamUri"),(0,a.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L193"},"types/election/unpublished.ts:193")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-30"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-37"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.temporarySecretIdentity"),(0,a.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L267"},"types/election/unpublished.ts:267")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-15"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-31"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-38"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.temporarySecretIdentity"),(0,a.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L271"},"types/election/unpublished.ts:271")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"title"},"title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"title"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"returns-32"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-39"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.title"),(0,a.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L164"},"types/election/unpublished.ts:164")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"title"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-16"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,a.kt)("h4",{id:"returns-33"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-40"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.title"),(0,a.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L168"},"types/election/unpublished.ts:168")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votetype"},"voteType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"voteType"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"returns-34"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"inherited-from-41"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.voteType"),(0,a.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L233"},"types/election/unpublished.ts:233")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"voteType"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-17"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,a.kt)("h4",{id:"returns-35"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-42"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.voteType"),(0,a.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L237"},"types/election/unpublished.ts:237")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"addquestion"},"addQuestion"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"addQuestion"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"title"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"description"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"choices"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"parameters-18"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"title")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"description")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"choices")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(","{"," ",(0,a.kt)("inlineCode",{parentName:"td"},"title"),": ",(0,a.kt)("inlineCode",{parentName:"td"},"string")," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"td"},"title"),": ",(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">"," })[]")))),(0,a.kt)("h4",{id:"returns-36"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#addquestion"},"addQuestion")),(0,a.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L35"},"types/election/multichoice.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generateenvelopetype"},"generateEnvelopeType"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateEnvelopeType"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"returns-37"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"overrides-2"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#generateenvelopetype"},"generateEnvelopeType")),(0,a.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L65"},"types/election/multichoice.ts:65")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generatemetadata"},"generateMetadata"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateMetadata"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ElectionMetadata"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,a.kt)("h4",{id:"returns-38"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ElectionMetadata"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,a.kt)("h4",{id:"overrides-3"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#generatemetadata"},"generateMetadata")),(0,a.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L75"},"types/election/multichoice.ts:75")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generatemode"},"generateMode"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateMode"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"returns-39"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"inherited-from-43"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#generatemode"},"generateMode")),(0,a.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L154"},"types/election/unpublished.ts:154")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generatevoteoptions"},"generateVoteOptions"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateVoteOptions"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"returns-40"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"overrides-4"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#generatevoteoptions"},"generateVoteOptions")),(0,a.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L54"},"types/election/multichoice.ts:54")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"get"},"get"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"get"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"dot"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"parameters-19"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"dot")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-41"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-44"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#get"},"get")),(0,a.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L266"},"types/election/election.ts:266")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"removequestion"},"removeQuestion"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"removeQuestion"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"questionNumber"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"parameters-20"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"questionNumber")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-42"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"inherited-from-45"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#removequestion"},"removeQuestion")),(0,a.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L60"},"types/election/unpublished.ts:60")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"checkvote"},"checkVote"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"checkVote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"vote"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"voteType"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-21"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"vote")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote")))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"voteType")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,a.kt)("h4",{id:"returns-43"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L92"},"types/election/multichoice.ts:92")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"from"},"from"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"from"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/MultiChoiceElection"},(0,a.kt)("inlineCode",{parentName:"a"},"MultiChoiceElection"))),(0,a.kt)("p",null,"Returns an unpublished election object"),(0,a.kt)("h4",{id:"parameters-22"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IMultiChoiceElectionParameters"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"Unpublished Election parameters")))),(0,a.kt)("h4",{id:"returns-44"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/MultiChoiceElection"},(0,a.kt)("inlineCode",{parentName:"a"},"MultiChoiceElection"))),(0,a.kt)("h4",{id:"overrides-5"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#from"},"from")),(0,a.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L31"},"types/election/multichoice.ts:31")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/03c6674d.cbc5e39e.js b/assets/js/03c6674d.cbc5e39e.js new file mode 100644 index 000000000..4610cfdd4 --- /dev/null +++ b/assets/js/03c6674d.cbc5e39e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4720],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>m});var i=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function r(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=i.createContext({}),o=function(e){var t=i.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},s=function(e){var t=o(e.components);return i.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,p=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),k=o(n),m=a,h=k["".concat(p,".").concat(m)]||k[m]||u[m]||l;return n?i.createElement(h,r(r({ref:t},s),{},{components:n})):i.createElement(h,r({ref:t},s))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,r=new Array(l);r[0]=k;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:a,r[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>r,default:()=>u,frontMatter:()=>l,metadata:()=>d,toc:()=>o});var i=n(87462),a=(n(67294),n(3905));const l={},r=void 0,d={unversionedId:"sdk/reference/classes/MultiChoiceElection",id:"sdk/reference/classes/MultiChoiceElection",title:"MultiChoiceElection",description:"@vocdoni/sdk / Exports / MultiChoiceElection",source:"@site/docs/sdk/reference/classes/MultiChoiceElection.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/MultiChoiceElection",permalink:"/sdk/reference/classes/MultiChoiceElection",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"InvalidElection",permalink:"/sdk/reference/classes/InvalidElection"},next:{title:"OffchainCensus",permalink:"/sdk/reference/classes/OffchainCensus"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_addSDKVersion",id:"_addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_canAbstain",id:"_canabstain",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"_census",id:"_census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"_description",id:"_description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"_electionType",id:"_electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"_endDate",id:"_enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"_header",id:"_header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"_maxCensusSize",id:"_maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"_meta",id:"_meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"_questions",id:"_questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"_startDate",id:"_startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"_streamUri",id:"_streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"_temporarySecretIdentity",id:"_temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"_title",id:"_title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"_voteType",id:"_votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"canAbstain",id:"canabstain",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"canRepeatChoices",id:"canrepeatchoices",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"census",id:"census",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"description",id:"description",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"duration",id:"duration",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"endDate",id:"enddate",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"header",id:"header",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-25",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-26",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-27",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-28",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"maxNumberOfChoices",id:"maxnumberofchoices",level:3},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"meta",id:"meta",level:3},{value:"Returns",id:"returns-22",level:4},{value:"Inherited from",id:"inherited-from-29",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Inherited from",id:"inherited-from-30",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"questions",id:"questions",level:3},{value:"Returns",id:"returns-24",level:4},{value:"Inherited from",id:"inherited-from-31",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Inherited from",id:"inherited-from-32",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"startDate",id:"startdate",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Inherited from",id:"inherited-from-33",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Inherited from",id:"inherited-from-34",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Returns",id:"returns-28",level:4},{value:"Inherited from",id:"inherited-from-35",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Inherited from",id:"inherited-from-36",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Returns",id:"returns-30",level:4},{value:"Inherited from",id:"inherited-from-37",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Inherited from",id:"inherited-from-38",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"title",id:"title",level:3},{value:"Returns",id:"returns-32",level:4},{value:"Inherited from",id:"inherited-from-39",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Inherited from",id:"inherited-from-40",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"voteType",id:"votetype",level:3},{value:"Returns",id:"returns-34",level:4},{value:"Inherited from",id:"inherited-from-41",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Inherited from",id:"inherited-from-42",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"Methods",id:"methods-1",level:2},{value:"addQuestion",id:"addquestion",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"generateEnvelopeType",id:"generateenvelopetype",level:3},{value:"Returns",id:"returns-37",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"generateMetadata",id:"generatemetadata",level:3},{value:"Returns",id:"returns-38",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"generateMode",id:"generatemode",level:3},{value:"Returns",id:"returns-39",level:4},{value:"Inherited from",id:"inherited-from-43",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"generateVoteOptions",id:"generatevoteoptions",level:3},{value:"Returns",id:"returns-40",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-41",level:4},{value:"Inherited from",id:"inherited-from-44",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"removeQuestion",id:"removequestion",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-42",level:4},{value:"Inherited from",id:"inherited-from-45",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"checkVote",id:"checkvote",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-43",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"from",id:"from",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-44",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-59",level:4}],s={toc:o};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / MultiChoiceElection"),(0,a.kt)("h1",{id:"class-multichoiceelection"},"Class: MultiChoiceElection"),(0,a.kt)("p",null,"Represents a multi choice election"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"MultiChoiceElection"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_addsdkversion"},"_","addSDKVersion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_canabstain"},"_","canAbstain")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_census"},"_","census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_description"},"_","description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_electiontype"},"_","electionType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_enddate"},"_","endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_header"},"_","header")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_maxcensussize"},"_","maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_meta"},"_","meta")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_questions"},"_","questions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_startdate"},"_","startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_streamuri"},"_","streamUri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_temporarysecretidentity"},"_","temporarySecretIdentity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_title"},"_","title")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection#_votetype"},"_","voteType"))),(0,a.kt)("h3",{id:"accessors"},"Accessors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#addsdkversion"},"addSDKVersion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#canabstain"},"canAbstain")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#canrepeatchoices"},"canRepeatChoices")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#census"},"census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#description"},"description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#duration"},"duration")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#electiontype"},"electionType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#enddate"},"endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#header"},"header")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#maxcensussize"},"maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#maxnumberofchoices"},"maxNumberOfChoices")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#meta"},"meta")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#questions"},"questions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#startdate"},"startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#streamuri"},"streamUri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#temporarysecretidentity"},"temporarySecretIdentity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#title"},"title")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#votetype"},"voteType"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#addquestion"},"addQuestion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#generateenvelopetype"},"generateEnvelopeType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#generatemetadata"},"generateMetadata")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#generatemode"},"generateMode")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#generatevoteoptions"},"generateVoteOptions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#get"},"get")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#removequestion"},"removeQuestion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#checkvote"},"checkVote")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"MultiChoiceElection#from"},"from"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new MultiChoiceElection"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"MultiChoiceElection"},(0,a.kt)("inlineCode",{parentName:"a"},"MultiChoiceElection"))),(0,a.kt)("p",null,"Constructs a multi choice election"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IMultiChoiceElectionParameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IMultiChoiceElectionParameters"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"Multi choice election parameters")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"MultiChoiceElection"},(0,a.kt)("inlineCode",{parentName:"a"},"MultiChoiceElection"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L24"},"types/election/multichoice.ts:24")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"_addsdkversion"},"_","addSDKVersion"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","addSDKVersion"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_addsdkversion"},"_addSDKVersion")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L175"},"types/election/election.ts:175")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_canabstain"},"_","canAbstain"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","canAbstain"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L17"},"types/election/multichoice.ts:17")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_census"},"_","census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","census"),": ",(0,a.kt)("a",{parentName:"p",href:"Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_census"},"_census")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L172"},"types/election/election.ts:172")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_description"},"_","description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_description"},"_description")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L163"},"types/election/election.ts:163")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_electiontype"},"_","electionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","electionType"),": ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_electiontype"},"_electionType")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L169"},"types/election/election.ts:169")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_enddate"},"_","endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","endDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_enddate"},"_endDate")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L168"},"types/election/election.ts:168")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_header"},"_","header"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","header"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_header"},"_header")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L164"},"types/election/election.ts:164")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_maxcensussize"},"_","maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","maxCensusSize"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_maxcensussize"},"_maxCensusSize")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L173"},"types/election/election.ts:173")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_meta"},"_","meta"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","meta"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_meta"},"_meta")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L166"},"types/election/election.ts:166")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_questions"},"_","questions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","questions"),": ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_questions"},"_questions")),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L171"},"types/election/election.ts:171")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_startdate"},"_","startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","startDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_startdate"},"_startDate")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L167"},"types/election/election.ts:167")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_streamuri"},"_","streamUri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","streamUri"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_streamuri"},"_streamUri")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L165"},"types/election/election.ts:165")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_temporarysecretidentity"},"_","temporarySecretIdentity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","temporarySecretIdentity"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_temporarysecretidentity"},"_temporarySecretIdentity")),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L174"},"types/election/election.ts:174")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_title"},"_","title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","title"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_title"},"_title")),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L162"},"types/election/election.ts:162")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_votetype"},"_","voteType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","voteType"),": ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_votetype"},"_voteType")),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L170"},"types/election/election.ts:170")),(0,a.kt)("h2",{id:"accessors-1"},"Accessors"),(0,a.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"addSDKVersion"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.addSDKVersion"),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L275"},"types/election/unpublished.ts:275")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"addSDKVersion"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.addSDKVersion"),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L279"},"types/election/unpublished.ts:279")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"canabstain"},"canAbstain"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"canAbstain"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L124"},"types/election/multichoice.ts:124")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"canAbstain"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L128"},"types/election/multichoice.ts:128")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"canrepeatchoices"},"canRepeatChoices"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"canRepeatChoices"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L116"},"types/election/multichoice.ts:116")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"canRepeatChoices"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L120"},"types/election/multichoice.ts:120")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"census"},"census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"census"),"(): ",(0,a.kt)("a",{parentName:"p",href:"Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.census"),(0,a.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L249"},"types/election/unpublished.ts:249")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"census"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-4"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census")))))),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.census"),(0,a.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L253"},"types/election/unpublished.ts:253")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"description"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"returns-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.description"),(0,a.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L173"},"types/election/unpublished.ts:173")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"description"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-5"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,a.kt)("h4",{id:"returns-10"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.description"),(0,a.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L177"},"types/election/unpublished.ts:177")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"duration"},"duration"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"duration"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-11"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.duration"),(0,a.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L138"},"types/election/unpublished.ts:138")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"electiontype"},"electionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"electionType"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"returns-12"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"inherited-from-21"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.electionType"),(0,a.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L225"},"types/election/unpublished.ts:225")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"electionType"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-6"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType")))))),(0,a.kt)("h4",{id:"returns-13"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-22"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.electionType"),(0,a.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L229"},"types/election/unpublished.ts:229")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enddate"},"endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"endDate"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"returns-14"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-23"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.endDate"),(0,a.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L215"},"types/election/unpublished.ts:215")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"endDate"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-7"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,a.kt)("h4",{id:"returns-15"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-24"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.endDate"),(0,a.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L219"},"types/election/unpublished.ts:219")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"header"},"header"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"header"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-16"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-25"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.header"),(0,a.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L181"},"types/election/unpublished.ts:181")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"header"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-8"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-17"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-26"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.header"),(0,a.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L185"},"types/election/unpublished.ts:185")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-18"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-27"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.maxCensusSize"),(0,a.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L258"},"types/election/unpublished.ts:258")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-9"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-19"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-28"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.maxCensusSize"),(0,a.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L262"},"types/election/unpublished.ts:262")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxnumberofchoices"},"maxNumberOfChoices"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"maxNumberOfChoices"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-20"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L108"},"types/election/multichoice.ts:108")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"maxNumberOfChoices"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-10"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-21"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L112"},"types/election/multichoice.ts:112")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"meta"},"meta"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"meta"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"returns-22"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-29"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.meta"),(0,a.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L197"},"types/election/unpublished.ts:197")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"meta"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-11"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"any"))))),(0,a.kt)("h4",{id:"returns-23"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-30"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.meta"),(0,a.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L201"},"types/election/unpublished.ts:201")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"questions"},"questions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"questions"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"returns-24"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"inherited-from-31"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.questions"),(0,a.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L241"},"types/election/unpublished.ts:241")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"questions"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-12"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]")))),(0,a.kt)("h4",{id:"returns-25"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-32"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.questions"),(0,a.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L245"},"types/election/unpublished.ts:245")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"startdate"},"startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"startDate"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"returns-26"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-33"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.startDate"),(0,a.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L206"},"types/election/unpublished.ts:206")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"startDate"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-13"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,a.kt)("h4",{id:"returns-27"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-34"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.startDate"),(0,a.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L210"},"types/election/unpublished.ts:210")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"streamuri"},"streamUri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"streamUri"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-28"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-35"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.streamUri"),(0,a.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L189"},"types/election/unpublished.ts:189")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"streamUri"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-14"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-29"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-36"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.streamUri"),(0,a.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L193"},"types/election/unpublished.ts:193")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-30"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-37"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.temporarySecretIdentity"),(0,a.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L267"},"types/election/unpublished.ts:267")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-15"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-31"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-38"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.temporarySecretIdentity"),(0,a.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L271"},"types/election/unpublished.ts:271")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"title"},"title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"title"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"returns-32"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-39"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.title"),(0,a.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L164"},"types/election/unpublished.ts:164")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"title"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-16"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,a.kt)("h4",{id:"returns-33"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-40"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.title"),(0,a.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L168"},"types/election/unpublished.ts:168")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votetype"},"voteType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"voteType"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"returns-34"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"inherited-from-41"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.voteType"),(0,a.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L233"},"types/election/unpublished.ts:233")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"voteType"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-17"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,a.kt)("h4",{id:"returns-35"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-42"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.voteType"),(0,a.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L237"},"types/election/unpublished.ts:237")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"addquestion"},"addQuestion"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"addQuestion"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"title"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"description"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"choices"),"): ",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"parameters-18"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"title")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"description")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"choices")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(","{"," ",(0,a.kt)("inlineCode",{parentName:"td"},"title"),": ",(0,a.kt)("inlineCode",{parentName:"td"},"string")," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"td"},"title"),": ",(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">"," })[]")))),(0,a.kt)("h4",{id:"returns-36"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#addquestion"},"addQuestion")),(0,a.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L35"},"types/election/multichoice.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generateenvelopetype"},"generateEnvelopeType"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateEnvelopeType"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"returns-37"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"overrides-2"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#generateenvelopetype"},"generateEnvelopeType")),(0,a.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L65"},"types/election/multichoice.ts:65")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generatemetadata"},"generateMetadata"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateMetadata"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/ElectionMetadata"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,a.kt)("h4",{id:"returns-38"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../interfaces/ElectionMetadata"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,a.kt)("h4",{id:"overrides-3"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#generatemetadata"},"generateMetadata")),(0,a.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L75"},"types/election/multichoice.ts:75")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generatemode"},"generateMode"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateMode"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"returns-39"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"inherited-from-43"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#generatemode"},"generateMode")),(0,a.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L154"},"types/election/unpublished.ts:154")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generatevoteoptions"},"generateVoteOptions"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateVoteOptions"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"returns-40"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"overrides-4"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#generatevoteoptions"},"generateVoteOptions")),(0,a.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L54"},"types/election/multichoice.ts:54")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"get"},"get"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"get"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"dot"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"parameters-19"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"dot")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-41"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-44"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#get"},"get")),(0,a.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L266"},"types/election/election.ts:266")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"removequestion"},"removeQuestion"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"removeQuestion"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"questionNumber"),"): ",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"parameters-20"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"questionNumber")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-42"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"inherited-from-45"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#removequestion"},"removeQuestion")),(0,a.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L60"},"types/election/unpublished.ts:60")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"checkvote"},"checkVote"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"checkVote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"vote"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"voteType"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-21"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"vote")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote")))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"voteType")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,a.kt)("h4",{id:"returns-43"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L92"},"types/election/multichoice.ts:92")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"from"},"from"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"from"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"MultiChoiceElection"},(0,a.kt)("inlineCode",{parentName:"a"},"MultiChoiceElection"))),(0,a.kt)("p",null,"Returns an unpublished election object"),(0,a.kt)("h4",{id:"parameters-22"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IMultiChoiceElectionParameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IMultiChoiceElectionParameters"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"Unpublished Election parameters")))),(0,a.kt)("h4",{id:"returns-44"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"MultiChoiceElection"},(0,a.kt)("inlineCode",{parentName:"a"},"MultiChoiceElection"))),(0,a.kt)("h4",{id:"overrides-5"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#from"},"from")),(0,a.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L31"},"types/election/multichoice.ts:31")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/03d8c746.8b9ba94a.js b/assets/js/03d8c746.8b9ba94a.js deleted file mode 100644 index f10e07f6e..000000000 --- a/assets/js/03d8c746.8b9ba94a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9967],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>k});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),o=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},p=function(e){var t=o(e.components);return n.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,l=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=o(r),k=a,m=u["".concat(c,".").concat(k)]||u[k]||d[k]||l;return r?n.createElement(m,i(i({ref:t},p),{},{components:r})):n.createElement(m,i({ref:t},p))}));function k(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=r.length,i=new Array(l);i[0]=u;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s.mdxType="string"==typeof e?e:a,i[1]=s;for(var o=2;o{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>l,metadata:()=>s,toc:()=>o});var n=r(87462),a=(r(67294),r(3905));const l={},i=void 0,s={unversionedId:"sdk/reference/classes/FileService",id:"sdk/reference/classes/FileService",title:"FileService",description:"@vocdoni/sdk / Exports / FileService",source:"@site/docs/sdk/reference/classes/FileService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/FileService",permalink:"/sdk/reference/classes/FileService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"FileAPI",permalink:"/sdk/reference/classes/FileAPI"},next:{title:"InvalidElection",permalink:"/sdk/reference/classes/InvalidElection"}},c={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"Methods",id:"methods-1",level:2},{value:"calculateCID",id:"calculatecid",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4}],p={toc:o};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / FileService"),(0,a.kt)("h1",{id:"class-fileservice"},"Class: FileService"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},(0,a.kt)("inlineCode",{parentName:"a"},"Service"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"FileService"))))),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"FileServiceProperties"))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FileService#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FileService#url"},"url"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FileService#calculatecid"},"calculateCID"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new FileService"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/FileService"},(0,a.kt)("inlineCode",{parentName:"a"},"FileService"))),(0,a.kt)("p",null,"Instantiate the election service."),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"FileServiceParameters"),">"),(0,a.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/FileService"},(0,a.kt)("inlineCode",{parentName:"a"},"FileService"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/file.ts#L16"},"services/file.ts:16")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"url"},"url"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"url"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#url"},"url")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/service.ts#L6"},"services/service.ts:6")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"calculatecid"},"calculateCID"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"calculateCID"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,"Fetches the CID expected for the specified data content."),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"data")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The data of which we want the CID of")))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,"Resulting CID"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/file.ts#L27"},"services/file.ts:27")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/03d8c746.9f76e529.js b/assets/js/03d8c746.9f76e529.js new file mode 100644 index 000000000..945126d0b --- /dev/null +++ b/assets/js/03d8c746.9f76e529.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9967],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>m});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var o=n.createContext({}),c=function(e){var t=n.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(o.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(r),m=a,k=u["".concat(o,".").concat(m)]||u[m]||d[m]||i;return r?n.createElement(k,l(l({ref:t},p),{},{components:r})):n.createElement(k,l({ref:t},p))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=u;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s.mdxType="string"==typeof e?e:a,l[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var n=r(87462),a=(r(67294),r(3905));const i={},l=void 0,s={unversionedId:"sdk/reference/classes/FileService",id:"sdk/reference/classes/FileService",title:"FileService",description:"@vocdoni/sdk / Exports / FileService",source:"@site/docs/sdk/reference/classes/FileService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/FileService",permalink:"/sdk/reference/classes/FileService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"FileAPI",permalink:"/sdk/reference/classes/FileAPI"},next:{title:"InvalidElection",permalink:"/sdk/reference/classes/InvalidElection"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"Methods",id:"methods-1",level:2},{value:"calculateCID",id:"calculatecid",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4}],p={toc:c};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / FileService"),(0,a.kt)("h1",{id:"class-fileservice"},"Class: FileService"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"Service"},(0,a.kt)("inlineCode",{parentName:"a"},"Service"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"FileService"))))),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"FileServiceProperties"))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"FileService#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"FileService#url"},"url"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"FileService#calculatecid"},"calculateCID"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new FileService"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"FileService"},(0,a.kt)("inlineCode",{parentName:"a"},"FileService"))),(0,a.kt)("p",null,"Instantiate the election service."),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"FileServiceParameters"),">"),(0,a.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"FileService"},(0,a.kt)("inlineCode",{parentName:"a"},"FileService"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,a.kt)("a",{parentName:"p",href:"Service#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/file.ts#L16"},"services/file.ts:16")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"url"},"url"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"url"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,a.kt)("a",{parentName:"p",href:"Service#url"},"url")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/service.ts#L6"},"services/service.ts:6")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"calculatecid"},"calculateCID"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"calculateCID"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,"Fetches the CID expected for the specified data content."),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"data")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The data of which we want the CID of")))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,"Resulting CID"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/file.ts#L27"},"services/file.ts:27")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/080a9ee7.6623a56a.js b/assets/js/080a9ee7.6623a56a.js deleted file mode 100644 index 2bd3dc264..000000000 --- a/assets/js/080a9ee7.6623a56a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3913],{3905:(e,n,t)=>{t.d(n,{Zo:()=>u,kt:()=>m});var r=t(67294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var p=r.createContext({}),s=function(e){var n=r.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},u=function(e){var n=s(e.components);return r.createElement(p.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,a=e.originalType,p=e.parentName,u=o(e,["components","mdxType","originalType","parentName"]),d=s(t),m=i,f=d["".concat(p,".").concat(m)]||d[m]||c[m]||a;return t?r.createElement(f,l(l({ref:n},u),{},{components:t})):r.createElement(f,l({ref:n},u))}));function m(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var a=t.length,l=new Array(a);l[0]=d;var o={};for(var p in n)hasOwnProperty.call(n,p)&&(o[p]=n[p]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var s=2;s{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>l,default:()=>c,frontMatter:()=>a,metadata:()=>o,toc:()=>s});var r=t(87462),i=(t(67294),t(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/enums/CensusTypeEnum",id:"sdk/reference/enums/CensusTypeEnum",title:"CensusTypeEnum",description:"@vocdoni/sdk / Exports / CensusTypeEnum",source:"@site/docs/sdk/reference/enums/CensusTypeEnum.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/CensusTypeEnum",permalink:"/sdk/reference/enums/CensusTypeEnum",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CensusType",permalink:"/sdk/reference/enums/CensusType"},next:{title:"CspProofType",permalink:"/sdk/reference/enums/CspProofType"}},p={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"CENSUS_UNKNOWN",id:"census_unknown",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ERC1155",id:"erc1155",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ERC20",id:"erc20",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"ERC721",id:"erc721",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"ERC777",id:"erc777",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"MINI_ME",id:"mini_me",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"OFF_CHAIN_CA",id:"off_chain_ca",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"OFF_CHAIN_TREE",id:"off_chain_tree",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"OFF_CHAIN_TREE_WEIGHTED",id:"off_chain_tree_weighted",level:3},{value:"Defined in",id:"defined-in-8",level:4}],u={toc:s};function c(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / CensusTypeEnum"),(0,i.kt)("h1",{id:"enumeration-censustypeenum"},"Enumeration: CensusTypeEnum"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusTypeEnum#census_unknown"},"CENSUS","_","UNKNOWN")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusTypeEnum#erc1155"},"ERC1155")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusTypeEnum#erc20"},"ERC20")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusTypeEnum#erc721"},"ERC721")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusTypeEnum#erc777"},"ERC777")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusTypeEnum#mini_me"},"MINI","_","ME")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusTypeEnum#off_chain_ca"},"OFF","_","CHAIN","_","CA")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusTypeEnum#off_chain_tree"},"OFF","_","CHAIN","_","TREE")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusTypeEnum#off_chain_tree_weighted"},"OFF","_","CHAIN","_","TREE","_","WEIGHTED"))),(0,i.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,i.kt)("h3",{id:"census_unknown"},"CENSUS","_","UNKNOWN"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"CENSUS","_","UNKNOWN")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"CENSUS_UNKNOWN"')),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L150"},"api/election.ts:150")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"erc1155"},"ERC1155"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ERC1155")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"ERC1155"')),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L156"},"api/election.ts:156")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"erc20"},"ERC20"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ERC20")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"ERC20"')),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L154"},"api/election.ts:154")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"erc721"},"ERC721"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ERC721")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"ERC721"')),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L155"},"api/election.ts:155")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"erc777"},"ERC777"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ERC777")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"ERC777"')),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L157"},"api/election.ts:157")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"mini_me"},"MINI","_","ME"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"MINI","_","ME")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"MINI_ME"')),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L158"},"api/election.ts:158")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"off_chain_ca"},"OFF","_","CHAIN","_","CA"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"OFF","_","CHAIN","_","CA")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"OFF_CHAIN_CA"')),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L153"},"api/election.ts:153")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"off_chain_tree"},"OFF","_","CHAIN","_","TREE"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"OFF","_","CHAIN","_","TREE")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"OFF_CHAIN_TREE"')),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L151"},"api/election.ts:151")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"off_chain_tree_weighted"},"OFF","_","CHAIN","_","TREE","_","WEIGHTED"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"OFF","_","CHAIN","_","TREE","_","WEIGHTED")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"OFF_CHAIN_TREE_WEIGHTED"')),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L152"},"api/election.ts:152")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/080a9ee7.f5e5e37a.js b/assets/js/080a9ee7.f5e5e37a.js new file mode 100644 index 000000000..b2260972d --- /dev/null +++ b/assets/js/080a9ee7.f5e5e37a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3913],{3905:(e,n,t)=>{t.d(n,{Zo:()=>u,kt:()=>m});var i=t(67294);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function l(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var p=i.createContext({}),s=function(e){var n=i.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},u=function(e){var n=s(e.components);return i.createElement(p.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},c=i.forwardRef((function(e,n){var t=e.components,r=e.mdxType,a=e.originalType,p=e.parentName,u=o(e,["components","mdxType","originalType","parentName"]),c=s(t),m=r,f=c["".concat(p,".").concat(m)]||c[m]||d[m]||a;return t?i.createElement(f,l(l({ref:n},u),{},{components:t})):i.createElement(f,l({ref:n},u))}));function m(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var a=t.length,l=new Array(a);l[0]=c;var o={};for(var p in n)hasOwnProperty.call(n,p)&&(o[p]=n[p]);o.originalType=e,o.mdxType="string"==typeof e?e:r,l[1]=o;for(var s=2;s{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>l,default:()=>d,frontMatter:()=>a,metadata:()=>o,toc:()=>s});var i=t(87462),r=(t(67294),t(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/enums/CensusTypeEnum",id:"sdk/reference/enums/CensusTypeEnum",title:"CensusTypeEnum",description:"@vocdoni/sdk / Exports / CensusTypeEnum",source:"@site/docs/sdk/reference/enums/CensusTypeEnum.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/CensusTypeEnum",permalink:"/sdk/reference/enums/CensusTypeEnum",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CensusType",permalink:"/sdk/reference/enums/CensusType"},next:{title:"CspProofType",permalink:"/sdk/reference/enums/CspProofType"}},p={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"CENSUS_UNKNOWN",id:"census_unknown",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ERC1155",id:"erc1155",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ERC20",id:"erc20",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"ERC721",id:"erc721",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"ERC777",id:"erc777",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"MINI_ME",id:"mini_me",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"OFF_CHAIN_CA",id:"off_chain_ca",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"OFF_CHAIN_TREE",id:"off_chain_tree",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"OFF_CHAIN_TREE_WEIGHTED",id:"off_chain_tree_weighted",level:3},{value:"Defined in",id:"defined-in-8",level:4}],u={toc:s};function d(e){let{components:n,...t}=e;return(0,r.kt)("wrapper",(0,i.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / CensusTypeEnum"),(0,r.kt)("h1",{id:"enumeration-censustypeenum"},"Enumeration: CensusTypeEnum"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusTypeEnum#census_unknown"},"CENSUS","_","UNKNOWN")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusTypeEnum#erc1155"},"ERC1155")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusTypeEnum#erc20"},"ERC20")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusTypeEnum#erc721"},"ERC721")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusTypeEnum#erc777"},"ERC777")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusTypeEnum#mini_me"},"MINI","_","ME")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusTypeEnum#off_chain_ca"},"OFF","_","CHAIN","_","CA")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusTypeEnum#off_chain_tree"},"OFF","_","CHAIN","_","TREE")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusTypeEnum#off_chain_tree_weighted"},"OFF","_","CHAIN","_","TREE","_","WEIGHTED"))),(0,r.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,r.kt)("h3",{id:"census_unknown"},"CENSUS","_","UNKNOWN"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"CENSUS","_","UNKNOWN")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"CENSUS_UNKNOWN"')),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L150"},"api/election.ts:150")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"erc1155"},"ERC1155"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ERC1155")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"ERC1155"')),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L156"},"api/election.ts:156")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"erc20"},"ERC20"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ERC20")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"ERC20"')),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L154"},"api/election.ts:154")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"erc721"},"ERC721"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ERC721")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"ERC721"')),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L155"},"api/election.ts:155")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"erc777"},"ERC777"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ERC777")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"ERC777"')),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L157"},"api/election.ts:157")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"mini_me"},"MINI","_","ME"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"MINI","_","ME")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"MINI_ME"')),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L158"},"api/election.ts:158")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"off_chain_ca"},"OFF","_","CHAIN","_","CA"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"OFF","_","CHAIN","_","CA")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"OFF_CHAIN_CA"')),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L153"},"api/election.ts:153")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"off_chain_tree"},"OFF","_","CHAIN","_","TREE"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"OFF","_","CHAIN","_","TREE")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"OFF_CHAIN_TREE"')),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L151"},"api/election.ts:151")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"off_chain_tree_weighted"},"OFF","_","CHAIN","_","TREE","_","WEIGHTED"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"OFF","_","CHAIN","_","TREE","_","WEIGHTED")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"OFF_CHAIN_TREE_WEIGHTED"')),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L152"},"api/election.ts:152")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/08636a24.22bc3240.js b/assets/js/08636a24.22bc3240.js deleted file mode 100644 index 9d11ab7f3..000000000 --- a/assets/js/08636a24.22bc3240.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[374],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),p=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=p(e.components);return a.createElement(d.Provider,{value:t},e.children)},o={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),k=p(n),m=r,u=k["".concat(d,".").concat(m)]||k[m]||o[m]||i;return n?a.createElement(u,l(l({ref:t},c),{},{components:n})):a.createElement(u,l({ref:t},c))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=k;var s={};for(var d in t)hasOwnProperty.call(t,d)&&(s[d]=t[d]);s.originalType=e,s.mdxType="string"==typeof e?e:r,l[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>o,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,s={unversionedId:"sdk/reference/classes/ElectionService",id:"sdk/reference/classes/ElectionService",title:"ElectionService",description:"@vocdoni/sdk / Exports / ElectionService",source:"@site/docs/sdk/reference/classes/ElectionService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/ElectionService",permalink:"/sdk/reference/classes/ElectionService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ElectionAPI",permalink:"/sdk/reference/classes/ElectionAPI"},next:{title:"FaucetAPI",permalink:"/sdk/reference/classes/FaucetAPI"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"censusService",id:"censusservice",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"chainService",id:"chainservice",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods-1",level:2},{value:"buildCensus",id:"buildcensus",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"buildPublishedCensus",id:"buildpublishedcensus",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"calculateChoiceResults",id:"calculatechoiceresults",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"calculateElectionCost",id:"calculateelectioncost",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"calculateMultichoiceAbstains",id:"calculatemultichoiceabstains",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"estimateElectionCost",id:"estimateelectioncost",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"fetchElection",id:"fetchelection",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"fetchElections",id:"fetchelections",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getElectionSalt",id:"getelectionsalt",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getNumericElectionId",id:"getnumericelectionid",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"keys",id:"keys",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"nextElectionId",id:"nextelectionid",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"signTransaction",id:"signtransaction",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-17",level:4}],c={toc:p};function o(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ElectionService"),(0,r.kt)("h1",{id:"class-electionservice"},"Class: ElectionService"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},(0,r.kt)("inlineCode",{parentName:"a"},"Service"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"ElectionService"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"ElectionServiceProperties"))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#censusservice"},"censusService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#chainservice"},"chainService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#url"},"url"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#buildcensus"},"buildCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#buildpublishedcensus"},"buildPublishedCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#calculatechoiceresults"},"calculateChoiceResults")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#calculateelectioncost"},"calculateElectionCost")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#calculatemultichoiceabstains"},"calculateMultichoiceAbstains")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#create"},"create")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#estimateelectioncost"},"estimateElectionCost")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#fetchelection"},"fetchElection")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#fetchelections"},"fetchElections")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#getelectionsalt"},"getElectionSalt")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#getnumericelectionid"},"getNumericElectionId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#keys"},"keys")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#nextelectionid"},"nextElectionId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService#signtransaction"},"signTransaction"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new ElectionService"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ElectionService"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionService"))),(0,r.kt)("p",null,"Instantiate the election service."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"ElectionServiceParameters"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ElectionService"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionService"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#constructor"},"constructor")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L69"},"services/election.ts:69")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"censusservice"},"censusService"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"censusService"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CensusService"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusService"))),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,"ElectionServiceProperties.censusService"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L61"},"services/election.ts:61")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"chainservice"},"chainService"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"chainService"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ChainService"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainService"))),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,"ElectionServiceProperties.chainService"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L62"},"services/election.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"url"},"url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#url"},"url")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/service.ts#L6"},"services/service.ts:6")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"buildcensus"},"buildCensus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"buildCensus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionInfo"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ArchivedCensus"),">"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionInfo")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ArchivedCensus"),">"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L100"},"services/election.ts:100")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"buildpublishedcensus"},"buildPublishedCensus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"buildPublishedCensus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionInfo"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedCensus")),">"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionInfo")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedCensus")),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L84"},"services/election.ts:84")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"calculatechoiceresults"},"calculateChoiceResults"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"calculateChoiceResults"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionType"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"result"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"qIndex"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"cIndex"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionType")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"result")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"qIndex")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"cIndex")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L180"},"services/election.ts:180")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"calculateelectioncost"},"calculateElectionCost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"calculateElectionCost"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"Calculate the election cost"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"election")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/UnpublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"UnpublishedElection")))))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"The cost in tokens."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L338"},"services/election.ts:338")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"calculatemultichoiceabstains"},"calculateMultichoiceAbstains"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"calculateMultichoiceAbstains"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionType"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"result"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionType")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"result")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L203"},"services/election.ts:203")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"create"},"create"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"create"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"metadata"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionCreateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionCreateResponse")),">"),(0,r.kt)("p",null,"Creates a new election."),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The set information info raw payload to be submitted to the chain")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"metadata")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The base64 encoded metadata JSON object")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionCreateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionCreateResponse")),">"),(0,r.kt)("p",null,"The created election information"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L257"},"services/election.ts:257")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"estimateelectioncost"},"estimateElectionCost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"estimateElectionCost"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"Estimates the election cost"),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"election")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/UnpublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"UnpublishedElection")))))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"The cost in tokens."),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L325"},"services/election.ts:325")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchelection"},"fetchElection"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchElection"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ArchivedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"ArchivedElection")),">"),(0,r.kt)("p",null,"Fetches info about an election."),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the election")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ArchivedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"ArchivedElection")),">"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L115"},"services/election.ts:115")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchelections"},"fetchElections"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchElections"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<(",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ArchivedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"ArchivedElection"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/InvalidElection"},(0,r.kt)("inlineCode",{parentName:"a"},"InvalidElection")),")[]",">"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/FetchElectionsParameters"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchElectionsParameters")),">")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<(",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ArchivedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"ArchivedElection"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/InvalidElection"},(0,r.kt)("inlineCode",{parentName:"a"},"InvalidElection")),")[]",">"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L222"},"services/election.ts:222")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getelectionsalt"},"getElectionSalt"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getElectionSalt"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionCount"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Returns an election salt for address"),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The address of the account")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionCount")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The election count")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The election salt"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L288"},"services/election.ts:288")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getnumericelectionid"},"getNumericElectionId"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getNumericElectionId"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Returns a numeric election identifier"),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the election")))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The numeric identifier"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L302"},"services/election.ts:302")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"keys"},"keys"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"keys"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionKeysResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionKeysResponse")),">"),(0,r.kt)("p",null,"Fetches the encryption keys from the specified process."),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the election")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionKeysResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionKeysResponse")),">"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L315"},"services/election.ts:315")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"nextelectionid"},"nextElectionId"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"nextElectionId"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Returns the next election id."),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The address of the account")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"election")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/UnpublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The unpublished election")))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The next election identifier"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L269"},"services/election.ts:269")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"signtransaction"},"signTransaction"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"signTransaction"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"tx"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"walletOrSigner"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Uint8Array"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"walletOrSigner")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Signer"))))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L74"},"services/election.ts:74")))}o.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/08636a24.a3d8f6e0.js b/assets/js/08636a24.a3d8f6e0.js new file mode 100644 index 000000000..34df03355 --- /dev/null +++ b/assets/js/08636a24.a3d8f6e0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[374],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>m});var a=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var p=a.createContext({}),o=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=o(e.components);return a.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,p=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),k=o(n),m=i,u=k["".concat(p,".").concat(m)]||k[m]||c[m]||r;return n?a.createElement(u,l(l({ref:t},s),{},{components:n})):a.createElement(u,l({ref:t},s))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=k;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:i,l[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>c,frontMatter:()=>r,metadata:()=>d,toc:()=>o});var a=n(87462),i=(n(67294),n(3905));const r={},l=void 0,d={unversionedId:"sdk/reference/classes/ElectionService",id:"sdk/reference/classes/ElectionService",title:"ElectionService",description:"@vocdoni/sdk / Exports / ElectionService",source:"@site/docs/sdk/reference/classes/ElectionService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/ElectionService",permalink:"/sdk/reference/classes/ElectionService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ElectionAPI",permalink:"/sdk/reference/classes/ElectionAPI"},next:{title:"FaucetAPI",permalink:"/sdk/reference/classes/FaucetAPI"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"censusService",id:"censusservice",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"chainService",id:"chainservice",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods-1",level:2},{value:"buildCensus",id:"buildcensus",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"buildPublishedCensus",id:"buildpublishedcensus",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"calculateChoiceResults",id:"calculatechoiceresults",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"calculateElectionCost",id:"calculateelectioncost",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"calculateMultichoiceAbstains",id:"calculatemultichoiceabstains",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"estimateElectionCost",id:"estimateelectioncost",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"fetchElection",id:"fetchelection",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"fetchElections",id:"fetchelections",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getElectionSalt",id:"getelectionsalt",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getNumericElectionId",id:"getnumericelectionid",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"keys",id:"keys",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"nextElectionId",id:"nextelectionid",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"signTransaction",id:"signtransaction",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-17",level:4}],s={toc:o};function c(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ElectionService"),(0,i.kt)("h1",{id:"class-electionservice"},"Class: ElectionService"),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"Service"},(0,i.kt)("inlineCode",{parentName:"a"},"Service"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"ElectionService"))))),(0,i.kt)("h2",{id:"implements"},"Implements"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"ElectionServiceProperties"))),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"constructors"},"Constructors"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#constructor"},"constructor"))),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#censusservice"},"censusService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#chainservice"},"chainService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#url"},"url"))),(0,i.kt)("h3",{id:"methods"},"Methods"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#buildcensus"},"buildCensus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#buildpublishedcensus"},"buildPublishedCensus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#calculatechoiceresults"},"calculateChoiceResults")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#calculateelectioncost"},"calculateElectionCost")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#calculatemultichoiceabstains"},"calculateMultichoiceAbstains")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#create"},"create")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#estimateelectioncost"},"estimateElectionCost")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#fetchelection"},"fetchElection")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#fetchelections"},"fetchElections")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#getelectionsalt"},"getElectionSalt")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#getnumericelectionid"},"getNumericElectionId")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#keys"},"keys")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#nextelectionid"},"nextElectionId")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionService#signtransaction"},"signTransaction"))),(0,i.kt)("h2",{id:"constructors-1"},"Constructors"),(0,i.kt)("h3",{id:"constructor"},"constructor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"new ElectionService"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,i.kt)("a",{parentName:"p",href:"ElectionService"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionService"))),(0,i.kt)("p",null,"Instantiate the election service."),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"params")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,i.kt)("inlineCode",{parentName:"td"},"ElectionServiceParameters"),">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"ElectionService"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionService"))),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,i.kt)("a",{parentName:"p",href:"Service#constructor"},"constructor")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L69"},"services/election.ts:69")),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"censusservice"},"censusService"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"censusService"),": ",(0,i.kt)("a",{parentName:"p",href:"CensusService"},(0,i.kt)("inlineCode",{parentName:"a"},"CensusService"))),(0,i.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,i.kt)("p",null,"ElectionServiceProperties.censusService"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L61"},"services/election.ts:61")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"chainservice"},"chainService"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"chainService"),": ",(0,i.kt)("a",{parentName:"p",href:"ChainService"},(0,i.kt)("inlineCode",{parentName:"a"},"ChainService"))),(0,i.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,i.kt)("p",null,"ElectionServiceProperties.chainService"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L62"},"services/election.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"url"},"url"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"url"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,i.kt)("a",{parentName:"p",href:"Service#url"},"url")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/service.ts#L6"},"services/service.ts:6")),(0,i.kt)("h2",{id:"methods-1"},"Methods"),(0,i.kt)("h3",{id:"buildcensus"},"buildCensus"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"buildCensus"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionInfo"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"PublishedCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"ArchivedCensus"),">"),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionInfo")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"PublishedCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"ArchivedCensus"),">"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L100"},"services/election.ts:100")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"buildpublishedcensus"},"buildPublishedCensus"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"buildPublishedCensus"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionInfo"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"PublishedCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"PublishedCensus")),">"),(0,i.kt)("h4",{id:"parameters-2"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionInfo")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"PublishedCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"PublishedCensus")),">"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L84"},"services/election.ts:84")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"calculatechoiceresults"},"calculateChoiceResults"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"calculateChoiceResults"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionType"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"result"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"qIndex"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"cIndex"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"parameters-3"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionType")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"result")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"qIndex")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"cIndex")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L180"},"services/election.ts:180")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"calculateelectioncost"},"calculateElectionCost"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"calculateElectionCost"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,i.kt)("p",null,"Calculate the election cost"),(0,i.kt)("h4",{id:"parameters-4"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"election")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection")))))),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,i.kt)("p",null,"The cost in tokens."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L338"},"services/election.ts:338")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"calculatemultichoiceabstains"},"calculateMultichoiceAbstains"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"calculateMultichoiceAbstains"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionType"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"result"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-5"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionType")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"result")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L203"},"services/election.ts:203")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"create"},"create"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"create"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"payload"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"metadata"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../interfaces/IElectionCreateResponse"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionCreateResponse")),">"),(0,i.kt)("p",null,"Creates a new election."),(0,i.kt)("h4",{id:"parameters-6"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"payload")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The set information info raw payload to be submitted to the chain")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"metadata")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The base64 encoded metadata JSON object")))),(0,i.kt)("h4",{id:"returns-6"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../interfaces/IElectionCreateResponse"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionCreateResponse")),">"),(0,i.kt)("p",null,"The created election information"),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L257"},"services/election.ts:257")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"estimateelectioncost"},"estimateElectionCost"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"estimateElectionCost"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,i.kt)("p",null,"Estimates the election cost"),(0,i.kt)("h4",{id:"parameters-7"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"election")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection")))))),(0,i.kt)("h4",{id:"returns-7"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,i.kt)("p",null,"The cost in tokens."),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L325"},"services/election.ts:325")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fetchelection"},"fetchElection"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fetchElection"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"ArchivedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"ArchivedElection")),">"),(0,i.kt)("p",null,"Fetches info about an election."),(0,i.kt)("h4",{id:"parameters-8"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionId")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The id of the election")))),(0,i.kt)("h4",{id:"returns-8"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"ArchivedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"ArchivedElection")),">"),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L115"},"services/election.ts:115")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fetchelections"},"fetchElections"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fetchElections"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<(",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ArchivedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"ArchivedElection"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"InvalidElection"},(0,i.kt)("inlineCode",{parentName:"a"},"InvalidElection")),")[]",">"),(0,i.kt)("h4",{id:"parameters-9"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"params")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,i.kt)("a",{parentName:"td",href:"../interfaces/FetchElectionsParameters"},(0,i.kt)("inlineCode",{parentName:"a"},"FetchElectionsParameters")),">")))),(0,i.kt)("h4",{id:"returns-9"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<(",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ArchivedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"ArchivedElection"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"InvalidElection"},(0,i.kt)("inlineCode",{parentName:"a"},"InvalidElection")),")[]",">"),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L222"},"services/election.ts:222")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getelectionsalt"},"getElectionSalt"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"getElectionSalt"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"electionCount"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Returns an election salt for address"),(0,i.kt)("h4",{id:"parameters-10"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"address")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The address of the account")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionCount")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The election count")))),(0,i.kt)("h4",{id:"returns-10"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"The election salt"),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L288"},"services/election.ts:288")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getnumericelectionid"},"getNumericElectionId"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"getNumericElectionId"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Returns a numeric election identifier"),(0,i.kt)("h4",{id:"parameters-11"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionId")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The identifier of the election")))),(0,i.kt)("h4",{id:"returns-11"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The numeric identifier"),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L302"},"services/election.ts:302")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"keys"},"keys"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"keys"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../interfaces/IElectionKeysResponse"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionKeysResponse")),">"),(0,i.kt)("p",null,"Fetches the encryption keys from the specified process."),(0,i.kt)("h4",{id:"parameters-12"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionId")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The identifier of the election")))),(0,i.kt)("h4",{id:"returns-12"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../interfaces/IElectionKeysResponse"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionKeysResponse")),">"),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L315"},"services/election.ts:315")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"nextelectionid"},"nextElectionId"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"nextElectionId"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Returns the next election id."),(0,i.kt)("h4",{id:"parameters-13"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"address")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The address of the account")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"election")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"The unpublished election")))),(0,i.kt)("h4",{id:"returns-13"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"The next election identifier"),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L269"},"services/election.ts:269")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"signtransaction"},"signTransaction"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"signTransaction"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"tx"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"message"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"walletOrSigner"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"parameters-14"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"tx")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Uint8Array"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"message")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"walletOrSigner")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"Signer"))))),(0,i.kt)("h4",{id:"returns-14"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L74"},"services/election.ts:74")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/09cca914.4cc8597d.js b/assets/js/09cca914.4cc8597d.js new file mode 100644 index 000000000..3e2ebd0d7 --- /dev/null +++ b/assets/js/09cca914.4cc8597d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9410],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),s=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=s(e.components);return r.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),u=s(n),m=a,f=u["".concat(p,".").concat(m)]||u[m]||d[m]||o;return n?r.createElement(f,l(l({ref:t},c),{},{components:n})):r.createElement(f,l({ref:t},c))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,l=new Array(o);l[0]=u;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i.mdxType="string"==typeof e?e:a,l[1]=i;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>s});var r=n(87462),a=(n(67294),n(3905));const o={},l=void 0,i={unversionedId:"sdk/reference/interfaces/ITallyMode",id:"sdk/reference/interfaces/ITallyMode",title:"ITallyMode",description:"@vocdoni/sdk / Exports / ITallyMode",source:"@site/docs/sdk/reference/interfaces/ITallyMode.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ITallyMode",permalink:"/sdk/reference/interfaces/ITallyMode",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IQuestion",permalink:"/sdk/reference/interfaces/IQuestion"},next:{title:"IVoteInfoResponse",permalink:"/sdk/reference/interfaces/IVoteInfoResponse"}},p={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"costExponent",id:"costexponent",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"maxCount",id:"maxcount",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"maxTotalCost",id:"maxtotalcost",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"maxValue",id:"maxvalue",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"maxVoteOverwrites",id:"maxvoteoverwrites",level:3},{value:"Defined in",id:"defined-in-4",level:4}],c={toc:s};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ITallyMode"),(0,a.kt)("h1",{id:"interface-itallymode"},"Interface: ITallyMode"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ITallyMode#costexponent"},"costExponent")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ITallyMode#maxcount"},"maxCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ITallyMode#maxtotalcost"},"maxTotalCost")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ITallyMode#maxvalue"},"maxValue")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ITallyMode#maxvoteoverwrites"},"maxVoteOverwrites"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"costexponent"},"costExponent"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"costExponent"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The cost exponent of the vote"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L122"},"api/election.ts:122")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxcount"},"maxCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"maxCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The max count of the vote's values sum"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L102"},"api/election.ts:102")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxtotalcost"},"maxTotalCost"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"maxTotalCost"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The max total cost of the votes"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L117"},"api/election.ts:117")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxvalue"},"maxValue"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"maxValue"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The max value of the vote's values"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L107"},"api/election.ts:107")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxvoteoverwrites"},"maxVoteOverwrites"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"maxVoteOverwrites"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The max number of votes overwrites"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L112"},"api/election.ts:112")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/09cca914.d48db358.js b/assets/js/09cca914.d48db358.js deleted file mode 100644 index a2067fde7..000000000 --- a/assets/js/09cca914.d48db358.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9410],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>f});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var c=r.createContext({}),p=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=p(e.components);return r.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),u=p(n),f=a,m=u["".concat(c,".").concat(f)]||u[f]||d[f]||o;return n?r.createElement(m,l(l({ref:t},s),{},{components:n})):r.createElement(m,l({ref:t},s))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,l=new Array(o);l[0]=u;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i.mdxType="string"==typeof e?e:a,l[1]=i;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const o={},l=void 0,i={unversionedId:"sdk/reference/interfaces/ITallyMode",id:"sdk/reference/interfaces/ITallyMode",title:"ITallyMode",description:"@vocdoni/sdk / Exports / ITallyMode",source:"@site/docs/sdk/reference/interfaces/ITallyMode.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ITallyMode",permalink:"/sdk/reference/interfaces/ITallyMode",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IQuestion",permalink:"/sdk/reference/interfaces/IQuestion"},next:{title:"IVoteInfoResponse",permalink:"/sdk/reference/interfaces/IVoteInfoResponse"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"costExponent",id:"costexponent",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"maxCount",id:"maxcount",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"maxTotalCost",id:"maxtotalcost",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"maxValue",id:"maxvalue",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"maxVoteOverwrites",id:"maxvoteoverwrites",level:3},{value:"Defined in",id:"defined-in-4",level:4}],s={toc:p};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ITallyMode"),(0,a.kt)("h1",{id:"interface-itallymode"},"Interface: ITallyMode"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ITallyMode#costexponent"},"costExponent")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ITallyMode#maxcount"},"maxCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ITallyMode#maxtotalcost"},"maxTotalCost")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ITallyMode#maxvalue"},"maxValue")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ITallyMode#maxvoteoverwrites"},"maxVoteOverwrites"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"costexponent"},"costExponent"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"costExponent"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The cost exponent of the vote"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L122"},"api/election.ts:122")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxcount"},"maxCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"maxCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The max count of the vote's values sum"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L102"},"api/election.ts:102")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxtotalcost"},"maxTotalCost"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"maxTotalCost"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The max total cost of the votes"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L117"},"api/election.ts:117")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxvalue"},"maxValue"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"maxValue"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The max value of the vote's values"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L107"},"api/election.ts:107")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxvoteoverwrites"},"maxVoteOverwrites"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"maxVoteOverwrites"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The max number of votes overwrites"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L112"},"api/election.ts:112")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0bcfcae9.0cdd5ab2.js b/assets/js/0bcfcae9.0cdd5ab2.js deleted file mode 100644 index 315bab987..000000000 --- a/assets/js/0bcfcae9.0cdd5ab2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6891],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var i=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function r(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=i.createContext({}),o=function(e){var t=i.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},p=function(e){var t=o(e.components);return i.createElement(d.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,d=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),k=o(n),u=a,m=k["".concat(d,".").concat(u)]||k[u]||c[u]||l;return n?i.createElement(m,r(r({ref:t},p),{},{components:n})):i.createElement(m,r({ref:t},p))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,r=new Array(l);r[0]=k;var s={};for(var d in t)hasOwnProperty.call(t,d)&&(s[d]=t[d]);s.originalType=e,s.mdxType="string"==typeof e?e:a,r[1]=s;for(var o=2;o{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>r,default:()=>c,frontMatter:()=>l,metadata:()=>s,toc:()=>o});var i=n(87462),a=(n(67294),n(3905));const l={},r=void 0,s={unversionedId:"sdk/reference/classes/Election",id:"sdk/reference/classes/Election",title:"Election",description:"@vocdoni/sdk / Exports / Election",source:"@site/docs/sdk/reference/classes/Election.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Election",permalink:"/sdk/reference/classes/Election",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CspVote",permalink:"/sdk/reference/classes/CspVote"},next:{title:"ElectionAPI",permalink:"/sdk/reference/classes/ElectionAPI"}},d={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_addSDKVersion",id:"_addsdkversion",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"_census",id:"_census",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"_description",id:"_description",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"_electionType",id:"_electiontype",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"_endDate",id:"_enddate",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"_header",id:"_header",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"_maxCensusSize",id:"_maxcensussize",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"_meta",id:"_meta",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"_questions",id:"_questions",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"_startDate",id:"_startdate",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"_streamUri",id:"_streamuri",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"_temporarySecretIdentity",id:"_temporarysecretidentity",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"_title",id:"_title",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"_voteType",id:"_votetype",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"census",id:"census",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"description",id:"description",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"endDate",id:"enddate",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"header",id:"header",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"meta",id:"meta",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"questions",id:"questions",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"startDate",id:"startdate",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"title",id:"title",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"voteType",id:"votetype",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"Methods",id:"methods-1",level:2},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"from",id:"from",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-30",level:4}],p={toc:o};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / Election"),(0,a.kt)("h1",{id:"class-election"},"Class: Election"),(0,a.kt)("p",null,"Represents an election"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Election"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"PublishedElection"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_addsdkversion"},"_","addSDKVersion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_census"},"_","census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_description"},"_","description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_electiontype"},"_","electionType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_enddate"},"_","endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_header"},"_","header")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_maxcensussize"},"_","maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_meta"},"_","meta")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_questions"},"_","questions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_startdate"},"_","startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_streamuri"},"_","streamUri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_temporarysecretidentity"},"_","temporarySecretIdentity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_title"},"_","title")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_votetype"},"_","voteType"))),(0,a.kt)("h3",{id:"accessors"},"Accessors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#addsdkversion"},"addSDKVersion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#census"},"census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#description"},"description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#electiontype"},"electionType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#enddate"},"endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#header"},"header")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#maxcensussize"},"maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#meta"},"meta")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#questions"},"questions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#startdate"},"startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#streamuri"},"streamUri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#temporarysecretidentity"},"temporarySecretIdentity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#title"},"title")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#votetype"},"voteType"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#get"},"get")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#from"},"from"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new Election"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},(0,a.kt)("inlineCode",{parentName:"a"},"Election"))),(0,a.kt)("p",null,"Constructs an election"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IElectionParameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"Election parameters")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},(0,a.kt)("inlineCode",{parentName:"a"},"Election"))),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L182"},"types/election/election.ts:182")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"_addsdkversion"},"_","addSDKVersion"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","addSDKVersion"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L175"},"types/election/election.ts:175")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_census"},"_","census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","census"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L172"},"types/election/election.ts:172")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_description"},"_","description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L163"},"types/election/election.ts:163")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_electiontype"},"_","electionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","electionType"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L169"},"types/election/election.ts:169")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_enddate"},"_","endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","endDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L168"},"types/election/election.ts:168")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_header"},"_","header"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","header"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L164"},"types/election/election.ts:164")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_maxcensussize"},"_","maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","maxCensusSize"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L173"},"types/election/election.ts:173")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_meta"},"_","meta"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","meta"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L166"},"types/election/election.ts:166")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_questions"},"_","questions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","questions"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L171"},"types/election/election.ts:171")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_startdate"},"_","startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","startDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L167"},"types/election/election.ts:167")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_streamuri"},"_","streamUri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","streamUri"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L165"},"types/election/election.ts:165")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_temporarysecretidentity"},"_","temporarySecretIdentity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","temporarySecretIdentity"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L174"},"types/election/election.ts:174")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_title"},"_","title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","title"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L162"},"types/election/election.ts:162")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_votetype"},"_","voteType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","voteType"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L170"},"types/election/election.ts:170")),(0,a.kt)("h2",{id:"accessors-1"},"Accessors"),(0,a.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"addSDKVersion"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L262"},"types/election/election.ts:262")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"census"},"census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"census"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L250"},"types/election/election.ts:250")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"description"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L214"},"types/election/election.ts:214")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"electiontype"},"electionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"electionType"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L238"},"types/election/election.ts:238")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enddate"},"endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"endDate"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L234"},"types/election/election.ts:234")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"header"},"header"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"header"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L218"},"types/election/election.ts:218")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L254"},"types/election/election.ts:254")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"meta"},"meta"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"meta"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L226"},"types/election/election.ts:226")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"questions"},"questions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"questions"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"returns-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L246"},"types/election/election.ts:246")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"startdate"},"startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"startDate"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"returns-10"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L230"},"types/election/election.ts:230")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"streamuri"},"streamUri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"streamUri"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-11"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L222"},"types/election/election.ts:222")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-12"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L258"},"types/election/election.ts:258")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"title"},"title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"title"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"returns-13"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L210"},"types/election/election.ts:210")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votetype"},"voteType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"voteType"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"returns-14"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L242"},"types/election/election.ts:242")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"get"},"get"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"get"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"dot"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"dot")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-15"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L266"},"types/election/election.ts:266")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"from"},"from"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"from"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("p",null,"Returns an unpublished election object"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IElectionParameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"Unpublished Election parameters")))),(0,a.kt)("h4",{id:"returns-16"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L206"},"types/election/election.ts:206")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0bcfcae9.57beca53.js b/assets/js/0bcfcae9.57beca53.js new file mode 100644 index 000000000..4fdc4f5d0 --- /dev/null +++ b/assets/js/0bcfcae9.57beca53.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6891],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var i=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function r(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=i.createContext({}),p=function(e){var t=i.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},s=function(e){var t=p(e.components);return i.createElement(d.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),k=p(n),u=a,m=k["".concat(d,".").concat(u)]||k[u]||c[u]||l;return n?i.createElement(m,r(r({ref:t},s),{},{components:n})):i.createElement(m,r({ref:t},s))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,r=new Array(l);r[0]=k;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:a,r[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>r,default:()=>c,frontMatter:()=>l,metadata:()=>o,toc:()=>p});var i=n(87462),a=(n(67294),n(3905));const l={},r=void 0,o={unversionedId:"sdk/reference/classes/Election",id:"sdk/reference/classes/Election",title:"Election",description:"@vocdoni/sdk / Exports / Election",source:"@site/docs/sdk/reference/classes/Election.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Election",permalink:"/sdk/reference/classes/Election",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CspVote",permalink:"/sdk/reference/classes/CspVote"},next:{title:"ElectionAPI",permalink:"/sdk/reference/classes/ElectionAPI"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_addSDKVersion",id:"_addsdkversion",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"_census",id:"_census",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"_description",id:"_description",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"_electionType",id:"_electiontype",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"_endDate",id:"_enddate",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"_header",id:"_header",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"_maxCensusSize",id:"_maxcensussize",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"_meta",id:"_meta",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"_questions",id:"_questions",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"_startDate",id:"_startdate",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"_streamUri",id:"_streamuri",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"_temporarySecretIdentity",id:"_temporarysecretidentity",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"_title",id:"_title",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"_voteType",id:"_votetype",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"census",id:"census",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"description",id:"description",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"endDate",id:"enddate",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"header",id:"header",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"meta",id:"meta",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"questions",id:"questions",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"startDate",id:"startdate",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"title",id:"title",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"voteType",id:"votetype",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"Methods",id:"methods-1",level:2},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"from",id:"from",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-30",level:4}],s={toc:p};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / Election"),(0,a.kt)("h1",{id:"class-election"},"Class: Election"),(0,a.kt)("p",null,"Represents an election"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Election"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"PublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"PublishedElection"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_addsdkversion"},"_","addSDKVersion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_census"},"_","census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_description"},"_","description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_electiontype"},"_","electionType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_enddate"},"_","endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_header"},"_","header")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_maxcensussize"},"_","maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_meta"},"_","meta")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_questions"},"_","questions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_startdate"},"_","startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_streamuri"},"_","streamUri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_temporarysecretidentity"},"_","temporarySecretIdentity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_title"},"_","title")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election#_votetype"},"_","voteType"))),(0,a.kt)("h3",{id:"accessors"},"Accessors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#addsdkversion"},"addSDKVersion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#census"},"census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#description"},"description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#electiontype"},"electionType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#enddate"},"endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#header"},"header")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#maxcensussize"},"maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#meta"},"meta")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#questions"},"questions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#startdate"},"startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#streamuri"},"streamUri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#temporarysecretidentity"},"temporarySecretIdentity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#title"},"title")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#votetype"},"voteType"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#get"},"get")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Election#from"},"from"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new Election"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,a.kt)("a",{parentName:"p",href:"Election"},(0,a.kt)("inlineCode",{parentName:"a"},"Election"))),(0,a.kt)("p",null,"Constructs an election"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IElectionParameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"Election parameters")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"Election"},(0,a.kt)("inlineCode",{parentName:"a"},"Election"))),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L182"},"types/election/election.ts:182")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"_addsdkversion"},"_","addSDKVersion"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","addSDKVersion"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L175"},"types/election/election.ts:175")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_census"},"_","census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","census"),": ",(0,a.kt)("a",{parentName:"p",href:"Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L172"},"types/election/election.ts:172")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_description"},"_","description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L163"},"types/election/election.ts:163")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_electiontype"},"_","electionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","electionType"),": ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L169"},"types/election/election.ts:169")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_enddate"},"_","endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","endDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L168"},"types/election/election.ts:168")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_header"},"_","header"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","header"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L164"},"types/election/election.ts:164")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_maxcensussize"},"_","maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","maxCensusSize"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L173"},"types/election/election.ts:173")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_meta"},"_","meta"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","meta"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L166"},"types/election/election.ts:166")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_questions"},"_","questions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","questions"),": ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L171"},"types/election/election.ts:171")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_startdate"},"_","startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","startDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L167"},"types/election/election.ts:167")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_streamuri"},"_","streamUri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","streamUri"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L165"},"types/election/election.ts:165")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_temporarysecretidentity"},"_","temporarySecretIdentity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","temporarySecretIdentity"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L174"},"types/election/election.ts:174")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_title"},"_","title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","title"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L162"},"types/election/election.ts:162")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_votetype"},"_","voteType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","voteType"),": ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L170"},"types/election/election.ts:170")),(0,a.kt)("h2",{id:"accessors-1"},"Accessors"),(0,a.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"addSDKVersion"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L262"},"types/election/election.ts:262")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"census"},"census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"census"),"(): ",(0,a.kt)("a",{parentName:"p",href:"Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L250"},"types/election/election.ts:250")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"description"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L214"},"types/election/election.ts:214")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"electiontype"},"electionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"electionType"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L238"},"types/election/election.ts:238")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enddate"},"endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"endDate"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L234"},"types/election/election.ts:234")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"header"},"header"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"header"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L218"},"types/election/election.ts:218")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L254"},"types/election/election.ts:254")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"meta"},"meta"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"meta"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L226"},"types/election/election.ts:226")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"questions"},"questions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"questions"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"returns-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L246"},"types/election/election.ts:246")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"startdate"},"startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"startDate"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"returns-10"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L230"},"types/election/election.ts:230")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"streamuri"},"streamUri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"streamUri"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-11"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L222"},"types/election/election.ts:222")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-12"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L258"},"types/election/election.ts:258")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"title"},"title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"title"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"returns-13"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L210"},"types/election/election.ts:210")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votetype"},"voteType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"voteType"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"returns-14"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L242"},"types/election/election.ts:242")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"get"},"get"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"get"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"dot"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"dot")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-15"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L266"},"types/election/election.ts:266")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"from"},"from"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"from"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("p",null,"Returns an unpublished election object"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IElectionParameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"Unpublished Election parameters")))),(0,a.kt)("h4",{id:"returns-16"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L206"},"types/election/election.ts:206")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0f556ffa.74cc1ee4.js b/assets/js/0f556ffa.652684b9.js similarity index 78% rename from assets/js/0f556ffa.74cc1ee4.js rename to assets/js/0f556ffa.652684b9.js index 91e76773c..a4471951e 100644 --- a/assets/js/0f556ffa.74cc1ee4.js +++ b/assets/js/0f556ffa.652684b9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2467],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>f});var r=n(67294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function p(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var a=r.createContext({}),c=function(e){var t=r.useContext(a),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},l=function(e){var t=c(e.components);return r.createElement(a.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,s=e.mdxType,o=e.originalType,a=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),d=c(n),f=s,k=d["".concat(a,".").concat(f)]||d[f]||u[f]||o;return n?r.createElement(k,p(p({ref:t},l),{},{components:n})):r.createElement(k,p({ref:t},l))}));function f(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var o=n.length,p=new Array(o);p[0]=d;var i={};for(var a in t)hasOwnProperty.call(t,a)&&(i[a]=t[a]);i.originalType=e,i.mdxType="string"==typeof e?e:s,p[1]=i;for(var c=2;c{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>p,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=n(87462),s=(n(67294),n(3905));const o={},p=void 0,i={unversionedId:"sdk/reference/interfaces/ICensus3TokenTypesResponse",id:"sdk/reference/interfaces/ICensus3TokenTypesResponse",title:"ICensus3TokenTypesResponse",description:"@vocdoni/sdk / Exports / ICensus3TokenTypesResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3TokenTypesResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3TokenTypesResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenTypesResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3TokenListResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated"},next:{title:"ICensus3ValidatePredicateChild",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateChild"}},a={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"supportedTypes",id:"supportedtypes",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:c};function u(e){let{components:t,...n}=e;return(0,s.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3TokenTypesResponse"),(0,s.kt)("h1",{id:"interface-icensus3tokentypesresponse"},"Interface: ICensus3TokenTypesResponse"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3TokenTypesResponse#supportedtypes"},"supportedTypes"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"supportedtypes"},"supportedTypes"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"supportedTypes"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,s.kt)("p",null,"The list of the tokens types"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/token.ts#L131"},"api/census3/token.ts:131")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2467],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>f});var r=n(67294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function p(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var a=r.createContext({}),c=function(e){var t=r.useContext(a),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},l=function(e){var t=c(e.components);return r.createElement(a.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,s=e.mdxType,o=e.originalType,a=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),d=c(n),f=s,k=d["".concat(a,".").concat(f)]||d[f]||u[f]||o;return n?r.createElement(k,p(p({ref:t},l),{},{components:n})):r.createElement(k,p({ref:t},l))}));function f(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var o=n.length,p=new Array(o);p[0]=d;var i={};for(var a in t)hasOwnProperty.call(t,a)&&(i[a]=t[a]);i.originalType=e,i.mdxType="string"==typeof e?e:s,p[1]=i;for(var c=2;c{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>p,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=n(87462),s=(n(67294),n(3905));const o={},p=void 0,i={unversionedId:"sdk/reference/interfaces/ICensus3TokenTypesResponse",id:"sdk/reference/interfaces/ICensus3TokenTypesResponse",title:"ICensus3TokenTypesResponse",description:"@vocdoni/sdk / Exports / ICensus3TokenTypesResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3TokenTypesResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3TokenTypesResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenTypesResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3TokenListResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated"},next:{title:"ICensus3ValidatePredicateChild",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateChild"}},a={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"supportedTypes",id:"supportedtypes",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:c};function u(e){let{components:t,...n}=e;return(0,s.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3TokenTypesResponse"),(0,s.kt)("h1",{id:"interface-icensus3tokentypesresponse"},"Interface: ICensus3TokenTypesResponse"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus3TokenTypesResponse#supportedtypes"},"supportedTypes"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"supportedtypes"},"supportedTypes"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"supportedTypes"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,s.kt)("p",null,"The list of the tokens types"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/token.ts#L131"},"api/census3/token.ts:131")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0fa69d70.eb726a34.js b/assets/js/0fa69d70.afd06fea.js similarity index 68% rename from assets/js/0fa69d70.eb726a34.js rename to assets/js/0fa69d70.afd06fea.js index f83c0e731..9ea6e8912 100644 --- a/assets/js/0fa69d70.eb726a34.js +++ b/assets/js/0fa69d70.afd06fea.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1371],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>d});var r=t(67294);function s(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(s[t]=e[t]);return s}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(s[t]=e[t])}return s}var l=r.createContext({}),c=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},p=function(e){var n=c(e.components);return r.createElement(l.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},f=r.forwardRef((function(e,n){var t=e.components,s=e.mdxType,i=e.originalType,l=e.parentName,p=a(e,["components","mdxType","originalType","parentName"]),f=c(t),d=s,k=f["".concat(l,".").concat(d)]||f[d]||u[d]||i;return t?r.createElement(k,o(o({ref:n},p),{},{components:t})):r.createElement(k,o({ref:n},p))}));function d(e,n){var t=arguments,s=n&&n.mdxType;if("string"==typeof e||s){var i=t.length,o=new Array(i);o[0]=f;var a={};for(var l in n)hasOwnProperty.call(n,l)&&(a[l]=n[l]);a.originalType=e,a.mdxType="string"==typeof e?e:s,o[1]=a;for(var c=2;c{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var r=t(87462),s=(t(67294),t(3905));const i={},o=void 0,a={unversionedId:"sdk/reference/interfaces/ICensusPublishResponse",id:"sdk/reference/interfaces/ICensusPublishResponse",title:"ICensusPublishResponse",description:"@vocdoni/sdk / Exports / ICensusPublishResponse",source:"@site/docs/sdk/reference/interfaces/ICensusPublishResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensusPublishResponse",permalink:"/sdk/reference/interfaces/ICensusPublishResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensusProofResponse",permalink:"/sdk/reference/interfaces/ICensusProofResponse"},next:{title:"IChainBlockInfoResponse",permalink:"/sdk/reference/interfaces/IChainBlockInfoResponse"}},l={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"censusID",id:"censusid",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"uri",id:"uri",level:3},{value:"Defined in",id:"defined-in-1",level:4}],p={toc:c};function u(e){let{components:n,...t}=e;return(0,s.kt)("wrapper",(0,r.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensusPublishResponse"),(0,s.kt)("h1",{id:"interface-icensuspublishresponse"},"Interface: ICensusPublishResponse"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusPublishResponse#censusid"},"censusID")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusPublishResponse#uri"},"uri"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"censusid"},"censusID"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"censusID"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The identifier of the published census"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L32"},"api/census.ts:32")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"uri"},"uri"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"uri"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The URI of the published census"),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L37"},"api/census.ts:37")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1371],{3905:(e,n,t)=>{t.d(n,{Zo:()=>u,kt:()=>d});var r=t(67294);function s(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(s[t]=e[t]);return s}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(s[t]=e[t])}return s}var l=r.createContext({}),p=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},u=function(e){var n=p(e.components);return r.createElement(l.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},f=r.forwardRef((function(e,n){var t=e.components,s=e.mdxType,i=e.originalType,l=e.parentName,u=a(e,["components","mdxType","originalType","parentName"]),f=p(t),d=s,k=f["".concat(l,".").concat(d)]||f[d]||c[d]||i;return t?r.createElement(k,o(o({ref:n},u),{},{components:t})):r.createElement(k,o({ref:n},u))}));function d(e,n){var t=arguments,s=n&&n.mdxType;if("string"==typeof e||s){var i=t.length,o=new Array(i);o[0]=f;var a={};for(var l in n)hasOwnProperty.call(n,l)&&(a[l]=n[l]);a.originalType=e,a.mdxType="string"==typeof e?e:s,o[1]=a;for(var p=2;p{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>a,toc:()=>p});var r=t(87462),s=(t(67294),t(3905));const i={},o=void 0,a={unversionedId:"sdk/reference/interfaces/ICensusPublishResponse",id:"sdk/reference/interfaces/ICensusPublishResponse",title:"ICensusPublishResponse",description:"@vocdoni/sdk / Exports / ICensusPublishResponse",source:"@site/docs/sdk/reference/interfaces/ICensusPublishResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensusPublishResponse",permalink:"/sdk/reference/interfaces/ICensusPublishResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensusProofResponse",permalink:"/sdk/reference/interfaces/ICensusProofResponse"},next:{title:"IChainBlockInfoResponse",permalink:"/sdk/reference/interfaces/IChainBlockInfoResponse"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"censusID",id:"censusid",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"uri",id:"uri",level:3},{value:"Defined in",id:"defined-in-1",level:4}],u={toc:p};function c(e){let{components:n,...t}=e;return(0,s.kt)("wrapper",(0,r.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensusPublishResponse"),(0,s.kt)("h1",{id:"interface-icensuspublishresponse"},"Interface: ICensusPublishResponse"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensusPublishResponse#censusid"},"censusID")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensusPublishResponse#uri"},"uri"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"censusid"},"censusID"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"censusID"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The identifier of the published census"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L32"},"api/census.ts:32")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"uri"},"uri"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"uri"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The URI of the published census"),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L37"},"api/census.ts:37")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0fc92a72.e1b7f00c.js b/assets/js/0fc92a72.afe1a9dd.js similarity index 65% rename from assets/js/0fc92a72.e1b7f00c.js rename to assets/js/0fc92a72.afe1a9dd.js index 4cae76bce..33d6a4dd5 100644 --- a/assets/js/0fc92a72.e1b7f00c.js +++ b/assets/js/0fc92a72.afe1a9dd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5253],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>f});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),c=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},d=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),u=c(r),f=a,k=u["".concat(l,".").concat(f)]||u[f]||p[f]||i;return r?n.createElement(k,s(s({ref:t},d),{},{components:r})):n.createElement(k,s({ref:t},d))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,s=new Array(i);s[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,s[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var n=r(87462),a=(r(67294),r(3905));const i={},s=void 0,o={unversionedId:"sdk/reference/interfaces/ICensus3ValidatePredicateChild",id:"sdk/reference/interfaces/ICensus3ValidatePredicateChild",title:"ICensus3ValidatePredicateChild",description:"@vocdoni/sdk / Exports / ICensus3ValidatePredicateChild",source:"@site/docs/sdk/reference/interfaces/ICensus3ValidatePredicateChild.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3ValidatePredicateChild",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateChild",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3TokenTypesResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenTypesResponse"},next:{title:"ICensus3ValidatePredicateResponse",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse"}},l={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"operator",id:"operator",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"tokens",id:"tokens",level:3},{value:"Defined in",id:"defined-in-1",level:4}],d={toc:c};function p(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3ValidatePredicateChild"),(0,a.kt)("h1",{id:"interface-icensus3validatepredicatechild"},"Interface: ICensus3ValidatePredicateChild"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3ValidatePredicateChild#operator"},"operator")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3ValidatePredicateChild#tokens"},"tokens"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"operator"},"operator"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"operator"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The operator used in the predicate"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L211"},"api/census3/strategy.ts:211")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"tokens"},"tokens"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"tokens"),": (",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3ValidatePredicateToken"},(0,a.kt)("inlineCode",{parentName:"a"},"ICensus3ValidatePredicateToken"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3ValidatePredicateChild"},(0,a.kt)("inlineCode",{parentName:"a"},"ICensus3ValidatePredicateChild")),")[]"),(0,a.kt)("p",null,"The list of tokens of the predicate"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L216"},"api/census3/strategy.ts:216")))}p.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5253],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>f});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),d=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},c=function(e){var t=d(e.components);return n.createElement(l.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),u=d(r),f=a,k=u["".concat(l,".").concat(f)]||u[f]||p[f]||i;return r?n.createElement(k,s(s({ref:t},c),{},{components:r})):n.createElement(k,s({ref:t},c))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,s=new Array(i);s[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,s[1]=o;for(var d=2;d{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var n=r(87462),a=(r(67294),r(3905));const i={},s=void 0,o={unversionedId:"sdk/reference/interfaces/ICensus3ValidatePredicateChild",id:"sdk/reference/interfaces/ICensus3ValidatePredicateChild",title:"ICensus3ValidatePredicateChild",description:"@vocdoni/sdk / Exports / ICensus3ValidatePredicateChild",source:"@site/docs/sdk/reference/interfaces/ICensus3ValidatePredicateChild.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3ValidatePredicateChild",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateChild",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3TokenTypesResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenTypesResponse"},next:{title:"ICensus3ValidatePredicateResponse",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse"}},l={},d=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"operator",id:"operator",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"tokens",id:"tokens",level:3},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:d};function p(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3ValidatePredicateChild"),(0,a.kt)("h1",{id:"interface-icensus3validatepredicatechild"},"Interface: ICensus3ValidatePredicateChild"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3ValidatePredicateChild#operator"},"operator")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3ValidatePredicateChild#tokens"},"tokens"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"operator"},"operator"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"operator"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The operator used in the predicate"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L211"},"api/census3/strategy.ts:211")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"tokens"},"tokens"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"tokens"),": (",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3ValidatePredicateToken"},(0,a.kt)("inlineCode",{parentName:"a"},"ICensus3ValidatePredicateToken"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"ICensus3ValidatePredicateChild"},(0,a.kt)("inlineCode",{parentName:"a"},"ICensus3ValidatePredicateChild")),")[]"),(0,a.kt)("p",null,"The list of tokens of the predicate"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L216"},"api/census3/strategy.ts:216")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/109756a8.1d6cc17b.js b/assets/js/109756a8.1d6cc17b.js new file mode 100644 index 000000000..68c612e84 --- /dev/null +++ b/assets/js/109756a8.1d6cc17b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2870],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>m});var i=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=i.createContext({}),o=function(e){var t=i.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=o(e.components);return i.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},u=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,p=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),u=o(n),m=a,h=u["".concat(p,".").concat(m)]||u[m]||k[m]||r;return n?i.createElement(h,l(l({ref:t},s),{},{components:n})):i.createElement(h,l({ref:t},s))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,l=new Array(r);l[0]=u;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:a,l[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>k,frontMatter:()=>r,metadata:()=>d,toc:()=>o});var i=n(87462),a=(n(67294),n(3905));const r={},l=void 0,d={unversionedId:"sdk/reference/classes/ApprovalElection",id:"sdk/reference/classes/ApprovalElection",title:"ApprovalElection",description:"@vocdoni/sdk / Exports / ApprovalElection",source:"@site/docs/sdk/reference/classes/ApprovalElection.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/ApprovalElection",permalink:"/sdk/reference/classes/ApprovalElection",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"AnonymousVote",permalink:"/sdk/reference/classes/AnonymousVote"},next:{title:"ArchivedElection",permalink:"/sdk/reference/classes/ArchivedElection"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_addSDKVersion",id:"_addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_census",id:"_census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_description",id:"_description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"_electionType",id:"_electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"_endDate",id:"_enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"_header",id:"_header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"_maxCensusSize",id:"_maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"_meta",id:"_meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"_questions",id:"_questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"_startDate",id:"_startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"_streamUri",id:"_streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"_temporarySecretIdentity",id:"_temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"_title",id:"_title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"_voteType",id:"_votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"census",id:"census",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"description",id:"description",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"duration",id:"duration",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"endDate",id:"enddate",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"header",id:"header",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-25",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-26",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-27",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-28",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"meta",id:"meta",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-29",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-30",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"questions",id:"questions",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-31",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-32",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"startDate",id:"startdate",level:3},{value:"Returns",id:"returns-20",level:4},{value:"Inherited from",id:"inherited-from-33",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Inherited from",id:"inherited-from-34",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Returns",id:"returns-22",level:4},{value:"Inherited from",id:"inherited-from-35",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Inherited from",id:"inherited-from-36",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Returns",id:"returns-24",level:4},{value:"Inherited from",id:"inherited-from-37",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Inherited from",id:"inherited-from-38",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"title",id:"title",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Inherited from",id:"inherited-from-39",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Inherited from",id:"inherited-from-40",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"voteType",id:"votetype",level:3},{value:"Returns",id:"returns-28",level:4},{value:"Inherited from",id:"inherited-from-41",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Inherited from",id:"inherited-from-42",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"Methods",id:"methods-1",level:2},{value:"addQuestion",id:"addquestion",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"generateEnvelopeType",id:"generateenvelopetype",level:3},{value:"Returns",id:"returns-31",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"generateMetadata",id:"generatemetadata",level:3},{value:"Returns",id:"returns-32",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"generateMode",id:"generatemode",level:3},{value:"Returns",id:"returns-33",level:4},{value:"Inherited from",id:"inherited-from-43",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"generateVoteOptions",id:"generatevoteoptions",level:3},{value:"Returns",id:"returns-34",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Inherited from",id:"inherited-from-44",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"removeQuestion",id:"removequestion",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Inherited from",id:"inherited-from-45",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"checkVote",id:"checkvote",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"from",id:"from",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-38",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-52",level:4}],s={toc:o};function k(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ApprovalElection"),(0,a.kt)("h1",{id:"class-approvalelection"},"Class: ApprovalElection"),(0,a.kt)("p",null,"Represents an approval election"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ApprovalElection"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_addsdkversion"},"_","addSDKVersion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_census"},"_","census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_description"},"_","description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_electiontype"},"_","electionType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_enddate"},"_","endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_header"},"_","header")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_maxcensussize"},"_","maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_meta"},"_","meta")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_questions"},"_","questions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_startdate"},"_","startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_streamuri"},"_","streamUri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_temporarysecretidentity"},"_","temporarySecretIdentity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_title"},"_","title")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_votetype"},"_","voteType"))),(0,a.kt)("h3",{id:"accessors"},"Accessors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#addsdkversion"},"addSDKVersion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#census"},"census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#description"},"description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#duration"},"duration")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#electiontype"},"electionType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#enddate"},"endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#header"},"header")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#maxcensussize"},"maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#meta"},"meta")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#questions"},"questions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#startdate"},"startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#streamuri"},"streamUri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#temporarysecretidentity"},"temporarySecretIdentity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#title"},"title")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#votetype"},"voteType"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#addquestion"},"addQuestion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#generateenvelopetype"},"generateEnvelopeType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#generatemetadata"},"generateMetadata")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#generatemode"},"generateMode")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#generatevoteoptions"},"generateVoteOptions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#get"},"get")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#removequestion"},"removeQuestion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#checkvote"},"checkVote")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ApprovalElection#from"},"from"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new ApprovalElection"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"ApprovalElection"},(0,a.kt)("inlineCode",{parentName:"a"},"ApprovalElection"))),(0,a.kt)("p",null,"Constructs an approval election"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IApprovalElectionParameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IApprovalElectionParameters"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"Approval election parameters")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"ApprovalElection"},(0,a.kt)("inlineCode",{parentName:"a"},"ApprovalElection"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/approval.ts#L18"},"types/election/approval.ts:18")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"_addsdkversion"},"_","addSDKVersion"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","addSDKVersion"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_addsdkversion"},"_addSDKVersion")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L175"},"types/election/election.ts:175")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_census"},"_","census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","census"),": ",(0,a.kt)("a",{parentName:"p",href:"Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_census"},"_census")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L172"},"types/election/election.ts:172")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_description"},"_","description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_description"},"_description")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L163"},"types/election/election.ts:163")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_electiontype"},"_","electionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","electionType"),": ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_electiontype"},"_electionType")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L169"},"types/election/election.ts:169")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_enddate"},"_","endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","endDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_enddate"},"_endDate")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L168"},"types/election/election.ts:168")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_header"},"_","header"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","header"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_header"},"_header")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L164"},"types/election/election.ts:164")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_maxcensussize"},"_","maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","maxCensusSize"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_maxcensussize"},"_maxCensusSize")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L173"},"types/election/election.ts:173")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_meta"},"_","meta"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","meta"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_meta"},"_meta")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L166"},"types/election/election.ts:166")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_questions"},"_","questions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","questions"),": ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_questions"},"_questions")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L171"},"types/election/election.ts:171")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_startdate"},"_","startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","startDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_startdate"},"_startDate")),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L167"},"types/election/election.ts:167")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_streamuri"},"_","streamUri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","streamUri"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_streamuri"},"_streamUri")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L165"},"types/election/election.ts:165")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_temporarysecretidentity"},"_","temporarySecretIdentity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","temporarySecretIdentity"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_temporarysecretidentity"},"_temporarySecretIdentity")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L174"},"types/election/election.ts:174")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_title"},"_","title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","title"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_title"},"_title")),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L162"},"types/election/election.ts:162")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_votetype"},"_","voteType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","voteType"),": ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_votetype"},"_voteType")),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L170"},"types/election/election.ts:170")),(0,a.kt)("h2",{id:"accessors-1"},"Accessors"),(0,a.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"addSDKVersion"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.addSDKVersion"),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L275"},"types/election/unpublished.ts:275")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"addSDKVersion"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.addSDKVersion"),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L279"},"types/election/unpublished.ts:279")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"census"},"census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"census"),"(): ",(0,a.kt)("a",{parentName:"p",href:"Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.census"),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L249"},"types/election/unpublished.ts:249")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"census"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census")))))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.census"),(0,a.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L253"},"types/election/unpublished.ts:253")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"description"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.description"),(0,a.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L173"},"types/election/unpublished.ts:173")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"description"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.description"),(0,a.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L177"},"types/election/unpublished.ts:177")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"duration"},"duration"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"duration"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.duration"),(0,a.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L138"},"types/election/unpublished.ts:138")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"electiontype"},"electionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"electionType"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"inherited-from-21"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.electionType"),(0,a.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L225"},"types/election/unpublished.ts:225")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"electionType"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-4"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType")))))),(0,a.kt)("h4",{id:"returns-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-22"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.electionType"),(0,a.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L229"},"types/election/unpublished.ts:229")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enddate"},"endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"endDate"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"returns-10"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-23"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.endDate"),(0,a.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L215"},"types/election/unpublished.ts:215")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"endDate"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-5"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,a.kt)("h4",{id:"returns-11"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-24"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.endDate"),(0,a.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L219"},"types/election/unpublished.ts:219")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"header"},"header"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"header"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-12"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-25"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.header"),(0,a.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L181"},"types/election/unpublished.ts:181")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"header"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-6"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-13"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-26"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.header"),(0,a.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L185"},"types/election/unpublished.ts:185")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-14"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-27"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.maxCensusSize"),(0,a.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L258"},"types/election/unpublished.ts:258")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-7"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-15"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-28"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.maxCensusSize"),(0,a.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L262"},"types/election/unpublished.ts:262")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"meta"},"meta"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"meta"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"returns-16"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-29"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.meta"),(0,a.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L197"},"types/election/unpublished.ts:197")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"meta"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-8"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"any"))))),(0,a.kt)("h4",{id:"returns-17"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-30"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.meta"),(0,a.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L201"},"types/election/unpublished.ts:201")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"questions"},"questions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"questions"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"returns-18"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"inherited-from-31"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.questions"),(0,a.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L241"},"types/election/unpublished.ts:241")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"questions"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-9"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]")))),(0,a.kt)("h4",{id:"returns-19"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-32"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.questions"),(0,a.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L245"},"types/election/unpublished.ts:245")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"startdate"},"startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"startDate"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"returns-20"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-33"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.startDate"),(0,a.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L206"},"types/election/unpublished.ts:206")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"startDate"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-10"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,a.kt)("h4",{id:"returns-21"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-34"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.startDate"),(0,a.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L210"},"types/election/unpublished.ts:210")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"streamuri"},"streamUri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"streamUri"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-22"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-35"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.streamUri"),(0,a.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L189"},"types/election/unpublished.ts:189")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"streamUri"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-11"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-23"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-36"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.streamUri"),(0,a.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L193"},"types/election/unpublished.ts:193")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-24"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-37"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.temporarySecretIdentity"),(0,a.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L267"},"types/election/unpublished.ts:267")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-12"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-25"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-38"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.temporarySecretIdentity"),(0,a.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L271"},"types/election/unpublished.ts:271")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"title"},"title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"title"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"returns-26"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-39"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.title"),(0,a.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L164"},"types/election/unpublished.ts:164")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"title"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-13"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,a.kt)("h4",{id:"returns-27"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-40"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.title"),(0,a.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L168"},"types/election/unpublished.ts:168")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votetype"},"voteType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"voteType"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"returns-28"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"inherited-from-41"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.voteType"),(0,a.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L233"},"types/election/unpublished.ts:233")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"voteType"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-14"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,a.kt)("h4",{id:"returns-29"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-42"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.voteType"),(0,a.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L237"},"types/election/unpublished.ts:237")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"addquestion"},"addQuestion"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"addQuestion"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"title"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"description"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"choices"),"): ",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"parameters-15"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"title")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"description")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"choices")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(","{"," ",(0,a.kt)("inlineCode",{parentName:"td"},"title"),": ",(0,a.kt)("inlineCode",{parentName:"td"},"string")," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"td"},"title"),": ",(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">"," })[]")))),(0,a.kt)("h4",{id:"returns-30"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#addquestion"},"addQuestion")),(0,a.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/approval.ts#L26"},"types/election/approval.ts:26")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generateenvelopetype"},"generateEnvelopeType"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateEnvelopeType"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"returns-31"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"overrides-2"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#generateenvelopetype"},"generateEnvelopeType")),(0,a.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/approval.ts#L55"},"types/election/approval.ts:55")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generatemetadata"},"generateMetadata"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateMetadata"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/ElectionMetadata"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,a.kt)("h4",{id:"returns-32"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../interfaces/ElectionMetadata"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,a.kt)("h4",{id:"overrides-3"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#generatemetadata"},"generateMetadata")),(0,a.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/approval.ts#L65"},"types/election/approval.ts:65")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generatemode"},"generateMode"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateMode"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"returns-33"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"inherited-from-43"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#generatemode"},"generateMode")),(0,a.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L154"},"types/election/unpublished.ts:154")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generatevoteoptions"},"generateVoteOptions"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateVoteOptions"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"returns-34"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"overrides-4"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#generatevoteoptions"},"generateVoteOptions")),(0,a.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/approval.ts#L45"},"types/election/approval.ts:45")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"get"},"get"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"get"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"dot"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"parameters-16"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"dot")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-35"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-44"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#get"},"get")),(0,a.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L266"},"types/election/election.ts:266")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"removequestion"},"removeQuestion"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"removeQuestion"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"questionNumber"),"): ",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"parameters-17"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"questionNumber")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-36"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"inherited-from-45"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#removequestion"},"removeQuestion")),(0,a.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L60"},"types/election/unpublished.ts:60")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"checkvote"},"checkVote"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"checkVote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"vote"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"voteType"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-18"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"vote")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote")))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"voteType")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,a.kt)("h4",{id:"returns-37"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/approval.ts#L79"},"types/election/approval.ts:79")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"from"},"from"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"from"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"ApprovalElection"},(0,a.kt)("inlineCode",{parentName:"a"},"ApprovalElection"))),(0,a.kt)("p",null,"Returns an unpublished election object"),(0,a.kt)("h4",{id:"parameters-19"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IApprovalElectionParameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IApprovalElectionParameters"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"Unpublished Election parameters")))),(0,a.kt)("h4",{id:"returns-38"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"ApprovalElection"},(0,a.kt)("inlineCode",{parentName:"a"},"ApprovalElection"))),(0,a.kt)("h4",{id:"overrides-5"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#from"},"from")),(0,a.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/approval.ts#L22"},"types/election/approval.ts:22")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/109756a8.b0bf1752.js b/assets/js/109756a8.b0bf1752.js deleted file mode 100644 index d45feb224..000000000 --- a/assets/js/109756a8.b0bf1752.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2870],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>m});var a=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var p=a.createContext({}),s=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},o=function(e){var t=s(e.components);return a.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,p=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),u=s(n),m=i,c=u["".concat(p,".").concat(m)]||u[m]||k[m]||r;return n?a.createElement(c,l(l({ref:t},o),{},{components:n})):a.createElement(c,l({ref:t},o))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=u;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:i,l[1]=d;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>k,frontMatter:()=>r,metadata:()=>d,toc:()=>s});var a=n(87462),i=(n(67294),n(3905));const r={},l=void 0,d={unversionedId:"sdk/reference/classes/ApprovalElection",id:"sdk/reference/classes/ApprovalElection",title:"ApprovalElection",description:"@vocdoni/sdk / Exports / ApprovalElection",source:"@site/docs/sdk/reference/classes/ApprovalElection.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/ApprovalElection",permalink:"/sdk/reference/classes/ApprovalElection",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"AnonymousVote",permalink:"/sdk/reference/classes/AnonymousVote"},next:{title:"ArchivedElection",permalink:"/sdk/reference/classes/ArchivedElection"}},p={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_addSDKVersion",id:"_addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_census",id:"_census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_description",id:"_description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"_electionType",id:"_electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"_endDate",id:"_enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"_header",id:"_header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"_maxCensusSize",id:"_maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"_meta",id:"_meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"_questions",id:"_questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"_startDate",id:"_startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"_streamUri",id:"_streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"_temporarySecretIdentity",id:"_temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"_title",id:"_title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"_voteType",id:"_votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"census",id:"census",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"description",id:"description",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"duration",id:"duration",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"endDate",id:"enddate",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"header",id:"header",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-25",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-26",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-27",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-28",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"meta",id:"meta",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-29",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-30",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"questions",id:"questions",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-31",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-32",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"startDate",id:"startdate",level:3},{value:"Returns",id:"returns-20",level:4},{value:"Inherited from",id:"inherited-from-33",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Inherited from",id:"inherited-from-34",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Returns",id:"returns-22",level:4},{value:"Inherited from",id:"inherited-from-35",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Inherited from",id:"inherited-from-36",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Returns",id:"returns-24",level:4},{value:"Inherited from",id:"inherited-from-37",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Inherited from",id:"inherited-from-38",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"title",id:"title",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Inherited from",id:"inherited-from-39",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Inherited from",id:"inherited-from-40",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"voteType",id:"votetype",level:3},{value:"Returns",id:"returns-28",level:4},{value:"Inherited from",id:"inherited-from-41",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Inherited from",id:"inherited-from-42",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"Methods",id:"methods-1",level:2},{value:"addQuestion",id:"addquestion",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"generateEnvelopeType",id:"generateenvelopetype",level:3},{value:"Returns",id:"returns-31",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"generateMetadata",id:"generatemetadata",level:3},{value:"Returns",id:"returns-32",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"generateMode",id:"generatemode",level:3},{value:"Returns",id:"returns-33",level:4},{value:"Inherited from",id:"inherited-from-43",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"generateVoteOptions",id:"generatevoteoptions",level:3},{value:"Returns",id:"returns-34",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Inherited from",id:"inherited-from-44",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"removeQuestion",id:"removequestion",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Inherited from",id:"inherited-from-45",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"checkVote",id:"checkvote",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"from",id:"from",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-38",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-52",level:4}],o={toc:s};function k(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ApprovalElection"),(0,i.kt)("h1",{id:"class-approvalelection"},"Class: ApprovalElection"),(0,i.kt)("p",null,"Represents an approval election"),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"ApprovalElection"))))),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"constructors"},"Constructors"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#constructor"},"constructor"))),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_addsdkversion"},"_","addSDKVersion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_census"},"_","census")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_description"},"_","description")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_electiontype"},"_","electionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_enddate"},"_","endDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_header"},"_","header")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_maxcensussize"},"_","maxCensusSize")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_meta"},"_","meta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_questions"},"_","questions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_startdate"},"_","startDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_streamuri"},"_","streamUri")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_temporarysecretidentity"},"_","temporarySecretIdentity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_title"},"_","title")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#_votetype"},"_","voteType"))),(0,i.kt)("h3",{id:"accessors"},"Accessors"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#addsdkversion"},"addSDKVersion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#census"},"census")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#description"},"description")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#duration"},"duration")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#electiontype"},"electionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#enddate"},"endDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#header"},"header")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#maxcensussize"},"maxCensusSize")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#meta"},"meta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#questions"},"questions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#startdate"},"startDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#streamuri"},"streamUri")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#title"},"title")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#votetype"},"voteType"))),(0,i.kt)("h3",{id:"methods"},"Methods"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#addquestion"},"addQuestion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#generateenvelopetype"},"generateEnvelopeType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#generatemetadata"},"generateMetadata")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#generatemode"},"generateMode")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#generatevoteoptions"},"generateVoteOptions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#get"},"get")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#removequestion"},"removeQuestion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#checkvote"},"checkVote")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection#from"},"from"))),(0,i.kt)("h2",{id:"constructors-1"},"Constructors"),(0,i.kt)("h3",{id:"constructor"},"constructor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"new ApprovalElection"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ApprovalElection"},(0,i.kt)("inlineCode",{parentName:"a"},"ApprovalElection"))),(0,i.kt)("p",null,"Constructs an approval election"),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"params")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IApprovalElectionParameters"},(0,i.kt)("inlineCode",{parentName:"a"},"IApprovalElectionParameters"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"Approval election parameters")))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ApprovalElection"},(0,i.kt)("inlineCode",{parentName:"a"},"ApprovalElection"))),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#constructor"},"constructor")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/approval.ts#L18"},"types/election/approval.ts:18")),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"_addsdkversion"},"_","addSDKVersion"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","addSDKVersion"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_addsdkversion"},"_addSDKVersion")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L175"},"types/election/election.ts:175")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_census"},"_","census"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","census"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census"))),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_census"},"_census")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L172"},"types/election/election.ts:172")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_description"},"_","description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_description"},"_description")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L163"},"types/election/election.ts:163")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_electiontype"},"_","electionType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","electionType"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_electiontype"},"_electionType")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L169"},"types/election/election.ts:169")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_enddate"},"_","endDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","endDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_enddate"},"_endDate")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L168"},"types/election/election.ts:168")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_header"},"_","header"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","header"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_header"},"_header")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L164"},"types/election/election.ts:164")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_maxcensussize"},"_","maxCensusSize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","maxCensusSize"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_maxcensussize"},"_maxCensusSize")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L173"},"types/election/election.ts:173")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_meta"},"_","meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_meta"},"_meta")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L166"},"types/election/election.ts:166")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_questions"},"_","questions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","questions"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_questions"},"_questions")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L171"},"types/election/election.ts:171")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_startdate"},"_","startDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","startDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_startdate"},"_startDate")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L167"},"types/election/election.ts:167")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_streamuri"},"_","streamUri"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","streamUri"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_streamuri"},"_streamUri")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L165"},"types/election/election.ts:165")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_temporarysecretidentity"},"_","temporarySecretIdentity"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","temporarySecretIdentity"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_temporarysecretidentity"},"_temporarySecretIdentity")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L174"},"types/election/election.ts:174")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_title"},"_","title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_title"},"_title")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L162"},"types/election/election.ts:162")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_votetype"},"_","voteType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","voteType"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_votetype"},"_voteType")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L170"},"types/election/election.ts:170")),(0,i.kt)("h2",{id:"accessors-1"},"Accessors"),(0,i.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"addSDKVersion"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.addSDKVersion"),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L275"},"types/election/unpublished.ts:275")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"addSDKVersion"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.addSDKVersion"),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L279"},"types/election/unpublished.ts:279")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"census"},"census"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"census"),"(): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census"))),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census"))),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.census"),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L249"},"types/election/unpublished.ts:249")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"census"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-2"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census")))))),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.census"),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L253"},"types/election/unpublished.ts:253")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"description"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.description"),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L173"},"types/election/unpublished.ts:173")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"description"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-3"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,i.kt)("h4",{id:"returns-6"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.description"),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L177"},"types/election/unpublished.ts:177")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"duration"},"duration"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"duration"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"returns-7"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.duration"),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L138"},"types/election/unpublished.ts:138")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electiontype"},"electionType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"electionType"),"(): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"returns-8"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"inherited-from-21"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.electionType"),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L225"},"types/election/unpublished.ts:225")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"electionType"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-4"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType")))))),(0,i.kt)("h4",{id:"returns-9"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-22"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.electionType"),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L229"},"types/election/unpublished.ts:229")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enddate"},"endDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"endDate"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"returns-10"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-23"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.endDate"),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L215"},"types/election/unpublished.ts:215")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"endDate"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-5"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,i.kt)("h4",{id:"returns-11"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-24"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.endDate"),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L219"},"types/election/unpublished.ts:219")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"header"},"header"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"header"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-12"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-25"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.header"),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L181"},"types/election/unpublished.ts:181")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"header"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-6"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-13"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-26"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.header"),(0,i.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L185"},"types/election/unpublished.ts:185")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"maxCensusSize"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"returns-14"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"inherited-from-27"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.maxCensusSize"),(0,i.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L258"},"types/election/unpublished.ts:258")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"maxCensusSize"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-7"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-15"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-28"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.maxCensusSize"),(0,i.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L262"},"types/election/unpublished.ts:262")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"returns-16"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"inherited-from-29"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.meta"),(0,i.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L197"},"types/election/unpublished.ts:197")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-8"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"returns-17"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-30"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.meta"),(0,i.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L201"},"types/election/unpublished.ts:201")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"questions"},"questions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"questions"),"(): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"returns-18"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"inherited-from-31"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.questions"),(0,i.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L241"},"types/election/unpublished.ts:241")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"questions"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-9"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]")))),(0,i.kt)("h4",{id:"returns-19"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-32"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.questions"),(0,i.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L245"},"types/election/unpublished.ts:245")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"startdate"},"startDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"startDate"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"returns-20"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-33"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.startDate"),(0,i.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L206"},"types/election/unpublished.ts:206")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"startDate"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-10"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,i.kt)("h4",{id:"returns-21"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-34"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.startDate"),(0,i.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L210"},"types/election/unpublished.ts:210")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"streamuri"},"streamUri"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"streamUri"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-22"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-35"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.streamUri"),(0,i.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L189"},"types/election/unpublished.ts:189")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"streamUri"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-11"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-23"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-36"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.streamUri"),(0,i.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L193"},"types/election/unpublished.ts:193")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"returns-24"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"inherited-from-37"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.temporarySecretIdentity"),(0,i.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L267"},"types/election/unpublished.ts:267")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-12"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,i.kt)("h4",{id:"returns-25"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-38"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.temporarySecretIdentity"),(0,i.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L271"},"types/election/unpublished.ts:271")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"title"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"returns-26"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"inherited-from-39"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.title"),(0,i.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L164"},"types/election/unpublished.ts:164")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"title"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-13"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,i.kt)("h4",{id:"returns-27"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-40"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.title"),(0,i.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L168"},"types/election/unpublished.ts:168")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votetype"},"voteType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"voteType"),"(): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"returns-28"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"inherited-from-41"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.voteType"),(0,i.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L233"},"types/election/unpublished.ts:233")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"voteType"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-14"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,i.kt)("h4",{id:"returns-29"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"inherited-from-42"},"Inherited from"),(0,i.kt)("p",null,"UnpublishedElection.voteType"),(0,i.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L237"},"types/election/unpublished.ts:237")),(0,i.kt)("h2",{id:"methods-1"},"Methods"),(0,i.kt)("h3",{id:"addquestion"},"addQuestion"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"addQuestion"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"title"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"description"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"choices"),"): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("h4",{id:"parameters-15"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"title")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"description")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"choices")),(0,i.kt)("td",{parentName:"tr",align:"left"},"(","{"," ",(0,i.kt)("inlineCode",{parentName:"td"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"td"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),">"," })[]")))),(0,i.kt)("h4",{id:"returns-30"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#addquestion"},"addQuestion")),(0,i.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/approval.ts#L26"},"types/election/approval.ts:26")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generateenvelopetype"},"generateEnvelopeType"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"generateEnvelopeType"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"returns-31"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"overrides-2"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#generateenvelopetype"},"generateEnvelopeType")),(0,i.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/approval.ts#L55"},"types/election/approval.ts:55")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generatemetadata"},"generateMetadata"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"generateMetadata"),"(): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ElectionMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,i.kt)("h4",{id:"returns-32"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ElectionMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,i.kt)("h4",{id:"overrides-3"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#generatemetadata"},"generateMetadata")),(0,i.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/approval.ts#L65"},"types/election/approval.ts:65")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generatemode"},"generateMode"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"generateMode"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"returns-33"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"inherited-from-43"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#generatemode"},"generateMode")),(0,i.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L154"},"types/election/unpublished.ts:154")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generatevoteoptions"},"generateVoteOptions"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"generateVoteOptions"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"returns-34"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"overrides-4"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#generatevoteoptions"},"generateVoteOptions")),(0,i.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/approval.ts#L45"},"types/election/approval.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"get"},"get"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"get"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"dot"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"parameters-16"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"dot")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-35"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"inherited-from-44"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#get"},"get")),(0,i.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L266"},"types/election/election.ts:266")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"removequestion"},"removeQuestion"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"removeQuestion"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"questionNumber"),"): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("h4",{id:"parameters-17"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"questionNumber")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-36"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("h4",{id:"inherited-from-45"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#removequestion"},"removeQuestion")),(0,i.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L60"},"types/election/unpublished.ts:60")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"checkvote"},"checkVote"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"checkVote"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"vote"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"voteType"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-18"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"vote")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Vote"},(0,i.kt)("inlineCode",{parentName:"a"},"Vote")))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"voteType")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,i.kt)("h4",{id:"returns-37"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/approval.ts#L79"},"types/election/approval.ts:79")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"from"},"from"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"from"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ApprovalElection"},(0,i.kt)("inlineCode",{parentName:"a"},"ApprovalElection"))),(0,i.kt)("p",null,"Returns an unpublished election object"),(0,i.kt)("h4",{id:"parameters-19"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"params")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IApprovalElectionParameters"},(0,i.kt)("inlineCode",{parentName:"a"},"IApprovalElectionParameters"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"Unpublished Election parameters")))),(0,i.kt)("h4",{id:"returns-38"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ApprovalElection"},(0,i.kt)("inlineCode",{parentName:"a"},"ApprovalElection"))),(0,i.kt)("h4",{id:"overrides-5"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#from"},"from")),(0,i.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/approval.ts#L22"},"types/election/approval.ts:22")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/10dce6d4.fd3021e0.js b/assets/js/10dce6d4.6dda0c89.js similarity index 77% rename from assets/js/10dce6d4.fd3021e0.js rename to assets/js/10dce6d4.6dda0c89.js index 72448792e..09841e34f 100644 --- a/assets/js/10dce6d4.fd3021e0.js +++ b/assets/js/10dce6d4.6dda0c89.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7493],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>d});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function c(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var i=r.createContext({}),p=function(e){var t=r.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},l=function(e){var t=p(e.components);return r.createElement(i.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,c=e.originalType,i=e.parentName,l=a(e,["components","mdxType","originalType","parentName"]),f=p(n),d=o,m=f["".concat(i,".").concat(d)]||f[d]||u[d]||c;return n?r.createElement(m,s(s({ref:t},l),{},{components:n})):r.createElement(m,s({ref:t},l))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var c=n.length,s=new Array(c);s[0]=f;var a={};for(var i in t)hasOwnProperty.call(t,i)&&(a[i]=t[i]);a.originalType=e,a.mdxType="string"==typeof e?e:o,s[1]=a;for(var p=2;p{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>u,frontMatter:()=>c,metadata:()=>a,toc:()=>p});var r=n(87462),o=(n(67294),n(3905));const c={},s=void 0,a={unversionedId:"sdk/reference/interfaces/IAccountsListResponse",id:"sdk/reference/interfaces/IAccountsListResponse",title:"IAccountsListResponse",description:"@vocdoni/sdk / Exports / IAccountsListResponse",source:"@site/docs/sdk/reference/interfaces/IAccountsListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IAccountsListResponse",permalink:"/sdk/reference/interfaces/IAccountsListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IAccountsCountResponse",permalink:"/sdk/reference/interfaces/IAccountsCountResponse"},next:{title:"IApprovalElectionParameters",permalink:"/sdk/reference/interfaces/IApprovalElectionParameters"}},i={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"accounts",id:"accounts",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function u(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IAccountsListResponse"),(0,o.kt)("h1",{id:"interface-iaccountslistresponse"},"Interface: IAccountsListResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IAccountsListResponse#accounts"},"accounts"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"accounts"},"accounts"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"accounts"),": ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/modules#iaccountsummary"},(0,o.kt)("inlineCode",{parentName:"a"},"IAccountSummary")),"[]"),(0,o.kt)("p",null,"List of accounts"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/account.ts#L88"},"api/account.ts:88")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7493],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>d});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function c(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var i=r.createContext({}),p=function(e){var t=r.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},l=function(e){var t=p(e.components);return r.createElement(i.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,c=e.originalType,i=e.parentName,l=a(e,["components","mdxType","originalType","parentName"]),f=p(n),d=o,m=f["".concat(i,".").concat(d)]||f[d]||u[d]||c;return n?r.createElement(m,s(s({ref:t},l),{},{components:n})):r.createElement(m,s({ref:t},l))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var c=n.length,s=new Array(c);s[0]=f;var a={};for(var i in t)hasOwnProperty.call(t,i)&&(a[i]=t[i]);a.originalType=e,a.mdxType="string"==typeof e?e:o,s[1]=a;for(var p=2;p{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>u,frontMatter:()=>c,metadata:()=>a,toc:()=>p});var r=n(87462),o=(n(67294),n(3905));const c={},s=void 0,a={unversionedId:"sdk/reference/interfaces/IAccountsListResponse",id:"sdk/reference/interfaces/IAccountsListResponse",title:"IAccountsListResponse",description:"@vocdoni/sdk / Exports / IAccountsListResponse",source:"@site/docs/sdk/reference/interfaces/IAccountsListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IAccountsListResponse",permalink:"/sdk/reference/interfaces/IAccountsListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IAccountsCountResponse",permalink:"/sdk/reference/interfaces/IAccountsCountResponse"},next:{title:"IApprovalElectionParameters",permalink:"/sdk/reference/interfaces/IApprovalElectionParameters"}},i={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"accounts",id:"accounts",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function u(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IAccountsListResponse"),(0,o.kt)("h1",{id:"interface-iaccountslistresponse"},"Interface: IAccountsListResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IAccountsListResponse#accounts"},"accounts"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"accounts"},"accounts"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"accounts"),": ",(0,o.kt)("a",{parentName:"p",href:"../modules#iaccountsummary"},(0,o.kt)("inlineCode",{parentName:"a"},"IAccountSummary")),"[]"),(0,o.kt)("p",null,"List of accounts"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L88"},"api/account.ts:88")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/11667d91.26db7100.js b/assets/js/11667d91.26db7100.js new file mode 100644 index 000000000..9efd2cb2a --- /dev/null +++ b/assets/js/11667d91.26db7100.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1425],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>k});var i=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=i.createContext({}),d=function(e){var t=i.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=d(e.components);return i.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},m=i.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),m=d(n),k=r,h=m["".concat(p,".").concat(k)]||m[k]||c[k]||a;return n?i.createElement(h,l(l({ref:t},s),{},{components:n})):i.createElement(h,l({ref:t},s))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,l=new Array(a);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:r,l[1]=o;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>c,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var i=n(87462),r=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IMultiChoiceElectionParameters",id:"sdk/reference/interfaces/IMultiChoiceElectionParameters",title:"IMultiChoiceElectionParameters",description:"@vocdoni/sdk / Exports / IMultiChoiceElectionParameters",source:"@site/docs/sdk/reference/interfaces/IMultiChoiceElectionParameters.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IMultiChoiceElectionParameters",permalink:"/sdk/reference/interfaces/IMultiChoiceElectionParameters",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IInvalidElectionParameters",permalink:"/sdk/reference/interfaces/IInvalidElectionParameters"},next:{title:"IPublishedElectionParameters",permalink:"/sdk/reference/interfaces/IPublishedElectionParameters"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"canAbstain",id:"canabstain",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"canRepeatChoices",id:"canrepeatchoices",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"census",id:"census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"endDate",id:"enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"header",id:"header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"maxNumberOfChoices",id:"maxnumberofchoices",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"meta",id:"meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"questions",id:"questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"startDate",id:"startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"voteType",id:"votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-16",level:4}],s={toc:d};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,i.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IMultiChoiceElectionParameters"),(0,r.kt)("h1",{id:"interface-imultichoiceelectionparameters"},"Interface: IMultiChoiceElectionParameters"),(0,r.kt)("p",null,"Define election parameters."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"IElectionParameters"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IMultiChoiceElectionParameters"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#addsdkversion"},"addSDKVersion")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#canabstain"},"canAbstain")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#canrepeatchoices"},"canRepeatChoices")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#census"},"census")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#description"},"description")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#electiontype"},"electionType")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#enddate"},"endDate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#header"},"header")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#maxcensussize"},"maxCensusSize")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#maxnumberofchoices"},"maxNumberOfChoices")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#meta"},"meta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#questions"},"questions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#startdate"},"startDate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#streamuri"},"streamUri")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#temporarysecretidentity"},"temporarySecretIdentity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#title"},"title")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IMultiChoiceElectionParameters#votetype"},"voteType"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"addSDKVersion"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Used to add the SDK version to the election metadata"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"IElectionParameters#addsdkversion"},"addSDKVersion")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L155"},"types/election/election.ts:155")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"canabstain"},"canAbstain"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"canAbstain"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L10"},"types/election/multichoice.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"canrepeatchoices"},"canRepeatChoices"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"canRepeatChoices"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L9"},"types/election/multichoice.ts:9")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"census"},"census"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"census"),": ",(0,r.kt)("a",{parentName:"p",href:"../classes/Census"},(0,r.kt)("inlineCode",{parentName:"a"},"Census"))),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"IElectionParameters#census"},"census")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L129"},"types/election/election.ts:129")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Election description"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"IElectionParameters#description"},"description")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L114"},"types/election/election.ts:114")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electiontype"},"electionType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"electionType"),": ",(0,r.kt)("a",{parentName:"p",href:"IElectionType"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"IElectionParameters#electiontype"},"electionType")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L131"},"types/election/election.ts:131")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"enddate"},"endDate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"endDate"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"IElectionParameters#enddate"},"endDate")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L128"},"types/election/election.ts:128")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"header"},"header"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"header"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Election header image url."),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"IElectionParameters#header"},"header")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L118"},"types/election/election.ts:118")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Is used to limit the number of votes that can be registered for an election. This feature helps to prevent any\npotential overflow of the blockchain when the number of votes goes beyond the maximum limit."),(0,r.kt)("p",null,"In order to create an election, the creator is required to set the MaxCensusSize parameter to a proper value.\nTypically, this value should be equal to the size of the census. If the MaxCensusSize parameter is set to 0, an\nerror will occur and the election cannot be created."),(0,r.kt)("p",null,"If the number of votes exceeds this limit, will throw ",(0,r.kt)("inlineCode",{parentName:"p"},"Max census size for the election is greater than allowed\nsize")," error."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"IElectionParameters#maxcensussize"},"maxCensusSize")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L145"},"types/election/election.ts:145")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"maxnumberofchoices"},"maxNumberOfChoices"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"maxNumberOfChoices"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/multichoice.ts#L8"},"types/election/multichoice.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Metadata (anything added by the election creator)"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"IElectionParameters#meta"},"meta")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L126"},"types/election/election.ts:126")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"questions"},"questions"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"questions"),": ",(0,r.kt)("a",{parentName:"p",href:"IQuestion"},(0,r.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,r.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"IElectionParameters#questions"},"questions")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L132"},"types/election/election.ts:132")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"startdate"},"startDate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"startDate"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"IElectionParameters#startdate"},"startDate")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L127"},"types/election/election.ts:127")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"streamuri"},"streamUri"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"streamUri"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Election stream Uri (ex: a video url)"),(0,r.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"IElectionParameters#streamuri"},"streamUri")),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L122"},"types/election/election.ts:122")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Is used to remove the secret identities of the voters once the process is done."),(0,r.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"IElectionParameters#temporarysecretidentity"},"temporarySecretIdentity")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L150"},"types/election/election.ts:150")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"title"},"title"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"title"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Election title"),(0,r.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"IElectionParameters#title"},"title")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L110"},"types/election/election.ts:110")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"votetype"},"voteType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"voteType"),": ",(0,r.kt)("a",{parentName:"p",href:"IVoteType"},(0,r.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,r.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"IElectionParameters#votetype"},"voteType")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L130"},"types/election/election.ts:130")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/11667d91.6a0a19cb.js b/assets/js/11667d91.6a0a19cb.js deleted file mode 100644 index 0c6bfa45a..000000000 --- a/assets/js/11667d91.6a0a19cb.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1425],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=r.createContext({}),s=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=s(e.components);return r.createElement(c.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,c=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),m=s(n),f=i,k=m["".concat(c,".").concat(f)]||m[f]||p[f]||a;return n?r.createElement(k,l(l({ref:t},d),{},{components:n})):r.createElement(k,l({ref:t},d))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=m;var o={};for(var c in t)hasOwnProperty.call(t,c)&&(o[c]=t[c]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>s});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IMultiChoiceElectionParameters",id:"sdk/reference/interfaces/IMultiChoiceElectionParameters",title:"IMultiChoiceElectionParameters",description:"@vocdoni/sdk / Exports / IMultiChoiceElectionParameters",source:"@site/docs/sdk/reference/interfaces/IMultiChoiceElectionParameters.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IMultiChoiceElectionParameters",permalink:"/sdk/reference/interfaces/IMultiChoiceElectionParameters",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IInvalidElectionParameters",permalink:"/sdk/reference/interfaces/IInvalidElectionParameters"},next:{title:"IPublishedElectionParameters",permalink:"/sdk/reference/interfaces/IPublishedElectionParameters"}},c={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"canAbstain",id:"canabstain",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"canRepeatChoices",id:"canrepeatchoices",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"census",id:"census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"endDate",id:"enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"header",id:"header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"maxNumberOfChoices",id:"maxnumberofchoices",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"meta",id:"meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"questions",id:"questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"startDate",id:"startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"voteType",id:"votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-16",level:4}],d={toc:s};function p(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IMultiChoiceElectionParameters"),(0,i.kt)("h1",{id:"interface-imultichoiceelectionparameters"},"Interface: IMultiChoiceElectionParameters"),(0,i.kt)("p",null,"Define election parameters."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"IMultiChoiceElectionParameters"))))),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#addsdkversion"},"addSDKVersion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#canabstain"},"canAbstain")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#canrepeatchoices"},"canRepeatChoices")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#census"},"census")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#description"},"description")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#electiontype"},"electionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#enddate"},"endDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#header"},"header")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#maxcensussize"},"maxCensusSize")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#maxnumberofchoices"},"maxNumberOfChoices")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#meta"},"meta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#questions"},"questions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#startdate"},"startDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#streamuri"},"streamUri")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#title"},"title")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters#votetype"},"voteType"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"addSDKVersion"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Used to add the SDK version to the election metadata"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#addsdkversion"},"addSDKVersion")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L155"},"types/election/election.ts:155")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"canabstain"},"canAbstain"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"canAbstain"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L10"},"types/election/multichoice.ts:10")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"canrepeatchoices"},"canRepeatChoices"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"canRepeatChoices"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L9"},"types/election/multichoice.ts:9")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"census"},"census"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"census"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census"))),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#census"},"census")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L129"},"types/election/election.ts:129")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Election description"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#description"},"description")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L114"},"types/election/election.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electiontype"},"electionType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"electionType"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#electiontype"},"electionType")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L131"},"types/election/election.ts:131")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enddate"},"endDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"endDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#enddate"},"endDate")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L128"},"types/election/election.ts:128")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"header"},"header"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"header"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Election header image url."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#header"},"header")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L118"},"types/election/election.ts:118")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Is used to limit the number of votes that can be registered for an election. This feature helps to prevent any\npotential overflow of the blockchain when the number of votes goes beyond the maximum limit."),(0,i.kt)("p",null,"In order to create an election, the creator is required to set the MaxCensusSize parameter to a proper value.\nTypically, this value should be equal to the size of the census. If the MaxCensusSize parameter is set to 0, an\nerror will occur and the election cannot be created."),(0,i.kt)("p",null,"If the number of votes exceeds this limit, will throw ",(0,i.kt)("inlineCode",{parentName:"p"},"Max census size for the election is greater than allowed\nsize")," error."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#maxcensussize"},"maxCensusSize")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L145"},"types/election/election.ts:145")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxnumberofchoices"},"maxNumberOfChoices"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"maxNumberOfChoices"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/multichoice.ts#L8"},"types/election/multichoice.ts:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("p",null,"Metadata (anything added by the election creator)"),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#meta"},"meta")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L126"},"types/election/election.ts:126")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"questions"},"questions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"questions"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#questions"},"questions")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L132"},"types/election/election.ts:132")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"startdate"},"startDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"startDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#startdate"},"startDate")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L127"},"types/election/election.ts:127")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"streamuri"},"streamUri"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"streamUri"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Election stream Uri (ex: a video url)"),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#streamuri"},"streamUri")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L122"},"types/election/election.ts:122")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Is used to remove the secret identities of the voters once the process is done."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L150"},"types/election/election.ts:150")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Election title"),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#title"},"title")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L110"},"types/election/election.ts:110")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votetype"},"voteType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"voteType"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#votetype"},"voteType")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L130"},"types/election/election.ts:130")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/11d03c56.018f2c4b.js b/assets/js/11d03c56.018f2c4b.js deleted file mode 100644 index 0df6c8045..000000000 --- a/assets/js/11d03c56.018f2c4b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8759],{3905:(e,n,t)=>{t.d(n,{Zo:()=>s,kt:()=>f});var r=t(67294);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var p=r.createContext({}),l=function(e){var n=r.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},s=function(e){var n=l(e.components);return r.createElement(p.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},y=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,a=e.originalType,p=e.parentName,s=c(e,["components","mdxType","originalType","parentName"]),y=l(t),f=o,m=y["".concat(p,".").concat(f)]||y[f]||u[f]||a;return t?r.createElement(m,i(i({ref:n},s),{},{components:t})):r.createElement(m,i({ref:n},s))}));function f(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var a=t.length,i=new Array(a);i[0]=y;var c={};for(var p in n)hasOwnProperty.call(n,p)&&(c[p]=n[p]);c.originalType=e,c.mdxType="string"==typeof e?e:o,i[1]=c;for(var l=2;l{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>i,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var r=t(87462),o=(t(67294),t(3905));const a={},i="On-Chain Pseudo-Anonymity",c={unversionedId:"protocol/anonymity/on-chain",id:"protocol/anonymity/on-chain",title:"On-Chain Pseudo-Anonymity",description:"This page is a work-in-progress. Please check back for updates.",source:"@site/docs/protocol/anonymity/on-chain.md",sourceDirName:"protocol/anonymity",slug:"/protocol/anonymity/on-chain",permalink:"/protocol/anonymity/on-chain",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CSP Blind Signatures",permalink:"/protocol/anonymity/blind-signatures"},next:{title:"Off-Chain Tree ZK Census Proof",permalink:"/protocol/anonymity/zk-census-proof"}},p={},l=[],s={toc:l};function u(e){let{components:n,...t}=e;return(0,o.kt)("wrapper",(0,r.Z)({},s,t,{components:n,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"on-chain-pseudo-anonymity"},"On-Chain Pseudo-Anonymity"),(0,o.kt)("p",null,"This page is a work-in-progress. Please check back for updates."))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/11d03c56.60dd7047.js b/assets/js/11d03c56.60dd7047.js new file mode 100644 index 000000000..fd4a2e8dc --- /dev/null +++ b/assets/js/11d03c56.60dd7047.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8759],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>d});var a=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var l=a.createContext({}),c=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,l=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),m=c(n),d=o,h=m["".concat(l,".").concat(d)]||m[d]||p[d]||r;return n?a.createElement(h,i(i({ref:t},u),{},{components:n})):a.createElement(h,i({ref:t},u))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,i=new Array(r);i[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:o,i[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>s,toc:()=>c});var a=n(87462),o=(n(67294),n(3905));const r={},i="On-Chain Census Anonymity",s={unversionedId:"protocol/anonymity/on-chain",id:"protocol/anonymity/on-chain",title:"On-Chain Census Anonymity",description:"On-chain cenuses derive their contents from a public set of holders of a given token (or set of tokens) on the Ethereum blockchain. This information is turned into a census by generating a Merkle Proof on that set of data. This Merkle Proof is similar to that used for a typical off-chain tree census, and the same sort of ZK Census Proof can be used to compute voter validation anonymously.",source:"@site/docs/protocol/anonymity/on-chain.md",sourceDirName:"protocol/anonymity",slug:"/protocol/anonymity/on-chain",permalink:"/protocol/anonymity/on-chain",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CSP Blind Signatures",permalink:"/protocol/anonymity/blind-signatures"},next:{title:"Off-Chain Tree ZK Census Proof",permalink:"/protocol/anonymity/zk-census-proof"}},l={},c=[{value:"Rounding Censuses",id:"rounding-censuses",level:2},{value:"Basic Steps",id:"basic-steps",level:3},{value:"Results Accuracy",id:"results-accuracy",level:2},{value:"Anonymity Level",id:"anonymity-level",level:2}],u={toc:c};function p(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"on-chain-census-anonymity"},"On-Chain Census Anonymity"),(0,o.kt)("p",null,"On-chain cenuses derive their contents from a public set of holders of a given token (or set of tokens) on the Ethereum blockchain. This information is turned into a census by generating a Merkle Proof on that set of data. This Merkle Proof is similar to that used for a typical off-chain tree census, and the same sort of ",(0,o.kt)("a",{parentName:"p",href:"/protocol/anonymity/zk-census-proof"},"ZK Census Proof")," can be used to compute voter validation anonymously."),(0,o.kt)("p",null,"Unfortunately a zero-knowledge census itself is not enough to anonymize an on-chain election, because voters are weighted according to their unique token balances, making them easy to identify as the weight of a vote can be correlated with an address. We address this problem by rounding voter weights in order to hide unique token balances."),(0,o.kt)("h2",{id:"rounding-censuses"},"Rounding Censuses"),(0,o.kt)("p",null,"To ensure that the balances of token-based censuses remain private, we must alter them in some way. However, any change must meet two requirements:"),(0,o.kt)("ol",null,(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"The resulting balance must be less than or equal to the original one.")),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"The resulting balance should stay as close to the original as possible."))),(0,o.kt)("p",null,"Our algorithm rounds balances to a nearby value, forming groups of equal rounded balance of a least some ",(0,o.kt)("inlineCode",{parentName:"p"},"privacyThreshold")," in size (minimum 3). This process obscures individual holder's balances. The algorithm optimizes the number of members in a group, taking in account the difference between balances, to reduce accuracy loss."),(0,o.kt)("h3",{id:"basic-steps"},"Basic Steps"),(0,o.kt)("ol",null,(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Identify and exclude outliers: Participants balances are analyzed to detect outliers using z-score algorithm.")),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Forming groups: Participants are initially grouped based on the privacy threshold. A group can extend to include participants with identical balances or with balances differences falling below the groupBalanceDiff criteria.")),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Balancing groups: For each group, we adjust the balances, rounding them down to the smallest amount within the group to obscure individual values.")),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Accuracy loop: The algorithm tries to find the highest accuracy possible while maintaining a minimum privacy threshold. It starts with the minimum privacy threshold and increases it by a small amount until the accuracy is maximized."))),(0,o.kt)("h2",{id:"results-accuracy"},"Results Accuracy"),(0,o.kt)("p",null,"Because voter weights are rounded, there is a chance for the accuracy of elections to be affected."),(0,o.kt)("p",null,"To measure accuracy, we compare the total of the adjusted balances from the census against the sum of the original balances, incorporating outliers into both calculations for consistency."),(0,o.kt)("p",null,"Our tests covered censuses involving 21 different tokens, showcasing various holder counts and token formats, including ERC20, ERC721, and POAP. This comprehensive testing ensures our approach is robust across different Web3 assets."),(0,o.kt)("p",null,(0,o.kt)("img",{parentName:"p",src:"https://blog.vocdoni.io/_next/image?url=https%3A%2F%2Fstorage.googleapis.com%2Fpapyrus_images%2F1b54084ccc29b051ca00d4d31c02328c.png&w=1920&q=75",alt:"accuracy-testing"})),(0,o.kt)("p",null,"Evidently, accuracy cannot be maintained under all possible conditions. We've established parameter settings that generally perform well across various token types and distributions, and under these conditions we consider accuracy levels to be sufficient. "),(0,o.kt)("h2",{id:"anonymity-level"},"Anonymity Level"),(0,o.kt)("p",null,"This scheme for token-based census anonymity is not as absolutely anonymous as a zk-merkle-proof. There are potential vulnerabilities to specific attacks. "),(0,o.kt)("p",null,"For example, acquiring a certain amount of a token to manipulate the algorithm into grouping an address with others could theoretically expose that address. However, such strategies are impractical and unlikely to significantly impact election outcomes. This type of attack also requires an analysis of balance distributions, complicating its execution."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/16c4bb07.a57174f3.js b/assets/js/16c4bb07.7f32c855.js similarity index 81% rename from assets/js/16c4bb07.a57174f3.js rename to assets/js/16c4bb07.7f32c855.js index a759ffbf7..212fc45cd 100644 --- a/assets/js/16c4bb07.a57174f3.js +++ b/assets/js/16c4bb07.7f32c855.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7533],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>f});var n=r(67294);function s(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(s[r]=e[r]);return s}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(s[r]=e[r])}return s}var l=n.createContext({}),p=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,s=e.mdxType,a=e.originalType,l=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),u=p(r),f=s,y=u["".concat(l,".").concat(f)]||u[f]||d[f]||a;return r?n.createElement(y,o(o({ref:t},c),{},{components:r})):n.createElement(y,o({ref:t},c))}));function f(e,t){var r=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var a=r.length,o=new Array(a);o[0]=u;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i.mdxType="string"==typeof e?e:s,o[1]=i;for(var p=2;p{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>p});var n=r(87462),s=(r(67294),r(3905));const a={},o=void 0,i={unversionedId:"sdk/reference/interfaces/ICensus3StrategyHoldersResponse",id:"sdk/reference/interfaces/ICensus3StrategyHoldersResponse",title:"ICensus3StrategyHoldersResponse",description:"@vocdoni/sdk / Exports / ICensus3StrategyHoldersResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategyEstimationQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse"},next:{title:"ICensus3StrategyHoldersResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated"}},l={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"holders",id:"holders",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in",level:4}],c={toc:p};function d(e){let{components:t,...r}=e;return(0,s.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3StrategyHoldersResponse"),(0,s.kt)("h1",{id:"interface-icensus3strategyholdersresponse"},"Interface: ICensus3StrategyHoldersResponse"),(0,s.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("p",{parentName:"li"},(0,s.kt)("strong",{parentName:"p"},(0,s.kt)("inlineCode",{parentName:"strong"},"ICensus3StrategyHoldersResponse"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated"},(0,s.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyHoldersResponsePaginated"))))),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse#holders"},"holders"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"holders"},"holders"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"holders"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"Object")),(0,s.kt)("p",null,"The list of the strategy holders"),(0,s.kt)("h4",{id:"index-signature"},"Index signature"),(0,s.kt)("p",null,"\u25aa ","[key: ",(0,s.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L36"},"api/census3/strategy.ts:36")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7533],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>f});var n=r(67294);function s(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(s[r]=e[r]);return s}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(s[r]=e[r])}return s}var l=n.createContext({}),p=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,s=e.mdxType,a=e.originalType,l=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),u=p(r),f=s,y=u["".concat(l,".").concat(f)]||u[f]||d[f]||a;return r?n.createElement(y,o(o({ref:t},c),{},{components:r})):n.createElement(y,o({ref:t},c))}));function f(e,t){var r=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var a=r.length,o=new Array(a);o[0]=u;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i.mdxType="string"==typeof e?e:s,o[1]=i;for(var p=2;p{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>p});var n=r(87462),s=(r(67294),r(3905));const a={},o=void 0,i={unversionedId:"sdk/reference/interfaces/ICensus3StrategyHoldersResponse",id:"sdk/reference/interfaces/ICensus3StrategyHoldersResponse",title:"ICensus3StrategyHoldersResponse",description:"@vocdoni/sdk / Exports / ICensus3StrategyHoldersResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategyEstimationQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse"},next:{title:"ICensus3StrategyHoldersResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated"}},l={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"holders",id:"holders",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in",level:4}],c={toc:p};function d(e){let{components:t,...r}=e;return(0,s.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3StrategyHoldersResponse"),(0,s.kt)("h1",{id:"interface-icensus3strategyholdersresponse"},"Interface: ICensus3StrategyHoldersResponse"),(0,s.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("p",{parentName:"li"},(0,s.kt)("strong",{parentName:"p"},(0,s.kt)("inlineCode",{parentName:"strong"},"ICensus3StrategyHoldersResponse"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("a",{parentName:"p",href:"ICensus3StrategyHoldersResponsePaginated"},(0,s.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyHoldersResponsePaginated"))))),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus3StrategyHoldersResponse#holders"},"holders"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"holders"},"holders"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"holders"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"Object")),(0,s.kt)("p",null,"The list of the strategy holders"),(0,s.kt)("h4",{id:"index-signature"},"Index signature"),(0,s.kt)("p",null,"\u25aa ","[key: ",(0,s.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L36"},"api/census3/strategy.ts:36")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/16e8ae75.b4da2519.js b/assets/js/16e8ae75.b4da2519.js deleted file mode 100644 index 15478c76f..000000000 --- a/assets/js/16e8ae75.b4da2519.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6418],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),c=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),u=c(n),f=i,k=u["".concat(s,".").concat(f)]||u[f]||d[f]||a;return n?r.createElement(k,l(l({ref:t},p),{},{components:n})):r.createElement(k,l({ref:t},p))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>a,metadata:()=>o,toc:()=>c});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IElectionListFilter",id:"sdk/reference/interfaces/IElectionListFilter",title:"IElectionListFilter",description:"@vocdoni/sdk / Exports / IElectionListFilter",source:"@site/docs/sdk/reference/interfaces/IElectionListFilter.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionListFilter",permalink:"/sdk/reference/interfaces/IElectionListFilter",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionKeysResponse",permalink:"/sdk/reference/interfaces/IElectionKeysResponse"},next:{title:"IElectionListResponse",permalink:"/sdk/reference/interfaces/IElectionListResponse"}},s={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"electionId",id:"electionid",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"organizationId",id:"organizationid",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"withResults",id:"withresults",level:3},{value:"Defined in",id:"defined-in-3",level:4}],p={toc:c};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IElectionListFilter"),(0,i.kt)("h1",{id:"interface-ielectionlistfilter"},"Interface: IElectionListFilter"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionListFilter#electionid"},"electionId")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionListFilter#organizationid"},"organizationId")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionListFilter#status"},"status")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionListFilter#withresults"},"withResults"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"electionid"},"electionId"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"electionId"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L364"},"api/election.ts:364")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"organizationid"},"organizationId"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"organizationId"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L363"},"api/election.ts:363")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#process_unknown"},(0,i.kt)("inlineCode",{parentName:"a"},"PROCESS_UNKNOWN"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#ended"},(0,i.kt)("inlineCode",{parentName:"a"},"ENDED"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#canceled"},(0,i.kt)("inlineCode",{parentName:"a"},"CANCELED"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#paused"},(0,i.kt)("inlineCode",{parentName:"a"},"PAUSED"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#results"},(0,i.kt)("inlineCode",{parentName:"a"},"RESULTS"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatusReady#ready"},(0,i.kt)("inlineCode",{parentName:"a"},"READY"))),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L366"},"api/election.ts:366")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"withresults"},"withResults"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"withResults"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L365"},"api/election.ts:365")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/16e8ae75.fe0bf9a5.js b/assets/js/16e8ae75.fe0bf9a5.js new file mode 100644 index 000000000..03ba08a7f --- /dev/null +++ b/assets/js/16e8ae75.fe0bf9a5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6418],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var i=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=i.createContext({}),p=function(e){var t=i.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=p(e.components);return i.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},u=i.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,s=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),u=p(n),f=r,k=u["".concat(s,".").concat(f)]||u[f]||d[f]||a;return n?i.createElement(k,l(l({ref:t},c),{},{components:n})):i.createElement(k,l({ref:t},c))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,l=new Array(a);l[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:r,l[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>a,metadata:()=>o,toc:()=>p});var i=n(87462),r=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IElectionListFilter",id:"sdk/reference/interfaces/IElectionListFilter",title:"IElectionListFilter",description:"@vocdoni/sdk / Exports / IElectionListFilter",source:"@site/docs/sdk/reference/interfaces/IElectionListFilter.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionListFilter",permalink:"/sdk/reference/interfaces/IElectionListFilter",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionKeysResponse",permalink:"/sdk/reference/interfaces/IElectionKeysResponse"},next:{title:"IElectionListResponse",permalink:"/sdk/reference/interfaces/IElectionListResponse"}},s={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"electionId",id:"electionid",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"organizationId",id:"organizationid",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"withResults",id:"withresults",level:3},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:p};function d(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,i.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IElectionListFilter"),(0,r.kt)("h1",{id:"interface-ielectionlistfilter"},"Interface: IElectionListFilter"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IElectionListFilter#electionid"},"electionId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IElectionListFilter#organizationid"},"organizationId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IElectionListFilter#status"},"status")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IElectionListFilter#withresults"},"withResults"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"electionid"},"electionId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"electionId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L364"},"api/election.ts:364")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"organizationid"},"organizationId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"organizationId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L363"},"api/election.ts:363")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"status"},"status"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"status"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#process_unknown"},(0,r.kt)("inlineCode",{parentName:"a"},"PROCESS_UNKNOWN"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#ended"},(0,r.kt)("inlineCode",{parentName:"a"},"ENDED"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#canceled"},(0,r.kt)("inlineCode",{parentName:"a"},"CANCELED"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#paused"},(0,r.kt)("inlineCode",{parentName:"a"},"PAUSED"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#results"},(0,r.kt)("inlineCode",{parentName:"a"},"RESULTS"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"../enums/ElectionStatusReady#ready"},(0,r.kt)("inlineCode",{parentName:"a"},"READY"))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L366"},"api/election.ts:366")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"withresults"},"withResults"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"withResults"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L365"},"api/election.ts:365")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1821d9d7.4bba74fd.js b/assets/js/1821d9d7.4bba74fd.js new file mode 100644 index 000000000..11a96ecce --- /dev/null +++ b/assets/js/1821d9d7.4bba74fd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1510],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=p(n),m=a,f=c["".concat(l,".").concat(m)]||c[m]||u[m]||i;return n?r.createElement(f,o(o({ref:t},d),{},{components:n})):r.createElement(f,o({ref:t},d))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=c;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const i={},o=void 0,s={unversionedId:"sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse",id:"sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse",title:"ICensus3StrategyEstimationQueueResponse",description:"@vocdoni/sdk / Exports / ICensus3StrategyEstimationQueueResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategyCreateResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyCreateResponse"},next:{title:"ICensus3StrategyHoldersResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"done",id:"done",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"estimation",id:"estimation",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-2",level:4}],d={toc:p};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3StrategyEstimationQueueResponse"),(0,a.kt)("h1",{id:"interface-icensus3strategyestimationqueueresponse"},"Interface: ICensus3StrategyEstimationQueueResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3StrategyEstimationQueueResponse#done"},"done")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3StrategyEstimationQueueResponse#error"},"error")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3StrategyEstimationQueueResponse#estimation"},"estimation"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"done"},"done"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"done"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"If the queue has been done"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L106"},"api/census3/strategy.ts:106")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"error"},"error"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"error"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("p",null,"The error of the queue"),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"code")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The code of the error")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The string of the error")))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L111"},"api/census3/strategy.ts:111")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"estimation"},"estimation"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"estimation"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("p",null,"The estimation of the strategy"),(0,a.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"accuracy")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The accuracy for an anonymous census")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"size")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The estimation of the size")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"timeToCreateCensus")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The estimation of the time to create the census")))),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L126"},"api/census3/strategy.ts:126")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1821d9d7.b5ee3558.js b/assets/js/1821d9d7.b5ee3558.js deleted file mode 100644 index 885cdf63b..000000000 --- a/assets/js/1821d9d7.b5ee3558.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1510],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=p(n),m=a,f=c["".concat(l,".").concat(m)]||c[m]||u[m]||i;return n?r.createElement(f,o(o({ref:t},d),{},{components:n})):r.createElement(f,o({ref:t},d))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=c;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const i={},o=void 0,s={unversionedId:"sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse",id:"sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse",title:"ICensus3StrategyEstimationQueueResponse",description:"@vocdoni/sdk / Exports / ICensus3StrategyEstimationQueueResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategyCreateResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyCreateResponse"},next:{title:"ICensus3StrategyHoldersResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"done",id:"done",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"estimation",id:"estimation",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-2",level:4}],d={toc:p};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3StrategyEstimationQueueResponse"),(0,a.kt)("h1",{id:"interface-icensus3strategyestimationqueueresponse"},"Interface: ICensus3StrategyEstimationQueueResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse#done"},"done")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse#error"},"error")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse#estimation"},"estimation"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"done"},"done"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"done"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"If the queue has been done"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L106"},"api/census3/strategy.ts:106")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"error"},"error"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"error"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("p",null,"The error of the queue"),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"code")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The code of the error")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The string of the error")))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L111"},"api/census3/strategy.ts:111")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"estimation"},"estimation"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"estimation"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("p",null,"The estimation of the strategy"),(0,a.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"accuracy")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The accuracy for an anonymous census")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"size")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The estimation of the size")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"timeToCreateCensus")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The estimation of the time to create the census")))),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L126"},"api/census3/strategy.ts:126")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1c3bce93.1deb7fcf.js b/assets/js/1c3bce93.1deb7fcf.js deleted file mode 100644 index 269758935..000000000 --- a/assets/js/1c3bce93.1deb7fcf.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1414],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>c});var r=n(67294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var d=r.createContext({}),p=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=p(e.components);return r.createElement(d.Provider,{value:t},e.children)},o={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var n=e.components,s=e.mdxType,a=e.originalType,d=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),k=p(n),c=s,m=k["".concat(d,".").concat(c)]||k[c]||o[c]||a;return n?r.createElement(m,i(i({ref:t},u),{},{components:n})):r.createElement(m,i({ref:t},u))}));function c(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var a=n.length,i=new Array(a);i[0]=k;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l.mdxType="string"==typeof e?e:s,i[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>o,frontMatter:()=>a,metadata:()=>l,toc:()=>p});var r=n(87462),s=(n(67294),n(3905));const a={},i=void 0,l={unversionedId:"sdk/reference/classes/PublishedCensus",id:"sdk/reference/classes/PublishedCensus",title:"PublishedCensus",description:"@vocdoni/sdk / Exports / PublishedCensus",source:"@site/docs/sdk/reference/classes/PublishedCensus.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/PublishedCensus",permalink:"/sdk/reference/classes/PublishedCensus",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"PlainCensus",permalink:"/sdk/reference/classes/PlainCensus"},next:{title:"PublishedElection",permalink:"/sdk/reference/classes/PublishedElection"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_censusId",id:"_censusid",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_censusURI",id:"_censusuri",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_type",id:"_type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"censusId",id:"censusid",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isPublished",id:"ispublished",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"type",id:"type",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"weight",id:"weight",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Methods",id:"methods-1",level:2},{value:"censusTypeFromCensusOrigin",id:"censustypefromcensusorigin",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-15",level:4}],u={toc:p};function o(e){let{components:t,...n}=e;return(0,s.kt)("wrapper",(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / PublishedCensus"),(0,s.kt)("h1",{id:"class-publishedcensus"},"Class: PublishedCensus"),(0,s.kt)("p",null,"Represents a published census"),(0,s.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("p",{parentName:"li"},(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,s.kt)("inlineCode",{parentName:"a"},"Census"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("strong",{parentName:"p"},(0,s.kt)("inlineCode",{parentName:"strong"},"PublishedCensus"))),(0,s.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/TokenCensus"},(0,s.kt)("inlineCode",{parentName:"a"},"TokenCensus"))))),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"constructors"},"Constructors"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedCensus#constructor"},"constructor"))),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedCensus#_censusid"},"_","censusId")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedCensus#_censusuri"},"_","censusURI")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedCensus#_type"},"_","type"))),(0,s.kt)("h3",{id:"accessors"},"Accessors"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedCensus#censusid"},"censusId")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedCensus#censusuri"},"censusURI")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedCensus#ispublished"},"isPublished")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedCensus#size"},"size")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedCensus#type"},"type")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedCensus#weight"},"weight"))),(0,s.kt)("h3",{id:"methods"},"Methods"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin"))),(0,s.kt)("h2",{id:"constructors-1"},"Constructors"),(0,s.kt)("h3",{id:"constructor"},"constructor"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"new PublishedCensus"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"censusURI"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"type"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"size?"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"weight?"),"): ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},(0,s.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))),(0,s.kt)("p",null,"Constructs a published census"),(0,s.kt)("h4",{id:"parameters"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"censusId")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The id of the census")),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"censusURI")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The URI of the census")),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"type")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("td",{parentName:"tr",align:"left"},"The type of the census")),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"size?")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"number")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The size of the census")),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"weight?")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"bigint")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The weight of the census")))),(0,s.kt)("h4",{id:"returns"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},(0,s.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))),(0,s.kt)("h4",{id:"overrides"},"Overrides"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#constructor"},"constructor")),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/published.ts#L17"},"types/census/published.ts:17")),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"_censusid"},"_","censusId"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,s.kt)("strong",{parentName:"p"},"_","censusId"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_censusid"},"_censusId")),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L12"},"types/census/census.ts:12")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"_censusuri"},"_","censusURI"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,s.kt)("strong",{parentName:"p"},"_","censusURI"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_censusuri"},"_censusURI")),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L13"},"types/census/census.ts:13")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"_type"},"_","type"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,s.kt)("strong",{parentName:"p"},"_","type"),": ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_type"},"_type")),(0,s.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L14"},"types/census/census.ts:14")),(0,s.kt)("h2",{id:"accessors-1"},"Accessors"),(0,s.kt)("h3",{id:"censusid"},"censusId"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"censusId"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"returns-1"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,s.kt)("p",null,"Census.censusId"),(0,s.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L35"},"types/census/census.ts:35")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"censusId"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-1"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string"))))),(0,s.kt)("h4",{id:"returns-2"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,s.kt)("p",null,"Census.censusId"),(0,s.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L39"},"types/census/census.ts:39")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"censusuri"},"censusURI"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"censusURI"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"returns-3"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,s.kt)("p",null,"Census.censusURI"),(0,s.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L43"},"types/census/census.ts:43")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"censusURI"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-2"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string"))))),(0,s.kt)("h4",{id:"returns-4"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,s.kt)("p",null,"Census.censusURI"),(0,s.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L47"},"types/census/census.ts:47")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"ispublished"},"isPublished"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"isPublished"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"boolean")),(0,s.kt)("h4",{id:"returns-5"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"boolean")),(0,s.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,s.kt)("p",null,"Census.isPublished"),(0,s.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L75"},"types/census/census.ts:75")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"size"},"size"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"size"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("h4",{id:"returns-6"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,s.kt)("p",null,"Census.size"),(0,s.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L59"},"types/census/census.ts:59")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"size"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-3"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"number"))))),(0,s.kt)("h4",{id:"returns-7"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,s.kt)("p",null,"Census.size"),(0,s.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L63"},"types/census/census.ts:63")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"type"},"type"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"type"),"(): ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"returns-8"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,s.kt)("p",null,"Census.type"),(0,s.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L51"},"types/census/census.ts:51")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"type"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-4"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType")))))),(0,s.kt)("h4",{id:"returns-9"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,s.kt)("p",null,"Census.type"),(0,s.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L55"},"types/census/census.ts:55")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"weight"},"weight"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"weight"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"bigint")),(0,s.kt)("h4",{id:"returns-10"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"bigint")),(0,s.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,s.kt)("p",null,"Census.weight"),(0,s.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L67"},"types/census/census.ts:67")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"weight"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-5"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,s.kt)("h4",{id:"returns-11"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,s.kt)("p",null,"Census.weight"),(0,s.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L71"},"types/census/census.ts:71")),(0,s.kt)("h2",{id:"methods-1"},"Methods"),(0,s.kt)("h3",{id:"censustypefromcensusorigin"},"censusTypeFromCensusOrigin"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("strong",{parentName:"p"},"censusTypeFromCensusOrigin"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"censusOrigin"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"parameters-6"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"censusOrigin")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"boolean")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"false"))))),(0,s.kt)("h4",{id:"returns-12"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#censustypefromcensusorigin"},"censusTypeFromCensusOrigin")),(0,s.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L81"},"types/census/census.ts:81")))}o.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1c3bce93.c79f223f.js b/assets/js/1c3bce93.c79f223f.js new file mode 100644 index 000000000..c17ac988c --- /dev/null +++ b/assets/js/1c3bce93.c79f223f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1414],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function s(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=r.createContext({}),p=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=p(e.components);return r.createElement(d.Provider,{value:t},e.children)},o={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,s=e.originalType,d=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),k=p(n),m=a,c=k["".concat(d,".").concat(m)]||k[m]||o[m]||s;return n?r.createElement(c,i(i({ref:t},u),{},{components:n})):r.createElement(c,i({ref:t},u))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var s=n.length,i=new Array(s);i[0]=k;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l.mdxType="string"==typeof e?e:a,i[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>o,frontMatter:()=>s,metadata:()=>l,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const s={},i=void 0,l={unversionedId:"sdk/reference/classes/PublishedCensus",id:"sdk/reference/classes/PublishedCensus",title:"PublishedCensus",description:"@vocdoni/sdk / Exports / PublishedCensus",source:"@site/docs/sdk/reference/classes/PublishedCensus.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/PublishedCensus",permalink:"/sdk/reference/classes/PublishedCensus",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"PlainCensus",permalink:"/sdk/reference/classes/PlainCensus"},next:{title:"PublishedElection",permalink:"/sdk/reference/classes/PublishedElection"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_censusId",id:"_censusid",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_censusURI",id:"_censusuri",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_type",id:"_type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"censusId",id:"censusid",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isPublished",id:"ispublished",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"type",id:"type",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"weight",id:"weight",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Methods",id:"methods-1",level:2},{value:"censusTypeFromCensusOrigin",id:"censustypefromcensusorigin",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-15",level:4}],u={toc:p};function o(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / PublishedCensus"),(0,a.kt)("h1",{id:"class-publishedcensus"},"Class: PublishedCensus"),(0,a.kt)("p",null,"Represents a published census"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"PublishedCensus"))),(0,a.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"TokenCensus"},(0,a.kt)("inlineCode",{parentName:"a"},"TokenCensus"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"PublishedCensus#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedCensus#_censusid"},"_","censusId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedCensus#_censusuri"},"_","censusURI")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedCensus#_type"},"_","type"))),(0,a.kt)("h3",{id:"accessors"},"Accessors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"PublishedCensus#censusid"},"censusId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"PublishedCensus#censusuri"},"censusURI")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"PublishedCensus#ispublished"},"isPublished")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"PublishedCensus#size"},"size")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"PublishedCensus#type"},"type")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"PublishedCensus#weight"},"weight"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"PublishedCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new PublishedCensus"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"censusURI"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"type"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"size?"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"weight?"),"): ",(0,a.kt)("a",{parentName:"p",href:"PublishedCensus"},(0,a.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))),(0,a.kt)("p",null,"Constructs a published census"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"censusId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The id of the census")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"censusURI")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The URI of the census")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"type")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"The type of the census")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"size?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The size of the census")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"weight?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"bigint")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The weight of the census")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"PublishedCensus"},(0,a.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,a.kt)("a",{parentName:"p",href:"Census#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/published.ts#L17"},"types/census/published.ts:17")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"_censusid"},"_","censusId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","censusId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"Census"},"Census"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_censusid"},"_censusId")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L12"},"types/census/census.ts:12")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_censusuri"},"_","censusURI"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","censusURI"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"Census"},"Census"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_censusuri"},"_censusURI")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L13"},"types/census/census.ts:13")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_type"},"_","type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","type"),": ",(0,a.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"Census"},"Census"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_type"},"_type")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L14"},"types/census/census.ts:14")),(0,a.kt)("h2",{id:"accessors-1"},"Accessors"),(0,a.kt)("h3",{id:"censusid"},"censusId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"censusId"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"Census.censusId"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L35"},"types/census/census.ts:35")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"censusId"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"Census.censusId"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L39"},"types/census/census.ts:39")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"censusuri"},"censusURI"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"censusURI"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"Census.censusURI"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L43"},"types/census/census.ts:43")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"censusURI"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"Census.censusURI"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L47"},"types/census/census.ts:47")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ispublished"},"isPublished"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"isPublished"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,a.kt)("p",null,"Census.isPublished"),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L75"},"types/census/census.ts:75")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"size"},"size"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"size"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,a.kt)("p",null,"Census.size"),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L59"},"types/census/census.ts:59")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"size"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,a.kt)("p",null,"Census.size"),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L63"},"types/census/census.ts:63")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"type"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,a.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,a.kt)("p",null,"Census.type"),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L51"},"types/census/census.ts:51")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"type"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-4"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType")))))),(0,a.kt)("h4",{id:"returns-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,a.kt)("p",null,"Census.type"),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L55"},"types/census/census.ts:55")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"weight"},"weight"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"weight"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint")),(0,a.kt)("h4",{id:"returns-10"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"bigint")),(0,a.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,a.kt)("p",null,"Census.weight"),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L67"},"types/census/census.ts:67")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"weight"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-5"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,a.kt)("h4",{id:"returns-11"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,a.kt)("p",null,"Census.weight"),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L71"},"types/census/census.ts:71")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"censustypefromcensusorigin"},"censusTypeFromCensusOrigin"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"censusTypeFromCensusOrigin"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"censusOrigin"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,a.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,a.kt)("h4",{id:"parameters-6"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"censusOrigin")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"false"))))),(0,a.kt)("h4",{id:"returns-12"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,a.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,a.kt)("a",{parentName:"p",href:"Census#censustypefromcensusorigin"},"censusTypeFromCensusOrigin")),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L81"},"types/census/census.ts:81")))}o.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1e6527e1.107ad855.js b/assets/js/1e6527e1.f2415c49.js similarity index 56% rename from assets/js/1e6527e1.107ad855.js rename to assets/js/1e6527e1.f2415c49.js index c8db6c8fd..7979560a2 100644 --- a/assets/js/1e6527e1.107ad855.js +++ b/assets/js/1e6527e1.f2415c49.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4719],{3905:(e,n,t)=>{t.d(n,{Zo:()=>l,kt:()=>k});var r=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=r.createContext({}),c=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},l=function(e){var n=c(e.components);return r.createElement(s.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},f=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),f=c(t),k=a,m=f["".concat(s,".").concat(k)]||f[k]||d[k]||i;return t?r.createElement(m,o(o({ref:n},l),{},{components:t})):r.createElement(m,o({ref:n},l))}));function k(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,o=new Array(i);o[0]=f;var p={};for(var s in n)hasOwnProperty.call(n,s)&&(p[s]=n[s]);p.originalType=e,p.mdxType="string"==typeof e?e:a,o[1]=p;for(var c=2;c{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=t(87462),a=(t(67294),t(3905));const i={},o=void 0,p={unversionedId:"sdk/reference/interfaces/Tx",id:"sdk/reference/interfaces/Tx",title:"Tx",description:"@vocdoni/sdk / Exports / Tx",source:"@site/docs/sdk/reference/interfaces/Tx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/Tx",permalink:"/sdk/reference/interfaces/Tx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"SetTransactionCostsTx",permalink:"/sdk/reference/interfaces/SetTransactionCostsTx"},next:{title:"VoteEnvelope",permalink:"/sdk/reference/interfaces/VoteEnvelope"}},s={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"tx",id:"tx",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"txInfo",id:"txinfo",level:3},{value:"Defined in",id:"defined-in-1",level:4}],l={toc:c};function d(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},l,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / Tx"),(0,a.kt)("h1",{id:"interface-tx"},"Interface: Tx"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Tx#tx"},"tx")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Tx#txinfo"},"txInfo"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"tx"},"tx"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"tx"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"vote"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"vote"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/VoteEnvelope"},(0,a.kt)("inlineCode",{parentName:"a"},"VoteEnvelope"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"newProcess"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"newProcess"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/NewProcessTx"},(0,a.kt)("inlineCode",{parentName:"a"},"NewProcessTx"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"admin"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"admin"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/AdminTx"},(0,a.kt)("inlineCode",{parentName:"a"},"AdminTx"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"setProcess"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"setProcess"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/SetProcessTx"},(0,a.kt)("inlineCode",{parentName:"a"},"SetProcessTx"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"registerKey"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"registerKey"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/RegisterKeyTx"},(0,a.kt)("inlineCode",{parentName:"a"},"RegisterKeyTx"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"mintTokens"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"mintTokens"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/MintTokensTx"},(0,a.kt)("inlineCode",{parentName:"a"},"MintTokensTx"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"sendTokens"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"sendTokens"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/SendTokensTx"},(0,a.kt)("inlineCode",{parentName:"a"},"SendTokensTx"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"setTransactionCosts"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"setTransactionCosts"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/SetTransactionCostsTx"},(0,a.kt)("inlineCode",{parentName:"a"},"SetTransactionCostsTx"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"setAccount"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"setAccountInfo"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/SetAccountTx"},(0,a.kt)("inlineCode",{parentName:"a"},"SetAccountTx"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"collectFaucet"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"collectFaucet"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/CollectFaucetTx"},(0,a.kt)("inlineCode",{parentName:"a"},"CollectFaucetTx"))," }"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L4"},"api/chain/transactions.ts:4")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"txinfo"},"txInfo"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"txInfo"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainTxReference"},(0,a.kt)("inlineCode",{parentName:"a"},"IChainTxReference"))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L53"},"api/chain/transactions.ts:53")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4719],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>k});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),c=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},l=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),f=c(n),k=a,m=f["".concat(s,".").concat(k)]||f[k]||d[k]||i;return n?r.createElement(m,o(o({ref:t},l),{},{components:n})):r.createElement(m,o({ref:t},l))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=f;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p.mdxType="string"==typeof e?e:a,o[1]=p;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=n(87462),a=(n(67294),n(3905));const i={},o=void 0,p={unversionedId:"sdk/reference/interfaces/Tx",id:"sdk/reference/interfaces/Tx",title:"Tx",description:"@vocdoni/sdk / Exports / Tx",source:"@site/docs/sdk/reference/interfaces/Tx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/Tx",permalink:"/sdk/reference/interfaces/Tx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"SetTransactionCostsTx",permalink:"/sdk/reference/interfaces/SetTransactionCostsTx"},next:{title:"VoteEnvelope",permalink:"/sdk/reference/interfaces/VoteEnvelope"}},s={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"tx",id:"tx",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"txInfo",id:"txinfo",level:3},{value:"Defined in",id:"defined-in-1",level:4}],l={toc:c};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / Tx"),(0,a.kt)("h1",{id:"interface-tx"},"Interface: Tx"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Tx#tx"},"tx")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Tx#txinfo"},"txInfo"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"tx"},"tx"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"tx"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"vote"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"vote"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/VoteEnvelope"},(0,a.kt)("inlineCode",{parentName:"a"},"VoteEnvelope"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"newProcess"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"newProcess"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/NewProcessTx"},(0,a.kt)("inlineCode",{parentName:"a"},"NewProcessTx"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"admin"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"admin"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/AdminTx"},(0,a.kt)("inlineCode",{parentName:"a"},"AdminTx"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"setProcess"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"setProcess"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/SetProcessTx"},(0,a.kt)("inlineCode",{parentName:"a"},"SetProcessTx"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"registerKey"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"registerKey"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/RegisterKeyTx"},(0,a.kt)("inlineCode",{parentName:"a"},"RegisterKeyTx"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"mintTokens"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"mintTokens"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/MintTokensTx"},(0,a.kt)("inlineCode",{parentName:"a"},"MintTokensTx"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"sendTokens"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"sendTokens"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/SendTokensTx"},(0,a.kt)("inlineCode",{parentName:"a"},"SendTokensTx"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"setTransactionCosts"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"setTransactionCosts"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/SetTransactionCostsTx"},(0,a.kt)("inlineCode",{parentName:"a"},"SetTransactionCostsTx"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"setAccount"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"setAccountInfo"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/SetAccountTx"},(0,a.kt)("inlineCode",{parentName:"a"},"SetAccountTx"))," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"collectFaucet"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"collectFaucet"),": ",(0,a.kt)("a",{parentName:"p",href:"CollectFaucetTx"},(0,a.kt)("inlineCode",{parentName:"a"},"CollectFaucetTx"))," }"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L4"},"api/chain/transactions.ts:4")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"txinfo"},"txInfo"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"txInfo"),": ",(0,a.kt)("a",{parentName:"p",href:"IChainTxReference"},(0,a.kt)("inlineCode",{parentName:"a"},"IChainTxReference"))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L53"},"api/chain/transactions.ts:53")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1e8e5e9a.df28d429.js b/assets/js/1e8e5e9a.df28d429.js deleted file mode 100644 index b4c273c8a..000000000 --- a/assets/js/1e8e5e9a.df28d429.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4881],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>c});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),o=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=o(e.components);return a.createElement(d.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),m=o(n),c=r,N=m["".concat(d,".").concat(c)]||m[c]||k[c]||i;return n?a.createElement(N,l(l({ref:t},s),{},{components:n})):a.createElement(N,l({ref:t},s))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:r,l[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,p={unversionedId:"sdk/reference/classes/ElectionAPI",id:"sdk/reference/classes/ElectionAPI",title:"ElectionAPI",description:"@vocdoni/sdk / Exports / ElectionAPI",source:"@site/docs/sdk/reference/classes/ElectionAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/ElectionAPI",permalink:"/sdk/reference/classes/ElectionAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Election",permalink:"/sdk/reference/classes/Election"},next:{title:"ElectionService",permalink:"/sdk/reference/classes/ElectionService"}},d={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"electionsList",id:"electionslist",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"info",id:"info",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"keys",id:"keys",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"nextElectionId",id:"nextelectionid",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"price",id:"price",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"votesCount",id:"votescount",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"votesList",id:"voteslist",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4}],s={toc:o};function k(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ElectionAPI"),(0,r.kt)("h1",{id:"class-electionapi"},"Class: ElectionAPI"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"API")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"ElectionAPI"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionAPI#constructor"},"constructor"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionAPI#create"},"create")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionAPI#electionslist"},"electionsList")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionAPI#info"},"info")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionAPI#isapierror"},"isApiError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionAPI#isundefinederror"},"isUndefinedError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionAPI#keys"},"keys")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionAPI#nextelectionid"},"nextElectionId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionAPI#price"},"price")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionAPI#votescount"},"votesCount")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionAPI#voteslist"},"votesList"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new ElectionAPI"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ElectionAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionAPI"))),(0,r.kt)("p",null,"Cannot be constructed."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ElectionAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionAPI"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"API.constructor"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L373"},"api/election.ts:373")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"create"},"create"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"create"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"metadata"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionCreateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionCreateResponse")),">"),(0,r.kt)("p",null,"Creates a new election."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The set information info raw payload to be submitted to the chain")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"metadata")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The base64 encoded metadata JSON object")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionCreateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionCreateResponse")),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L413"},"api/election.ts:413")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electionslist"},"electionsList"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"electionsList"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionListResponse")),">"),(0,r.kt)("p",null,"Return list of all elections in the chain"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The page number")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IElectionListFilter"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionListFilter"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L487"},"api/election.ts:487")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"info"},"info"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"info"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionInfoResponse")),">"),(0,r.kt)("p",null,"Fetches info about the specified process."),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the election")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionInfoResponse")),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L384"},"api/election.ts:384")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isapierror"},"isApiError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"API.isApiError"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L21"},"api/api.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"API.isUndefinedError"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L64"},"api/api.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"keys"},"keys"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"keys"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionKeysResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionKeysResponse")),">"),(0,r.kt)("p",null,"Fetches the encryption keys from the specified process."),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the election")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionKeysResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionKeysResponse")),">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L398"},"api/election.ts:398")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"nextelectionid"},"nextElectionId"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"nextElectionId"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"organizationId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusOrigin"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"envelopeType?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionNextIdResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionNextIdResponse")),">"),(0,r.kt)("p",null,"Returns the next election id."),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"organizationId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the organization")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusOrigin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census origin")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"envelopeType?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IVoteMode"},(0,r.kt)("inlineCode",{parentName:"a"},"IVoteMode")),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The envelope type")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionNextIdResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionNextIdResponse")),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L429"},"api/election.ts:429")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"price"},"price"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"price"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"maxCensusSize"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionDuration"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"encryptedVotes"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymousVotes"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"maxVoteOverwrite"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IElectionCalculatePriceResponse"),">"),(0,r.kt)("p",null,"Calculates the election price."),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"maxCensusSize")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionDuration")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"encryptedVotes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymousVotes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"maxVoteOverwrite")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IElectionCalculatePriceResponse"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L520"},"api/election.ts:520")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"votescount"},"votesCount"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"votesCount"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IElectionVotesCountResponse"),">"),(0,r.kt)("p",null,"Returns the number of votes of a given election"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the election")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IElectionVotesCountResponse"),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L452"},"api/election.ts:452")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"voteslist"},"votesList"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"votesList"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionVoteListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionVoteListResponse")),">"),(0,r.kt)("p",null,"Returns the list of votes for a given election"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the election")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The page number")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionVoteListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionVoteListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L467"},"api/election.ts:467")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1e8e5e9a.ee47debb.js b/assets/js/1e8e5e9a.ee47debb.js new file mode 100644 index 000000000..ebca1f4d0 --- /dev/null +++ b/assets/js/1e8e5e9a.ee47debb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4881],{3905:(e,t,n)=>{n.d(t,{Zo:()=>k,kt:()=>N});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),d=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},k=function(e){var t=d(e.components);return a.createElement(o.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},s=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,k=p(e,["components","mdxType","originalType","parentName"]),s=d(n),N=r,c=s["".concat(o,".").concat(N)]||s[N]||m[N]||i;return n?a.createElement(c,l(l({ref:t},k),{},{components:n})):a.createElement(c,l({ref:t},k))}));function N(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=s;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p.mdxType="string"==typeof e?e:r,l[1]=p;for(var d=2;d{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,p={unversionedId:"sdk/reference/classes/ElectionAPI",id:"sdk/reference/classes/ElectionAPI",title:"ElectionAPI",description:"@vocdoni/sdk / Exports / ElectionAPI",source:"@site/docs/sdk/reference/classes/ElectionAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/ElectionAPI",permalink:"/sdk/reference/classes/ElectionAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Election",permalink:"/sdk/reference/classes/Election"},next:{title:"ElectionService",permalink:"/sdk/reference/classes/ElectionService"}},o={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"electionsList",id:"electionslist",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"info",id:"info",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"keys",id:"keys",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"nextElectionId",id:"nextelectionid",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"price",id:"price",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"votesCount",id:"votescount",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"votesList",id:"voteslist",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4}],k={toc:d};function m(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ElectionAPI"),(0,r.kt)("h1",{id:"class-electionapi"},"Class: ElectionAPI"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"API")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"ElectionAPI"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionAPI#constructor"},"constructor"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionAPI#create"},"create")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionAPI#electionslist"},"electionsList")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionAPI#info"},"info")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionAPI#isapierror"},"isApiError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionAPI#isundefinederror"},"isUndefinedError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionAPI#keys"},"keys")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionAPI#nextelectionid"},"nextElectionId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionAPI#price"},"price")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionAPI#votescount"},"votesCount")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionAPI#voteslist"},"votesList"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new ElectionAPI"),"(): ",(0,r.kt)("a",{parentName:"p",href:"ElectionAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionAPI"))),(0,r.kt)("p",null,"Cannot be constructed."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"ElectionAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionAPI"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"API.constructor"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L373"},"api/election.ts:373")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"create"},"create"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"create"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"metadata"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IElectionCreateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionCreateResponse")),">"),(0,r.kt)("p",null,"Creates a new election."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The set information info raw payload to be submitted to the chain")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"metadata")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The base64 encoded metadata JSON object")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IElectionCreateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionCreateResponse")),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L413"},"api/election.ts:413")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electionslist"},"electionsList"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"electionsList"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IElectionListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionListResponse")),">"),(0,r.kt)("p",null,"Return list of all elections in the chain"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The page number")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../interfaces/IElectionListFilter"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionListFilter"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IElectionListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L487"},"api/election.ts:487")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"info"},"info"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"info"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IElectionInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionInfoResponse")),">"),(0,r.kt)("p",null,"Fetches info about the specified process."),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the election")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IElectionInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionInfoResponse")),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L384"},"api/election.ts:384")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isapierror"},"isApiError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"API.isApiError"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L21"},"api/api.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"API.isUndefinedError"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L64"},"api/api.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"keys"},"keys"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"keys"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IElectionKeysResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionKeysResponse")),">"),(0,r.kt)("p",null,"Fetches the encryption keys from the specified process."),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the election")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IElectionKeysResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionKeysResponse")),">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L398"},"api/election.ts:398")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"nextelectionid"},"nextElectionId"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"nextElectionId"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"organizationId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusOrigin"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"envelopeType?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IElectionNextIdResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionNextIdResponse")),">"),(0,r.kt)("p",null,"Returns the next election id."),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"organizationId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the organization")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusOrigin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census origin")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"envelopeType?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,r.kt)("a",{parentName:"td",href:"../interfaces/IVoteMode"},(0,r.kt)("inlineCode",{parentName:"a"},"IVoteMode")),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The envelope type")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IElectionNextIdResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionNextIdResponse")),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L429"},"api/election.ts:429")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"price"},"price"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"price"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"maxCensusSize"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionDuration"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"encryptedVotes"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymousVotes"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"maxVoteOverwrite"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IElectionCalculatePriceResponse"),">"),(0,r.kt)("p",null,"Calculates the election price."),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"maxCensusSize")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionDuration")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"encryptedVotes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymousVotes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"maxVoteOverwrite")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IElectionCalculatePriceResponse"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L520"},"api/election.ts:520")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"votescount"},"votesCount"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"votesCount"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IElectionVotesCountResponse"),">"),(0,r.kt)("p",null,"Returns the number of votes of a given election"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the election")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IElectionVotesCountResponse"),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L452"},"api/election.ts:452")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"voteslist"},"votesList"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"votesList"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IElectionVoteListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionVoteListResponse")),">"),(0,r.kt)("p",null,"Returns the list of votes for a given election"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the election")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The page number")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IElectionVoteListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionVoteListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L467"},"api/election.ts:467")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1ed63671.4f09601b.js b/assets/js/1ed63671.4f09601b.js deleted file mode 100644 index 2e5e97666..000000000 --- a/assets/js/1ed63671.4f09601b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7998],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>u});var i=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function l(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=i.createContext({}),p=function(e){var n=i.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},c=function(e){var n=p(e.components);return i.createElement(s.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},k=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,r=e.originalType,s=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),k=p(t),u=a,T=k["".concat(s,".").concat(u)]||k[u]||d[u]||r;return t?i.createElement(T,l(l({ref:n},c),{},{components:t})):i.createElement(T,l({ref:n},c))}));function u(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var r=t.length,l=new Array(r);l[0]=k;var o={};for(var s in n)hasOwnProperty.call(n,s)&&(o[s]=n[s]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var p=2;p{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>p});var i=t(87462),a=(t(67294),t(3905));const r={},l=void 0,o={unversionedId:"sdk/reference/enums/TransactionType",id:"sdk/reference/enums/TransactionType",title:"TransactionType",description:"@vocdoni/sdk / Exports / TransactionType",source:"@site/docs/sdk/reference/enums/TransactionType.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/TransactionType",permalink:"/sdk/reference/enums/TransactionType",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"EnvOptions",permalink:"/sdk/reference/enums/EnvOptions"},next:{title:"TxType",permalink:"/sdk/reference/enums/TxType"}},s={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"ADMIN_TX",id:"admin_tx",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"COLLECT_FAUCET_TX",id:"collect_faucet_tx",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"MINT_TOKENS_TX",id:"mint_tokens_tx",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"NEW_PROCESS_TX",id:"new_process_tx",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"REGISTER_KEY_TX",id:"register_key_tx",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"SEND_TOKENS_TX",id:"send_tokens_tx",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"SET_ACCOUNT_TX",id:"set_account_tx",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"SET_KEYKEEPER_TX",id:"set_keykeeper_tx",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"SET_PROCESS_TX",id:"set_process_tx",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"SET_TRANSACTION_COSTS_TX",id:"set_transaction_costs_tx",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"VOTE_ENVELOPE",id:"vote_envelope",level:3},{value:"Defined in",id:"defined-in-10",level:4}],c={toc:p};function d(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,i.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / TransactionType"),(0,a.kt)("h1",{id:"enumeration-transactiontype"},"Enumeration: TransactionType"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#admin_tx"},"ADMIN","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#collect_faucet_tx"},"COLLECT","_","FAUCET","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#mint_tokens_tx"},"MINT","_","TOKENS","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#new_process_tx"},"NEW","_","PROCESS","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#register_key_tx"},"REGISTER","_","KEY","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#send_tokens_tx"},"SEND","_","TOKENS","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#set_account_tx"},"SET","_","ACCOUNT","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#set_keykeeper_tx"},"SET","_","KEYKEEPER","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#set_process_tx"},"SET","_","PROCESS","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#set_transaction_costs_tx"},"SET","_","TRANSACTION","_","COSTS","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#vote_envelope"},"VOTE","_","ENVELOPE"))),(0,a.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,a.kt)("h3",{id:"admin_tx"},"ADMIN","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"ADMIN","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"admin"')),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L168"},"api/chain.ts:168")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"collect_faucet_tx"},"COLLECT","_","FAUCET","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"COLLECT","_","FAUCET","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"collectFaucet"')),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L175"},"api/chain.ts:175")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"mint_tokens_tx"},"MINT","_","TOKENS","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"MINT","_","TOKENS","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"mintTokens"')),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L171"},"api/chain.ts:171")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"new_process_tx"},"NEW","_","PROCESS","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"NEW","_","PROCESS","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"newProcess"')),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L167"},"api/chain.ts:167")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"register_key_tx"},"REGISTER","_","KEY","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"REGISTER","_","KEY","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"registerKey"')),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L170"},"api/chain.ts:170")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"send_tokens_tx"},"SEND","_","TOKENS","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"SEND","_","TOKENS","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"sendTokens"')),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L172"},"api/chain.ts:172")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"set_account_tx"},"SET","_","ACCOUNT","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"SET","_","ACCOUNT","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"setAccount"')),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L174"},"api/chain.ts:174")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"set_keykeeper_tx"},"SET","_","KEYKEEPER","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"SET","_","KEYKEEPER","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"setKeykeeper"')),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L176"},"api/chain.ts:176")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"set_process_tx"},"SET","_","PROCESS","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"SET","_","PROCESS","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"setProcess"')),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L169"},"api/chain.ts:169")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"set_transaction_costs_tx"},"SET","_","TRANSACTION","_","COSTS","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"SET","_","TRANSACTION","_","COSTS","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"setTransactionCosts"')),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L173"},"api/chain.ts:173")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"vote_envelope"},"VOTE","_","ENVELOPE"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"VOTE","_","ENVELOPE")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"vote"')),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L166"},"api/chain.ts:166")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1ed63671.9ee306a8.js b/assets/js/1ed63671.9ee306a8.js new file mode 100644 index 000000000..e74df5300 --- /dev/null +++ b/assets/js/1ed63671.9ee306a8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7998],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>u});var i=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function l(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=i.createContext({}),p=function(e){var n=i.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},c=function(e){var n=p(e.components);return i.createElement(s.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},k=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,r=e.originalType,s=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),k=p(t),u=a,T=k["".concat(s,".").concat(u)]||k[u]||d[u]||r;return t?i.createElement(T,l(l({ref:n},c),{},{components:t})):i.createElement(T,l({ref:n},c))}));function u(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var r=t.length,l=new Array(r);l[0]=k;var o={};for(var s in n)hasOwnProperty.call(n,s)&&(o[s]=n[s]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var p=2;p{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>p});var i=t(87462),a=(t(67294),t(3905));const r={},l=void 0,o={unversionedId:"sdk/reference/enums/TransactionType",id:"sdk/reference/enums/TransactionType",title:"TransactionType",description:"@vocdoni/sdk / Exports / TransactionType",source:"@site/docs/sdk/reference/enums/TransactionType.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/TransactionType",permalink:"/sdk/reference/enums/TransactionType",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"EnvOptions",permalink:"/sdk/reference/enums/EnvOptions"},next:{title:"TxType",permalink:"/sdk/reference/enums/TxType"}},s={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"ADMIN_TX",id:"admin_tx",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"COLLECT_FAUCET_TX",id:"collect_faucet_tx",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"MINT_TOKENS_TX",id:"mint_tokens_tx",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"NEW_PROCESS_TX",id:"new_process_tx",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"REGISTER_KEY_TX",id:"register_key_tx",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"SEND_TOKENS_TX",id:"send_tokens_tx",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"SET_ACCOUNT_TX",id:"set_account_tx",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"SET_KEYKEEPER_TX",id:"set_keykeeper_tx",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"SET_PROCESS_TX",id:"set_process_tx",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"SET_TRANSACTION_COSTS_TX",id:"set_transaction_costs_tx",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"VOTE_ENVELOPE",id:"vote_envelope",level:3},{value:"Defined in",id:"defined-in-10",level:4}],c={toc:p};function d(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,i.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / TransactionType"),(0,a.kt)("h1",{id:"enumeration-transactiontype"},"Enumeration: TransactionType"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#admin_tx"},"ADMIN","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#collect_faucet_tx"},"COLLECT","_","FAUCET","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#mint_tokens_tx"},"MINT","_","TOKENS","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#new_process_tx"},"NEW","_","PROCESS","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#register_key_tx"},"REGISTER","_","KEY","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#send_tokens_tx"},"SEND","_","TOKENS","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#set_account_tx"},"SET","_","ACCOUNT","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#set_keykeeper_tx"},"SET","_","KEYKEEPER","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#set_process_tx"},"SET","_","PROCESS","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#set_transaction_costs_tx"},"SET","_","TRANSACTION","_","COSTS","_","TX")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType#vote_envelope"},"VOTE","_","ENVELOPE"))),(0,a.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,a.kt)("h3",{id:"admin_tx"},"ADMIN","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"ADMIN","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"admin"')),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L168"},"api/chain.ts:168")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"collect_faucet_tx"},"COLLECT","_","FAUCET","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"COLLECT","_","FAUCET","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"collectFaucet"')),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L175"},"api/chain.ts:175")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"mint_tokens_tx"},"MINT","_","TOKENS","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"MINT","_","TOKENS","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"mintTokens"')),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L171"},"api/chain.ts:171")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"new_process_tx"},"NEW","_","PROCESS","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"NEW","_","PROCESS","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"newProcess"')),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L167"},"api/chain.ts:167")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"register_key_tx"},"REGISTER","_","KEY","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"REGISTER","_","KEY","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"registerKey"')),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L170"},"api/chain.ts:170")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"send_tokens_tx"},"SEND","_","TOKENS","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"SEND","_","TOKENS","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"sendTokens"')),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L172"},"api/chain.ts:172")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"set_account_tx"},"SET","_","ACCOUNT","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"SET","_","ACCOUNT","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"setAccount"')),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L174"},"api/chain.ts:174")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"set_keykeeper_tx"},"SET","_","KEYKEEPER","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"SET","_","KEYKEEPER","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"setKeykeeper"')),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L176"},"api/chain.ts:176")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"set_process_tx"},"SET","_","PROCESS","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"SET","_","PROCESS","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"setProcess"')),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L169"},"api/chain.ts:169")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"set_transaction_costs_tx"},"SET","_","TRANSACTION","_","COSTS","_","TX"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"SET","_","TRANSACTION","_","COSTS","_","TX")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"setTransactionCosts"')),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L173"},"api/chain.ts:173")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"vote_envelope"},"VOTE","_","ENVELOPE"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"VOTE","_","ENVELOPE")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"vote"')),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L166"},"api/chain.ts:166")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1edcfddb.4b9ada06.js b/assets/js/1edcfddb.dcd81d5a.js similarity index 51% rename from assets/js/1edcfddb.4b9ada06.js rename to assets/js/1edcfddb.dcd81d5a.js index 1fb40b23a..903c89302 100644 --- a/assets/js/1edcfddb.4b9ada06.js +++ b/assets/js/1edcfddb.dcd81d5a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5288],{3905:(e,r,t)=>{t.d(r,{Zo:()=>p,kt:()=>d});var n=t(67294);function i(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function o(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function c(e){for(var r=1;r=0||(i[t]=e[t]);return i}(e,r);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var l=n.createContext({}),s=function(e){var r=n.useContext(l),t=r;return e&&(t="function"==typeof e?e(r):c(c({},r),e)),t},p=function(e){var r=s(e.components);return n.createElement(l.Provider,{value:r},e.children)},f={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},u=n.forwardRef((function(e,r){var t=e.components,i=e.mdxType,o=e.originalType,l=e.parentName,p=a(e,["components","mdxType","originalType","parentName"]),u=s(t),d=i,v=u["".concat(l,".").concat(d)]||u[d]||f[d]||o;return t?n.createElement(v,c(c({ref:r},p),{},{components:t})):n.createElement(v,c({ref:r},p))}));function d(e,r){var t=arguments,i=r&&r.mdxType;if("string"==typeof e||i){var o=t.length,c=new Array(o);c[0]=u;var a={};for(var l in r)hasOwnProperty.call(r,l)&&(a[l]=r[l]);a.originalType=e,a.mdxType="string"==typeof e?e:i,c[1]=a;for(var s=2;s{t.r(r),t.d(r,{assets:()=>l,contentTitle:()=>c,default:()=>f,frontMatter:()=>o,metadata:()=>a,toc:()=>s});var n=t(87462),i=(t(67294),t(3905));const o={},c=void 0,a={unversionedId:"sdk/reference/interfaces/ServiceProperties",id:"sdk/reference/interfaces/ServiceProperties",title:"ServiceProperties",description:"@vocdoni/sdk / Exports / ServiceProperties",source:"@site/docs/sdk/reference/interfaces/ServiceProperties.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ServiceProperties",permalink:"/sdk/reference/interfaces/ServiceProperties",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"SendTokensTx",permalink:"/sdk/reference/interfaces/SendTokensTx"},next:{title:"SetAccountTx",permalink:"/sdk/reference/interfaces/SetAccountTx"}},l={},s=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:s};function f(e){let{components:r,...t}=e;return(0,i.kt)("wrapper",(0,n.Z)({},p,t,{components:r,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ServiceProperties"),(0,i.kt)("h1",{id:"interface-serviceproperties"},"Interface: ServiceProperties"),(0,i.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Service"},(0,i.kt)("inlineCode",{parentName:"a"},"Service")))),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ServiceProperties#url"},"url"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"url"},"url"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"url"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/service.ts#L2"},"services/service.ts:2")))}f.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5288],{3905:(e,r,t)=>{t.d(r,{Zo:()=>p,kt:()=>d});var n=t(67294);function i(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function o(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function a(e){for(var r=1;r=0||(i[t]=e[t]);return i}(e,r);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var l=n.createContext({}),s=function(e){var r=n.useContext(l),t=r;return e&&(t="function"==typeof e?e(r):a(a({},r),e)),t},p=function(e){var r=s(e.components);return n.createElement(l.Provider,{value:r},e.children)},u={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},f=n.forwardRef((function(e,r){var t=e.components,i=e.mdxType,o=e.originalType,l=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),f=s(t),d=i,v=f["".concat(l,".").concat(d)]||f[d]||u[d]||o;return t?n.createElement(v,a(a({ref:r},p),{},{components:t})):n.createElement(v,a({ref:r},p))}));function d(e,r){var t=arguments,i=r&&r.mdxType;if("string"==typeof e||i){var o=t.length,a=new Array(o);a[0]=f;var c={};for(var l in r)hasOwnProperty.call(r,l)&&(c[l]=r[l]);c.originalType=e,c.mdxType="string"==typeof e?e:i,a[1]=c;for(var s=2;s{t.r(r),t.d(r,{assets:()=>l,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>s});var n=t(87462),i=(t(67294),t(3905));const o={},a=void 0,c={unversionedId:"sdk/reference/interfaces/ServiceProperties",id:"sdk/reference/interfaces/ServiceProperties",title:"ServiceProperties",description:"@vocdoni/sdk / Exports / ServiceProperties",source:"@site/docs/sdk/reference/interfaces/ServiceProperties.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ServiceProperties",permalink:"/sdk/reference/interfaces/ServiceProperties",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"SendTokensTx",permalink:"/sdk/reference/interfaces/SendTokensTx"},next:{title:"SetAccountTx",permalink:"/sdk/reference/interfaces/SetAccountTx"}},l={},s=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:s};function u(e){let{components:r,...t}=e;return(0,i.kt)("wrapper",(0,n.Z)({},p,t,{components:r,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ServiceProperties"),(0,i.kt)("h1",{id:"interface-serviceproperties"},"Interface: ServiceProperties"),(0,i.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"../classes/Service"},(0,i.kt)("inlineCode",{parentName:"a"},"Service")))),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ServiceProperties#url"},"url"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"url"},"url"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"url"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/service.ts#L2"},"services/service.ts:2")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/204645f9.649e11e5.js b/assets/js/204645f9.649e11e5.js deleted file mode 100644 index 967ff08b3..000000000 --- a/assets/js/204645f9.649e11e5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8312],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var o=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function r(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=o.createContext({}),c=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},p=function(e){var t=c(e.components);return o.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},d=o.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=c(n),h=a,m=d["".concat(l,".").concat(h)]||d[h]||u[h]||i;return n?o.createElement(m,r(r({ref:t},p),{},{components:n})):o.createElement(m,r({ref:t},p))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,r=new Array(i);r[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,r[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var o=n(87462),a=(n(67294),n(3905));const i={},r="Quadratic voting",s={unversionedId:"sdk/voting-types/quadratic",id:"sdk/voting-types/quadratic",title:"Quadratic voting",description:"Quadratic voting is a voting mechanism that allows individuals to express their preferences on different issues with",source:"@site/docs/sdk/voting-types/quadratic.md",sourceDirName:"sdk/voting-types",slug:"/sdk/voting-types/quadratic",permalink:"/sdk/voting-types/quadratic",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Weighted voting",permalink:"/sdk/voting-types/weighted"},next:{title:"UI Components",permalink:"/ui-components/"}},l={},c=[{value:"Setting up the election",id:"setting-up-the-election",level:2},{value:"Voter credits",id:"voter-credits",level:3},{value:"Casting a vote",id:"casting-a-vote",level:2},{value:"Results interpretation",id:"results-interpretation",level:2}],p={toc:c};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,o.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"quadratic-voting"},"Quadratic voting"),(0,a.kt)("p",null,"Quadratic voting is a voting mechanism that allows individuals to express their preferences on different issues with\nmore granularity and intensity. In quadratic voting, voters are allocated a fixed number of voting credits, and they can\ndistribute those credits across various options or issues in a quadratic manner. This means that voters can assign more\ncredits to options they care strongly about while still being able to express preferences on multiple issues."),(0,a.kt)("p",null,"The quadratic aspect of the system ensures that the cost of allocating additional credits increases quadratically, which\nhelps prevent a small number of voters from dominating the decision-making process. Quadratic voting aims to promote a\nmore accurate representation of individual preferences and allocate resources based on the collective intensity of\npreferences rather than just a simple majority rule."),(0,a.kt)("p",null,"See:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/examples/typescript/src/quadratic.ts"},"Complete example")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/protocol/ballot-protocol#quadratic-voting"},"Ballot protocol implementation"))),(0,a.kt)("h2",{id:"setting-up-the-election"},"Setting up the election"),(0,a.kt)("p",null,"Here we are going to describe how to configure an election to set up a quadratic voting. When the election object is\ncreated,"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"const election_opts: IVoteType = {\n maxValue: 0, // Must be 0 for quadratic elections\n maxCount: CHOICES_LENGTH, // Number of choices for the question\n uniqueChoices: false,\n costFromWeight: true, // This will set that the weight on a weighted census is actually the credits available\n costExponent: 2, // In the context of quadratic voting, this value is usually set to 2\n};\n")),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"The actual Vocdoni implementation only allow quadratic elections with only one question. For that, the ",(0,a.kt)("inlineCode",{parentName:"li"},"maxCount"),"\nrefers to the choices length for this unique question. "),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"costExponent")," define the exponent for quadratic voting calculation. In the context of quadratic voting, this value is\nusually set to 2. This exponent determines the cost of a vote. For example, if a voter assigns 2 credits to an option,\nthe cost of that vote would be 2^2 = 4. Look at SDK docs for more info.")),(0,a.kt)("h3",{id:"voter-credits"},"Voter credits"),(0,a.kt)("p",null,"To determine the number of credits each voter can use, the configuration must be defined in one of two ways:"),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Adjusting the ",(0,a.kt)("inlineCode",{parentName:"p"},"maxTotalCost"),", on the election options, and using a ",(0,a.kt)("inlineCode",{parentName:"p"},"PlainCensus")," allows for an equal number of credits to be\nallocated to each voter.")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Alternatively, by enabling ",(0,a.kt)("inlineCode",{parentName:"p"},"costFromWeight")," and using a ",(0,a.kt)("inlineCode",{parentName:"p"},"WeightedCensus"),", the number of credits available will\ncorrespond to the voter's weight."))),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"}," const census = new WeightedCensus();\n census.add(\n participants.map((participant, index) => ({\n key: participant.address,\n weight: BigInt(20), // Give 20 credits to every voter\n }))\n );\n")),(0,a.kt)("p",null,"Using this method will enable the possibility to give different number of credits for every voter. "),(0,a.kt)("h2",{id:"casting-a-vote"},"Casting a vote"),(0,a.kt)("p",null,"As of now, the ",(0,a.kt)("a",{parentName:"p",href:"/protocol/ballot-protocol#vocdoni-results-interpretation"},"protocol"),"\nfor quadratic elections only supports single question elections with discrete values. "),(0,a.kt)("p",null,"Therefore, to cast a vote, you can use the following method:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"client.submitVote(new Vote([2, 3]));\n")),(0,a.kt)("p",null,"This approach calculates the cost of each vote based on the costExponent, for example, allocating 2 votes for option 0\nwill consume 4 credits (2^2 = 4 credits) and 3 votes for option 1 will consume 9 credits (3^2 = 9 credits), with a\ntotal of 13 (4 + 9) credits spent:"),(0,a.kt)("p",null,"The formula (in this case) is like:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"Votes | Credits\n1\xb2 = 1\n2\xb2 = 4\n3\xb2 = 9\n4\xb2 = 16\n")),(0,a.kt)("h2",{id:"results-interpretation"},"Results interpretation"),(0,a.kt)("p",null,"Let's imagine a scenario where we have 10 voters and each of them casts the same vote ",(0,a.kt)("inlineCode",{parentName:"p"},"[2, 3]"),"."),(0,a.kt)("p",null,"The election results are presented as a bi-dimensional array:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"[ \n [ '20' ], [ '30' ] \n]\n")),(0,a.kt)("p",null,"The first array position ",(0,a.kt)("inlineCode",{parentName:"p"},"[ '20' ]")," and the second ",(0,a.kt)("inlineCode",{parentName:"p"},"[ '30' ]")," represent the sum of votes cast for option one and option\ntwo, respectively. In this instance, each voter assigned two votes to option one and three votes to option two."),(0,a.kt)("p",null,"Given that there are 10 voters and each voted the same way, the sum of all the votes is as follows:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"For option one ",(0,a.kt)("inlineCode",{parentName:"li"},"([ '20' ])"),": Each of the 10 voters gave two votes, leading to a total of 20 votes."),(0,a.kt)("li",{parentName:"ul"},"For option two ",(0,a.kt)("inlineCode",{parentName:"li"},"([ '30' ])"),": Each voter gave three votes, leading to a total of 30 votes.")),(0,a.kt)("p",null,"Remember, this interpretation assumes that all voters have used the same voting pattern. Moreover, under the\nquadratic voting system, while it is possible to cast more votes for a preferred option, it also becomes exponentially\nmore costly to do so, providing a self-balancing mechanism that aims to accurately reflect the strength of voters\npreferences."))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2340828a.0061e8ca.js b/assets/js/2340828a.0061e8ca.js new file mode 100644 index 000000000..d965b4883 --- /dev/null +++ b/assets/js/2340828a.0061e8ca.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4376],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>k});var a=r(67294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),o=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},p=function(e){var t=o(e.components);return a.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),u=o(r),k=n,m=u["".concat(s,".").concat(k)]||u[k]||d[k]||i;return r?a.createElement(m,l(l({ref:t},p),{},{components:r})):a.createElement(m,l({ref:t},p))}));function k(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=u;var c={};for(var s in t)hasOwnProperty.call(t,s)&&(c[s]=t[s]);c.originalType=e,c.mdxType="string"==typeof e?e:n,l[1]=c;for(var o=2;o{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>o});var a=r(87462),n=(r(67294),r(3905));const i={},l=void 0,c={unversionedId:"sdk/reference/classes/FaucetService",id:"sdk/reference/classes/FaucetService",title:"FaucetService",description:"@vocdoni/sdk / Exports / FaucetService",source:"@site/docs/sdk/reference/classes/FaucetService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/FaucetService",permalink:"/sdk/reference/classes/FaucetService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"FaucetAPI",permalink:"/sdk/reference/classes/FaucetAPI"},next:{title:"FileAPI",permalink:"/sdk/reference/classes/FileAPI"}},s={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"token_limit",id:"token_limit",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods-1",level:2},{value:"fetchPayload",id:"fetchpayload",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"parseFaucetPackage",id:"parsefaucetpackage",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-4",level:4}],p={toc:o};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,n.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / FaucetService"),(0,n.kt)("h1",{id:"class-faucetservice"},"Class: FaucetService"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"Service"},(0,n.kt)("inlineCode",{parentName:"a"},"Service"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"FaucetService"))))),(0,n.kt)("h2",{id:"implements"},"Implements"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"FaucetServiceProperties"))),(0,n.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,n.kt)("h3",{id:"constructors"},"Constructors"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"FaucetService#constructor"},"constructor"))),(0,n.kt)("h3",{id:"properties"},"Properties"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FaucetService#token_limit"},"token","_","limit")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"FaucetService#url"},"url"))),(0,n.kt)("h3",{id:"methods"},"Methods"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"FaucetService#fetchpayload"},"fetchPayload")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"FaucetService#parsefaucetpackage"},"parseFaucetPackage"))),(0,n.kt)("h2",{id:"constructors-1"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new FaucetService"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"FaucetService"},(0,n.kt)("inlineCode",{parentName:"a"},"FaucetService"))),(0,n.kt)("p",null,"Instantiate the chain service."),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,n.kt)("inlineCode",{parentName:"td"},"FaucetServiceParameters"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"FaucetService"},(0,n.kt)("inlineCode",{parentName:"a"},"FaucetService"))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,n.kt)("a",{parentName:"p",href:"Service#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/faucet.ts#L38"},"services/faucet.ts:38")),(0,n.kt)("h2",{id:"properties-1"},"Properties"),(0,n.kt)("h3",{id:"token_limit"},"token","_","limit"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"token","_","limit"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,n.kt)("p",null,"FaucetServiceProperties.token","_","limit"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/faucet.ts#L31"},"services/faucet.ts:31")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"url"},"url"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"url"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,n.kt)("a",{parentName:"p",href:"Service#url"},"url")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/service.ts#L6"},"services/service.ts:6")),(0,n.kt)("h2",{id:"methods-1"},"Methods"),(0,n.kt)("h3",{id:"fetchpayload"},"fetchPayload"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetchPayload"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"address"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"Fetches a faucet payload. Only for development."),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"address")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The address where to send the tokens")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The encoded faucet package"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/faucet.ts#L49"},"services/faucet.ts:49")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"parsefaucetpackage"},"parseFaucetPackage"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"parseFaucetPackage"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"faucetPackage"),"): ",(0,n.kt)("a",{parentName:"p",href:"../modules#faucetpackage"},(0,n.kt)("inlineCode",{parentName:"a"},"FaucetPackage"))),(0,n.kt)("p",null,"Parses a faucet package."),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"faucetPackage")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"../modules#faucetpackage"},(0,n.kt)("inlineCode",{parentName:"a"},"FaucetPackage"))),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/faucet.ts#L59"},"services/faucet.ts:59")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2340828a.12acb666.js b/assets/js/2340828a.12acb666.js deleted file mode 100644 index 674bd2690..000000000 --- a/assets/js/2340828a.12acb666.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4376],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>k});var a=r(67294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),o=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},p=function(e){var t=o(e.components);return a.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=o(r),k=n,m=u["".concat(c,".").concat(k)]||u[k]||d[k]||i;return r?a.createElement(m,l(l({ref:t},p),{},{components:r})):a.createElement(m,l({ref:t},p))}));function k(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=u;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s.mdxType="string"==typeof e?e:n,l[1]=s;for(var o=2;o{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>o});var a=r(87462),n=(r(67294),r(3905));const i={},l=void 0,s={unversionedId:"sdk/reference/classes/FaucetService",id:"sdk/reference/classes/FaucetService",title:"FaucetService",description:"@vocdoni/sdk / Exports / FaucetService",source:"@site/docs/sdk/reference/classes/FaucetService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/FaucetService",permalink:"/sdk/reference/classes/FaucetService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"FaucetAPI",permalink:"/sdk/reference/classes/FaucetAPI"},next:{title:"FileAPI",permalink:"/sdk/reference/classes/FileAPI"}},c={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"token_limit",id:"token_limit",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods-1",level:2},{value:"fetchPayload",id:"fetchpayload",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"parseFaucetPackage",id:"parsefaucetpackage",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-4",level:4}],p={toc:o};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,n.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / FaucetService"),(0,n.kt)("h1",{id:"class-faucetservice"},"Class: FaucetService"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},(0,n.kt)("inlineCode",{parentName:"a"},"Service"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"FaucetService"))))),(0,n.kt)("h2",{id:"implements"},"Implements"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"FaucetServiceProperties"))),(0,n.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,n.kt)("h3",{id:"constructors"},"Constructors"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FaucetService#constructor"},"constructor"))),(0,n.kt)("h3",{id:"properties"},"Properties"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FaucetService#token_limit"},"token","_","limit")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FaucetService#url"},"url"))),(0,n.kt)("h3",{id:"methods"},"Methods"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FaucetService#fetchpayload"},"fetchPayload")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FaucetService#parsefaucetpackage"},"parseFaucetPackage"))),(0,n.kt)("h2",{id:"constructors-1"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new FaucetService"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/sdk/reference/classes/FaucetService"},(0,n.kt)("inlineCode",{parentName:"a"},"FaucetService"))),(0,n.kt)("p",null,"Instantiate the chain service."),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,n.kt)("inlineCode",{parentName:"td"},"FaucetServiceParameters"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/sdk/reference/classes/FaucetService"},(0,n.kt)("inlineCode",{parentName:"a"},"FaucetService"))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,n.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/faucet.ts#L38"},"services/faucet.ts:38")),(0,n.kt)("h2",{id:"properties-1"},"Properties"),(0,n.kt)("h3",{id:"token_limit"},"token","_","limit"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"token","_","limit"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,n.kt)("p",null,"FaucetServiceProperties.token","_","limit"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/faucet.ts#L31"},"services/faucet.ts:31")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"url"},"url"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"url"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,n.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#url"},"url")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/service.ts#L6"},"services/service.ts:6")),(0,n.kt)("h2",{id:"methods-1"},"Methods"),(0,n.kt)("h3",{id:"fetchpayload"},"fetchPayload"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetchPayload"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"address"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"Fetches a faucet payload. Only for development."),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"address")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The address where to send the tokens")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The encoded faucet package"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/faucet.ts#L49"},"services/faucet.ts:49")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"parsefaucetpackage"},"parseFaucetPackage"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"parseFaucetPackage"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"faucetPackage"),"): ",(0,n.kt)("a",{parentName:"p",href:"/sdk/reference/modules#faucetpackage"},(0,n.kt)("inlineCode",{parentName:"a"},"FaucetPackage"))),(0,n.kt)("p",null,"Parses a faucet package."),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"faucetPackage")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/sdk/reference/modules#faucetpackage"},(0,n.kt)("inlineCode",{parentName:"a"},"FaucetPackage"))),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/faucet.ts#L59"},"services/faucet.ts:59")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/23e9e137.5d2f4ad6.js b/assets/js/23e9e137.4da9b2c5.js similarity index 52% rename from assets/js/23e9e137.5d2f4ad6.js rename to assets/js/23e9e137.4da9b2c5.js index 32dd7a638..fc0730a85 100644 --- a/assets/js/23e9e137.5d2f4ad6.js +++ b/assets/js/23e9e137.4da9b2c5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8016],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var r=n(67294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var p=r.createContext({}),l=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,s=e.mdxType,a=e.originalType,p=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),u=l(n),f=s,k=u["".concat(p,".").concat(f)]||u[f]||d[f]||a;return n?r.createElement(k,o(o({ref:t},c),{},{components:n})):r.createElement(k,o({ref:t},c))}));function f(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var a=n.length,o=new Array(a);o[0]=u;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i.mdxType="string"==typeof e?e:s,o[1]=i;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=n(87462),s=(n(67294),n(3905));const a={},o=void 0,i={unversionedId:"sdk/reference/interfaces/ICensusExportResponse",id:"sdk/reference/interfaces/ICensusExportResponse",title:"ICensusExportResponse",description:"@vocdoni/sdk / Exports / ICensusExportResponse",source:"@site/docs/sdk/reference/interfaces/ICensusExportResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensusExportResponse",permalink:"/sdk/reference/interfaces/ICensusExportResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3ValidatePredicateToken",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateToken"},next:{title:"ICensusImportResponse",permalink:"/sdk/reference/interfaces/ICensusImportResponse"}},p={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"data",id:"data",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"maxLevels",id:"maxlevels",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"rootHash",id:"roothash",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:l};function d(e){let{components:t,...n}=e;return(0,s.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensusExportResponse"),(0,s.kt)("h1",{id:"interface-icensusexportresponse"},"Interface: ICensusExportResponse"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusExportResponse#data"},"data")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusExportResponse#maxlevels"},"maxLevels")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusExportResponse#roothash"},"rootHash")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusExportResponse#type"},"type"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"data"},"data"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"data"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The data of the census"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L54"},"api/census.ts:54")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"maxlevels"},"maxLevels"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"maxLevels"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("p",null,"The max levels of the census"),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L59"},"api/census.ts:59")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"roothash"},"rootHash"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"rootHash"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The root hash of the census"),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L49"},"api/census.ts:49")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"type"},"type"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"type"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("p",null,"The type of the census"),(0,s.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L44"},"api/census.ts:44")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8016],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var r=n(67294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var p=r.createContext({}),l=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,s=e.mdxType,a=e.originalType,p=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),d=l(n),f=s,k=d["".concat(p,".").concat(f)]||d[f]||u[f]||a;return n?r.createElement(k,o(o({ref:t},c),{},{components:n})):r.createElement(k,o({ref:t},c))}));function f(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var a=n.length,o=new Array(a);o[0]=d;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i.mdxType="string"==typeof e?e:s,o[1]=i;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=n(87462),s=(n(67294),n(3905));const a={},o=void 0,i={unversionedId:"sdk/reference/interfaces/ICensusExportResponse",id:"sdk/reference/interfaces/ICensusExportResponse",title:"ICensusExportResponse",description:"@vocdoni/sdk / Exports / ICensusExportResponse",source:"@site/docs/sdk/reference/interfaces/ICensusExportResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensusExportResponse",permalink:"/sdk/reference/interfaces/ICensusExportResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3ValidatePredicateToken",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateToken"},next:{title:"ICensusImportResponse",permalink:"/sdk/reference/interfaces/ICensusImportResponse"}},p={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"data",id:"data",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"maxLevels",id:"maxlevels",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"rootHash",id:"roothash",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:l};function u(e){let{components:t,...n}=e;return(0,s.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensusExportResponse"),(0,s.kt)("h1",{id:"interface-icensusexportresponse"},"Interface: ICensusExportResponse"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensusExportResponse#data"},"data")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensusExportResponse#maxlevels"},"maxLevels")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensusExportResponse#roothash"},"rootHash")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensusExportResponse#type"},"type"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"data"},"data"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"data"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The data of the census"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L54"},"api/census.ts:54")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"maxlevels"},"maxLevels"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"maxLevels"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("p",null,"The max levels of the census"),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L59"},"api/census.ts:59")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"roothash"},"rootHash"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"rootHash"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The root hash of the census"),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L49"},"api/census.ts:49")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"type"},"type"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"type"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("p",null,"The type of the census"),(0,s.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L44"},"api/census.ts:44")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/24ee6be4.a1ab6429.js b/assets/js/24ee6be4.24b55f96.js similarity index 75% rename from assets/js/24ee6be4.a1ab6429.js rename to assets/js/24ee6be4.24b55f96.js index bf252cbf6..2d329d120 100644 --- a/assets/js/24ee6be4.a1ab6429.js +++ b/assets/js/24ee6be4.24b55f96.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5326],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>d});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=r.createContext({}),p=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},l=function(e){var t=p(e.components);return r.createElement(c.Provider,{value:t},e.children)},f={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,c=e.parentName,l=o(e,["components","mdxType","originalType","parentName"]),u=p(n),d=i,k=u["".concat(c,".").concat(d)]||u[d]||f[d]||a;return n?r.createElement(k,s(s({ref:t},l),{},{components:n})):r.createElement(k,s({ref:t},l))}));function d(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,s=new Array(a);s[0]=u;var o={};for(var c in t)hasOwnProperty.call(t,c)&&(o[c]=t[c]);o.originalType=e,o.mdxType="string"==typeof e?e:i,s[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>f,frontMatter:()=>a,metadata:()=>o,toc:()=>p});var r=n(87462),i=(n(67294),n(3905));const a={},s=void 0,o={unversionedId:"sdk/reference/interfaces/ICensusParticipant",id:"sdk/reference/interfaces/ICensusParticipant",title:"ICensusParticipant",description:"@vocdoni/sdk / Exports / ICensusParticipant",source:"@site/docs/sdk/reference/interfaces/ICensusParticipant.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensusParticipant",permalink:"/sdk/reference/interfaces/ICensusParticipant",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensusImportResponse",permalink:"/sdk/reference/interfaces/ICensusImportResponse"},next:{title:"ICensusProofResponse",permalink:"/sdk/reference/interfaces/ICensusProofResponse"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"key",id:"key",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"weight",id:"weight",level:3},{value:"Defined in",id:"defined-in-1",level:4}],l={toc:p};function f(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensusParticipant"),(0,i.kt)("h1",{id:"interface-icensusparticipant"},"Interface: ICensusParticipant"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusParticipant#key"},"key")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusParticipant#weight"},"weight"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"key"},"key"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"key"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L6"},"types/census/offchain.ts:6")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"weight"},"weight"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"weight"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"bigint")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L7"},"types/census/offchain.ts:7")))}f.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5326],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>d});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=r.createContext({}),p=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},l=function(e){var t=p(e.components);return r.createElement(c.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,c=e.parentName,l=o(e,["components","mdxType","originalType","parentName"]),f=p(n),d=i,k=f["".concat(c,".").concat(d)]||f[d]||u[d]||a;return n?r.createElement(k,s(s({ref:t},l),{},{components:n})):r.createElement(k,s({ref:t},l))}));function d(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,s=new Array(a);s[0]=f;var o={};for(var c in t)hasOwnProperty.call(t,c)&&(o[c]=t[c]);o.originalType=e,o.mdxType="string"==typeof e?e:i,s[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>p});var r=n(87462),i=(n(67294),n(3905));const a={},s=void 0,o={unversionedId:"sdk/reference/interfaces/ICensusParticipant",id:"sdk/reference/interfaces/ICensusParticipant",title:"ICensusParticipant",description:"@vocdoni/sdk / Exports / ICensusParticipant",source:"@site/docs/sdk/reference/interfaces/ICensusParticipant.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensusParticipant",permalink:"/sdk/reference/interfaces/ICensusParticipant",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensusImportResponse",permalink:"/sdk/reference/interfaces/ICensusImportResponse"},next:{title:"ICensusProofResponse",permalink:"/sdk/reference/interfaces/ICensusProofResponse"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"key",id:"key",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"weight",id:"weight",level:3},{value:"Defined in",id:"defined-in-1",level:4}],l={toc:p};function u(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensusParticipant"),(0,i.kt)("h1",{id:"interface-icensusparticipant"},"Interface: ICensusParticipant"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ICensusParticipant#key"},"key")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ICensusParticipant#weight"},"weight"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"key"},"key"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"key"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L6"},"types/census/offchain.ts:6")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"weight"},"weight"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"weight"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"bigint")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L7"},"types/census/offchain.ts:7")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/260b3d09.28f29275.js b/assets/js/260b3d09.28f29275.js new file mode 100644 index 000000000..94ab13cfe --- /dev/null +++ b/assets/js/260b3d09.28f29275.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5214],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>m});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),s=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},p=function(e){var t=s(e.components);return n.createElement(c.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,c=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),d=s(r),m=a,v=d["".concat(c,".").concat(m)]||d[m]||u[m]||i;return r?n.createElement(v,l(l({ref:t},p),{},{components:r})):n.createElement(v,l({ref:t},p))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=d;var o={};for(var c in t)hasOwnProperty.call(t,c)&&(o[c]=t[c]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var s=2;s{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>s});var n=r(87462),a=(r(67294),r(3905));const i={},l=void 0,o={unversionedId:"sdk/reference/classes/Service",id:"sdk/reference/classes/Service",title:"Service",description:"@vocdoni/sdk / Exports / Service",source:"@site/docs/sdk/reference/classes/Service.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Service",permalink:"/sdk/reference/classes/Service",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"PublishedElection",permalink:"/sdk/reference/classes/PublishedElection"},next:{title:"TokenCensus",permalink:"/sdk/reference/classes/TokenCensus"}},c={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"url",id:"url",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4}],p={toc:s};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / Service"),(0,a.kt)("h1",{id:"class-service"},"Class: Service"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Service"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"AccountService"},(0,a.kt)("inlineCode",{parentName:"a"},"AccountService"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"CensusService"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusService"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"ChainService"},(0,a.kt)("inlineCode",{parentName:"a"},"ChainService"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"CspService"},(0,a.kt)("inlineCode",{parentName:"a"},"CspService"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"ElectionService"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionService"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"FaucetService"},(0,a.kt)("inlineCode",{parentName:"a"},"FaucetService"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"FileService"},(0,a.kt)("inlineCode",{parentName:"a"},"FileService"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"AnonymousService"},(0,a.kt)("inlineCode",{parentName:"a"},"AnonymousService"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"VoteService"},(0,a.kt)("inlineCode",{parentName:"a"},"VoteService"))))),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"../interfaces/ServiceProperties"},(0,a.kt)("inlineCode",{parentName:"a"},"ServiceProperties")))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Service#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Service#url"},"url"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new Service"),"(): ",(0,a.kt)("a",{parentName:"p",href:"Service"},(0,a.kt)("inlineCode",{parentName:"a"},"Service"))),(0,a.kt)("p",null,"Cannot be constructed."),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"Service"},(0,a.kt)("inlineCode",{parentName:"a"},"Service"))),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/service.ts#L10"},"services/service.ts:10")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"url"},"url"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"url"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ServiceProperties"},"ServiceProperties"),".",(0,a.kt)("a",{parentName:"p",href:"../interfaces/ServiceProperties#url"},"url")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/service.ts#L6"},"services/service.ts:6")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/260b3d09.caa394d5.js b/assets/js/260b3d09.caa394d5.js deleted file mode 100644 index 58dcfc7ff..000000000 --- a/assets/js/260b3d09.caa394d5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5214],{3905:(e,r,t)=>{t.d(r,{Zo:()=>p,kt:()=>k});var n=t(67294);function a(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function i(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function s(e){for(var r=1;r=0||(a[t]=e[t]);return a}(e,r);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=n.createContext({}),o=function(e){var r=n.useContext(l),t=r;return e&&(t="function"==typeof e?e(r):s(s({},r),e)),t},p=function(e){var r=o(e.components);return n.createElement(l.Provider,{value:r},e.children)},u={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},d=n.forwardRef((function(e,r){var t=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),d=o(t),k=a,f=d["".concat(l,".").concat(k)]||d[k]||u[k]||i;return t?n.createElement(f,s(s({ref:r},p),{},{components:t})):n.createElement(f,s({ref:r},p))}));function k(e,r){var t=arguments,a=r&&r.mdxType;if("string"==typeof e||a){var i=t.length,s=new Array(i);s[0]=d;var c={};for(var l in r)hasOwnProperty.call(r,l)&&(c[l]=r[l]);c.originalType=e,c.mdxType="string"==typeof e?e:a,s[1]=c;for(var o=2;o{t.r(r),t.d(r,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>o});var n=t(87462),a=(t(67294),t(3905));const i={},s=void 0,c={unversionedId:"sdk/reference/classes/Service",id:"sdk/reference/classes/Service",title:"Service",description:"@vocdoni/sdk / Exports / Service",source:"@site/docs/sdk/reference/classes/Service.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Service",permalink:"/sdk/reference/classes/Service",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"PublishedElection",permalink:"/sdk/reference/classes/PublishedElection"},next:{title:"TokenCensus",permalink:"/sdk/reference/classes/TokenCensus"}},l={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"url",id:"url",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4}],p={toc:o};function u(e){let{components:r,...t}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,t,{components:r,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / Service"),(0,a.kt)("h1",{id:"class-service"},"Class: Service"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Service"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/AccountService"},(0,a.kt)("inlineCode",{parentName:"a"},"AccountService"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CensusService"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusService"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ChainService"},(0,a.kt)("inlineCode",{parentName:"a"},"ChainService"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CspService"},(0,a.kt)("inlineCode",{parentName:"a"},"CspService"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ElectionService"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionService"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/FaucetService"},(0,a.kt)("inlineCode",{parentName:"a"},"FaucetService"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/FileService"},(0,a.kt)("inlineCode",{parentName:"a"},"FileService"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/AnonymousService"},(0,a.kt)("inlineCode",{parentName:"a"},"AnonymousService"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VoteService"},(0,a.kt)("inlineCode",{parentName:"a"},"VoteService"))))),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ServiceProperties"},(0,a.kt)("inlineCode",{parentName:"a"},"ServiceProperties")))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Service#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Service#url"},"url"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new Service"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},(0,a.kt)("inlineCode",{parentName:"a"},"Service"))),(0,a.kt)("p",null,"Cannot be constructed."),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},(0,a.kt)("inlineCode",{parentName:"a"},"Service"))),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/service.ts#L10"},"services/service.ts:10")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"url"},"url"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"url"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ServiceProperties"},"ServiceProperties"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ServiceProperties#url"},"url")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/service.ts#L6"},"services/service.ts:6")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2730d8e4.998d8a0e.js b/assets/js/2730d8e4.998d8a0e.js deleted file mode 100644 index 592c530e1..000000000 --- a/assets/js/2730d8e4.998d8a0e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8597],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=r.createContext({}),l=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=l(e.components);return r.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,c=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),u=l(n),f=i,k=u["".concat(c,".").concat(f)]||u[f]||d[f]||a;return n?r.createElement(k,s(s({ref:t},p),{},{components:n})):r.createElement(k,s({ref:t},p))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,s=new Array(a);s[0]=u;var o={};for(var c in t)hasOwnProperty.call(t,c)&&(o[c]=t[c]);o.originalType=e,o.mdxType="string"==typeof e?e:i,s[1]=o;for(var l=2;l{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var r=n(87462),i=(n(67294),n(3905));const a={},s=void 0,o={unversionedId:"sdk/reference/interfaces/SetProcessTx",id:"sdk/reference/interfaces/SetProcessTx",title:"SetProcessTx",description:"@vocdoni/sdk / Exports / SetProcessTx",source:"@site/docs/sdk/reference/interfaces/SetProcessTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/SetProcessTx",permalink:"/sdk/reference/interfaces/SetProcessTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"SetAccountTx",permalink:"/sdk/reference/interfaces/SetAccountTx"},next:{title:"SetTransactionCostsTx",permalink:"/sdk/reference/interfaces/SetTransactionCostsTx"}},c={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"censusRoot",id:"censusroot",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"processId",id:"processid",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"proof",id:"proof",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"questionIndex",id:"questionindex",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"results",id:"results",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"txtype",id:"txtype",level:3},{value:"Defined in",id:"defined-in-8",level:4}],p={toc:l};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / SetProcessTx"),(0,i.kt)("h1",{id:"interface-setprocesstx"},"Interface: SetProcessTx"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetProcessTx#censusroot"},"censusRoot")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetProcessTx#censusuri"},"censusURI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetProcessTx#nonce"},"nonce")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetProcessTx#processid"},"processId")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetProcessTx#proof"},"proof")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetProcessTx#questionindex"},"questionIndex")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetProcessTx#results"},"results")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetProcessTx#status"},"status")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetProcessTx#txtype"},"txtype"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"censusroot"},"censusRoot"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"censusRoot"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L107"},"api/chain/transactions.ts:107")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"censusuri"},"censusURI"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"censusURI"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L108"},"api/chain/transactions.ts:108")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"nonce"},"nonce"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"nonce"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L103"},"api/chain/transactions.ts:103")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"processid"},"processId"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"processId"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L104"},"api/chain/transactions.ts:104")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"proof"},"proof"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"proof"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/Proof"},(0,i.kt)("inlineCode",{parentName:"a"},"Proof"))),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L109"},"api/chain/transactions.ts:109")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"questionindex"},"questionIndex"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"questionIndex"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L106"},"api/chain/transactions.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"results"},"results"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"results"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ProcessResult")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L110"},"api/chain/transactions.ts:110")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ProcessStatus")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L105"},"api/chain/transactions.ts:105")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"txtype"},"txtype"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"txtype"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/TxType"},(0,i.kt)("inlineCode",{parentName:"a"},"TxType"))),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L102"},"api/chain/transactions.ts:102")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2730d8e4.c26f58f7.js b/assets/js/2730d8e4.c26f58f7.js new file mode 100644 index 000000000..51925ba04 --- /dev/null +++ b/assets/js/2730d8e4.c26f58f7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8597],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,l=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),u=p(n),f=i,k=u["".concat(l,".").concat(f)]||u[f]||d[f]||a;return n?r.createElement(k,s(s({ref:t},c),{},{components:n})):r.createElement(k,s({ref:t},c))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,s=new Array(a);s[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:i,s[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>a,metadata:()=>o,toc:()=>p});var r=n(87462),i=(n(67294),n(3905));const a={},s=void 0,o={unversionedId:"sdk/reference/interfaces/SetProcessTx",id:"sdk/reference/interfaces/SetProcessTx",title:"SetProcessTx",description:"@vocdoni/sdk / Exports / SetProcessTx",source:"@site/docs/sdk/reference/interfaces/SetProcessTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/SetProcessTx",permalink:"/sdk/reference/interfaces/SetProcessTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"SetAccountTx",permalink:"/sdk/reference/interfaces/SetAccountTx"},next:{title:"SetTransactionCostsTx",permalink:"/sdk/reference/interfaces/SetTransactionCostsTx"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"censusRoot",id:"censusroot",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"processId",id:"processid",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"proof",id:"proof",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"questionIndex",id:"questionindex",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"results",id:"results",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"txtype",id:"txtype",level:3},{value:"Defined in",id:"defined-in-8",level:4}],c={toc:p};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / SetProcessTx"),(0,i.kt)("h1",{id:"interface-setprocesstx"},"Interface: SetProcessTx"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"SetProcessTx#censusroot"},"censusRoot")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"SetProcessTx#censusuri"},"censusURI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"SetProcessTx#nonce"},"nonce")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"SetProcessTx#processid"},"processId")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"SetProcessTx#proof"},"proof")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"SetProcessTx#questionindex"},"questionIndex")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"SetProcessTx#results"},"results")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"SetProcessTx#status"},"status")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"SetProcessTx#txtype"},"txtype"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"censusroot"},"censusRoot"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"censusRoot"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L107"},"api/chain/transactions.ts:107")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"censusuri"},"censusURI"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"censusURI"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L108"},"api/chain/transactions.ts:108")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"nonce"},"nonce"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"nonce"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L103"},"api/chain/transactions.ts:103")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"processid"},"processId"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"processId"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L104"},"api/chain/transactions.ts:104")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"proof"},"proof"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"proof"),": ",(0,i.kt)("a",{parentName:"p",href:"Proof"},(0,i.kt)("inlineCode",{parentName:"a"},"Proof"))),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L109"},"api/chain/transactions.ts:109")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"questionindex"},"questionIndex"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"questionIndex"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L106"},"api/chain/transactions.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"results"},"results"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"results"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ProcessResult")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L110"},"api/chain/transactions.ts:110")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ProcessStatus")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L105"},"api/chain/transactions.ts:105")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"txtype"},"txtype"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"txtype"),": ",(0,i.kt)("a",{parentName:"p",href:"../enums/TxType"},(0,i.kt)("inlineCode",{parentName:"a"},"TxType"))),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L102"},"api/chain/transactions.ts:102")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/29c8ca5d.30828cd8.js b/assets/js/29c8ca5d.30828cd8.js deleted file mode 100644 index f423ebc60..000000000 --- a/assets/js/29c8ca5d.30828cd8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4463],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=r.createContext({}),p=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=p(e.components);return r.createElement(d.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),m=p(n),u=a,f=m["".concat(d,".").concat(u)]||m[u]||k[u]||i;return n?r.createElement(f,l(l({ref:t},s),{},{components:n})):r.createElement(f,l({ref:t},s))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=m;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const i={},l=void 0,o={unversionedId:"sdk/reference/classes/VoteAPI",id:"sdk/reference/classes/VoteAPI",title:"VoteAPI",description:"@vocdoni/sdk / Exports / VoteAPI",source:"@site/docs/sdk/reference/classes/VoteAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/VoteAPI",permalink:"/sdk/reference/classes/VoteAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Vote",permalink:"/sdk/reference/classes/Vote"},next:{title:"VoteService",permalink:"/sdk/reference/classes/VoteService"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"info",id:"info",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"submit",id:"submit",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"verify",id:"verify",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4}],s={toc:p};function k(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / VoteAPI"),(0,a.kt)("h1",{id:"class-voteapi"},"Class: VoteAPI"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"API")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"VoteAPI"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VoteAPI#constructor"},"constructor"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VoteAPI#info"},"info")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VoteAPI#isapierror"},"isApiError")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VoteAPI#isundefinederror"},"isUndefinedError")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VoteAPI#submit"},"submit")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VoteAPI#verify"},"verify"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new VoteAPI"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VoteAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"VoteAPI"))),(0,a.kt)("p",null,"Cannot be constructed."),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VoteAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"VoteAPI"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"API.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/vote.ts#L78"},"api/vote.ts:78")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"info"},"info"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"info"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"voteId"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteInfoResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteInfoResponse")),">"),(0,a.kt)("p",null,"Vote info"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"url")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"voteId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The identifier of the vote")))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteInfoResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteInfoResponse")),">"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/vote.ts#L105"},"api/vote.ts:105")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isapierror"},"isApiError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"API.isApiError"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L21"},"api/api.ts:21")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"API.isUndefinedError"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L64"},"api/api.ts:64")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"submit"},"submit"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"submit"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteSubmitResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteSubmitResponse")),">"),(0,a.kt)("p",null,"Voting"),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"url")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"payload")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The base64 encoded vote transaction")))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteSubmitResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteSubmitResponse")),">"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/vote.ts#L90"},"api/vote.ts:90")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"verify"},"verify"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"verify"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"processId"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"voteId"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,a.kt)("p",null,"Verify vote. A vote exists in a process."),(0,a.kt)("h4",{id:"parameters-4"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"url")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"processId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The process identifier")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"voteId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The identifier of the vote")))),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,a.kt)("p",null,"Return true if response has status 200"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/vote.ts#L121"},"api/vote.ts:121")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/29c8ca5d.6f599611.js b/assets/js/29c8ca5d.6f599611.js new file mode 100644 index 000000000..1cbc9993a --- /dev/null +++ b/assets/js/29c8ca5d.6f599611.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4463],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),d=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),m=d(n),u=a,f=m["".concat(p,".").concat(u)]||m[u]||k[u]||i;return n?r.createElement(f,l(l({ref:t},s),{},{components:n})):r.createElement(f,l({ref:t},s))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=n(87462),a=(n(67294),n(3905));const i={},l=void 0,o={unversionedId:"sdk/reference/classes/VoteAPI",id:"sdk/reference/classes/VoteAPI",title:"VoteAPI",description:"@vocdoni/sdk / Exports / VoteAPI",source:"@site/docs/sdk/reference/classes/VoteAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/VoteAPI",permalink:"/sdk/reference/classes/VoteAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Vote",permalink:"/sdk/reference/classes/Vote"},next:{title:"VoteService",permalink:"/sdk/reference/classes/VoteService"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"info",id:"info",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"submit",id:"submit",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"verify",id:"verify",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4}],s={toc:d};function k(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / VoteAPI"),(0,a.kt)("h1",{id:"class-voteapi"},"Class: VoteAPI"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"API")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"VoteAPI"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"VoteAPI#constructor"},"constructor"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"VoteAPI#info"},"info")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"VoteAPI#isapierror"},"isApiError")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"VoteAPI#isundefinederror"},"isUndefinedError")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"VoteAPI#submit"},"submit")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"VoteAPI#verify"},"verify"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new VoteAPI"),"(): ",(0,a.kt)("a",{parentName:"p",href:"VoteAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"VoteAPI"))),(0,a.kt)("p",null,"Cannot be constructed."),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"VoteAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"VoteAPI"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"API.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/vote.ts#L78"},"api/vote.ts:78")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"info"},"info"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"info"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"voteId"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteInfoResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteInfoResponse")),">"),(0,a.kt)("p",null,"Vote info"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"url")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"voteId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The identifier of the vote")))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteInfoResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteInfoResponse")),">"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/vote.ts#L105"},"api/vote.ts:105")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isapierror"},"isApiError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"API.isApiError"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L21"},"api/api.ts:21")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"API.isUndefinedError"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L64"},"api/api.ts:64")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"submit"},"submit"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"submit"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteSubmitResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteSubmitResponse")),">"),(0,a.kt)("p",null,"Voting"),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"url")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"payload")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The base64 encoded vote transaction")))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteSubmitResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteSubmitResponse")),">"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/vote.ts#L90"},"api/vote.ts:90")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"verify"},"verify"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"verify"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"processId"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"voteId"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,a.kt)("p",null,"Verify vote. A vote exists in a process."),(0,a.kt)("h4",{id:"parameters-4"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"url")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"processId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The process identifier")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"voteId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The identifier of the vote")))),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,a.kt)("p",null,"Return true if response has status 200"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/vote.ts#L121"},"api/vote.ts:121")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2f59b2ef.ca3a3db0.js b/assets/js/2f59b2ef.69dc2eda.js similarity index 69% rename from assets/js/2f59b2ef.ca3a3db0.js rename to assets/js/2f59b2ef.69dc2eda.js index bb66be34c..ec70dc65f 100644 --- a/assets/js/2f59b2ef.ca3a3db0.js +++ b/assets/js/2f59b2ef.69dc2eda.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[274],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>f});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var o=n.createContext({}),c=function(e){var t=n.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},d=function(e){var t=c(e.components);return n.createElement(o.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=c(r),f=a,k=u["".concat(o,".").concat(f)]||u[f]||p[f]||i;return r?n.createElement(k,s(s({ref:t},d),{},{components:r})):n.createElement(k,s({ref:t},d))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,s=new Array(i);s[0]=u;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l.mdxType="string"==typeof e?e:a,s[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>s,default:()=>p,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var n=r(87462),a=(r(67294),r(3905));const i={},s=void 0,l={unversionedId:"sdk/reference/interfaces/ICensus3ValidatePredicateResponse",id:"sdk/reference/interfaces/ICensus3ValidatePredicateResponse",title:"ICensus3ValidatePredicateResponse",description:"@vocdoni/sdk / Exports / ICensus3ValidatePredicateResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3ValidatePredicateResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3ValidatePredicateChild",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateChild"},next:{title:"ICensus3ValidatePredicateToken",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateToken"}},o={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"result",id:"result",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4}],d={toc:c};function p(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3ValidatePredicateResponse"),(0,a.kt)("h1",{id:"interface-icensus3validatepredicateresponse"},"Interface: ICensus3ValidatePredicateResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse#result"},"result"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"result"},"result"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"result"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("p",null,"The parsed version of the predicate"),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"childs")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensus3ValidatePredicateChild"},(0,a.kt)("inlineCode",{parentName:"a"},"ICensus3ValidatePredicateChild"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"The childs of the predicate")))),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L242"},"api/census3/strategy.ts:242")))}p.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[274],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>f});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var o=n.createContext({}),c=function(e){var t=n.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},d=function(e){var t=c(e.components);return n.createElement(o.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=c(r),f=a,m=u["".concat(o,".").concat(f)]||u[f]||p[f]||i;return r?n.createElement(m,s(s({ref:t},d),{},{components:r})):n.createElement(m,s({ref:t},d))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,s=new Array(i);s[0]=u;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l.mdxType="string"==typeof e?e:a,s[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>s,default:()=>p,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var n=r(87462),a=(r(67294),r(3905));const i={},s=void 0,l={unversionedId:"sdk/reference/interfaces/ICensus3ValidatePredicateResponse",id:"sdk/reference/interfaces/ICensus3ValidatePredicateResponse",title:"ICensus3ValidatePredicateResponse",description:"@vocdoni/sdk / Exports / ICensus3ValidatePredicateResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3ValidatePredicateResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3ValidatePredicateChild",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateChild"},next:{title:"ICensus3ValidatePredicateToken",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateToken"}},o={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"result",id:"result",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4}],d={toc:c};function p(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3ValidatePredicateResponse"),(0,a.kt)("h1",{id:"interface-icensus3validatepredicateresponse"},"Interface: ICensus3ValidatePredicateResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3ValidatePredicateResponse#result"},"result"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"result"},"result"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"result"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("p",null,"The parsed version of the predicate"),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"childs")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"ICensus3ValidatePredicateChild"},(0,a.kt)("inlineCode",{parentName:"a"},"ICensus3ValidatePredicateChild"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"The childs of the predicate")))),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L242"},"api/census3/strategy.ts:242")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/377fc202.15359268.js b/assets/js/377fc202.15359268.js deleted file mode 100644 index 7bd8714e0..000000000 --- a/assets/js/377fc202.15359268.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3516],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var o=r.createContext({}),s=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=s(e.components);return r.createElement(o.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,d=c(e,["components","mdxType","originalType","parentName"]),k=s(n),m=a,u=k["".concat(o,".").concat(m)]||k[m]||p[m]||i;return n?r.createElement(u,l(l({ref:t},d),{},{components:n})):r.createElement(u,l({ref:t},d))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=k;var c={};for(var o in t)hasOwnProperty.call(t,o)&&(c[o]=t[o]);c.originalType=e,c.mdxType="string"==typeof e?e:a,l[1]=c;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>s});var r=n(87462),a=(n(67294),n(3905));const i={},l=void 0,c={unversionedId:"sdk/reference/classes/AccountService",id:"sdk/reference/classes/AccountService",title:"AccountService",description:"@vocdoni/sdk / Exports / AccountService",source:"@site/docs/sdk/reference/classes/AccountService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/AccountService",permalink:"/sdk/reference/classes/AccountService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"AccountAPI",permalink:"/sdk/reference/classes/AccountAPI"},next:{title:"AnonymousService",permalink:"/sdk/reference/classes/AnonymousService"}},o={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"chainService",id:"chainservice",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods-1",level:2},{value:"fetchAccountInfo",id:"fetchaccountinfo",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"setInfo",id:"setinfo",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"signTransaction",id:"signtransaction",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-5",level:4}],d={toc:s};function p(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / AccountService"),(0,a.kt)("h1",{id:"class-accountservice"},"Class: AccountService"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},(0,a.kt)("inlineCode",{parentName:"a"},"Service"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"AccountService"))))),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"AccountServiceProperties"))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountService#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountService#chainservice"},"chainService")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountService#url"},"url"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountService#fetchaccountinfo"},"fetchAccountInfo")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountService#setinfo"},"setInfo")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountService#signtransaction"},"signTransaction"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new AccountService"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/AccountService"},(0,a.kt)("inlineCode",{parentName:"a"},"AccountService"))),(0,a.kt)("p",null,"Instantiate the election service."),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"AccountServiceParameters"),">"),(0,a.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/AccountService"},(0,a.kt)("inlineCode",{parentName:"a"},"AccountService"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/account.ts#L45"},"services/account.ts:45")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"chainservice"},"chainService"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"chainService"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ChainService"},(0,a.kt)("inlineCode",{parentName:"a"},"ChainService"))),(0,a.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,a.kt)("p",null,"AccountServiceProperties.chainService"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/account.ts#L38"},"services/account.ts:38")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"url"},"url"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"url"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#url"},"url")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/service.ts#L6"},"services/service.ts:6")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"fetchaccountinfo"},"fetchAccountInfo"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"fetchAccountInfo"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"address"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,a.kt)("inlineCode",{parentName:"a"},"AccountData"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules#archivedaccountdata"},(0,a.kt)("inlineCode",{parentName:"a"},"ArchivedAccountData")),">"),(0,a.kt)("p",null,"Fetches account information."),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"address")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The account address to fetch the information")))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,a.kt)("inlineCode",{parentName:"a"},"AccountData"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules#archivedaccountdata"},(0,a.kt)("inlineCode",{parentName:"a"},"ArchivedAccountData")),">"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/account.ts#L56"},"services/account.ts:56")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"setinfo"},"setInfo"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"setInfo"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"tx"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"metadata"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,"Updates an account with information"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"tx")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The transaction for setting the account")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"metadata")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The account metadata")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,"The transaction hash"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/account.ts#L96"},"services/account.ts:96")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"signtransaction"},"signTransaction"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"signTransaction"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"tx"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"message"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"walletOrSigner"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"tx")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Uint8Array"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"walletOrSigner")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"Signer"))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/account.ts#L101"},"services/account.ts:101")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/377fc202.51f54810.js b/assets/js/377fc202.51f54810.js new file mode 100644 index 000000000..5007842eb --- /dev/null +++ b/assets/js/377fc202.51f54810.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3516],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var c=r.createContext({}),s=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=s(e.components);return r.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,c=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),m=s(n),u=a,k=m["".concat(c,".").concat(u)]||m[u]||d[u]||i;return n?r.createElement(k,l(l({ref:t},p),{},{components:n})):r.createElement(k,l({ref:t},p))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=m;var o={};for(var c in t)hasOwnProperty.call(t,c)&&(o[c]=t[c]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>s});var r=n(87462),a=(n(67294),n(3905));const i={},l=void 0,o={unversionedId:"sdk/reference/classes/AccountService",id:"sdk/reference/classes/AccountService",title:"AccountService",description:"@vocdoni/sdk / Exports / AccountService",source:"@site/docs/sdk/reference/classes/AccountService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/AccountService",permalink:"/sdk/reference/classes/AccountService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"AccountAPI",permalink:"/sdk/reference/classes/AccountAPI"},next:{title:"AnonymousService",permalink:"/sdk/reference/classes/AnonymousService"}},c={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"chainService",id:"chainservice",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods-1",level:2},{value:"fetchAccountInfo",id:"fetchaccountinfo",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"setInfo",id:"setinfo",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"signTransaction",id:"signtransaction",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-5",level:4}],p={toc:s};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / AccountService"),(0,a.kt)("h1",{id:"class-accountservice"},"Class: AccountService"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"Service"},(0,a.kt)("inlineCode",{parentName:"a"},"Service"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"AccountService"))))),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"AccountServiceProperties"))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"AccountService#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"AccountService#chainservice"},"chainService")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"AccountService#url"},"url"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"AccountService#fetchaccountinfo"},"fetchAccountInfo")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"AccountService#setinfo"},"setInfo")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"AccountService#signtransaction"},"signTransaction"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new AccountService"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"AccountService"},(0,a.kt)("inlineCode",{parentName:"a"},"AccountService"))),(0,a.kt)("p",null,"Instantiate the election service."),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"AccountServiceParameters"),">"),(0,a.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"AccountService"},(0,a.kt)("inlineCode",{parentName:"a"},"AccountService"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,a.kt)("a",{parentName:"p",href:"Service#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/account.ts#L45"},"services/account.ts:45")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"chainservice"},"chainService"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"chainService"),": ",(0,a.kt)("a",{parentName:"p",href:"ChainService"},(0,a.kt)("inlineCode",{parentName:"a"},"ChainService"))),(0,a.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,a.kt)("p",null,"AccountServiceProperties.chainService"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/account.ts#L38"},"services/account.ts:38")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"url"},"url"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"url"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,a.kt)("a",{parentName:"p",href:"Service#url"},"url")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/service.ts#L6"},"services/service.ts:6")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"fetchaccountinfo"},"fetchAccountInfo"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"fetchAccountInfo"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"address"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,a.kt)("inlineCode",{parentName:"a"},"AccountData"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"../modules#archivedaccountdata"},(0,a.kt)("inlineCode",{parentName:"a"},"ArchivedAccountData")),">"),(0,a.kt)("p",null,"Fetches account information."),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"address")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The account address to fetch the information")))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,a.kt)("inlineCode",{parentName:"a"},"AccountData"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"../modules#archivedaccountdata"},(0,a.kt)("inlineCode",{parentName:"a"},"ArchivedAccountData")),">"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/account.ts#L56"},"services/account.ts:56")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"setinfo"},"setInfo"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"setInfo"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"tx"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"metadata"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,"Updates an account with information"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"tx")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The transaction for setting the account")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"metadata")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The account metadata")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,"The transaction hash"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/account.ts#L96"},"services/account.ts:96")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"signtransaction"},"signTransaction"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"signTransaction"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"tx"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"message"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"walletOrSigner"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"tx")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Uint8Array"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"walletOrSigner")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"Signer"))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/account.ts#L101"},"services/account.ts:101")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/39a96d3a.a739939a.js b/assets/js/39a96d3a.a739939a.js deleted file mode 100644 index e9d374637..000000000 --- a/assets/js/39a96d3a.a739939a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[306],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),p=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=p(e.components);return a.createElement(d.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),k=p(n),m=r,f=k["".concat(d,".").concat(m)]||k[m]||s[m]||i;return n?a.createElement(f,l(l({ref:t},c),{},{components:n})):a.createElement(f,l({ref:t},c))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=k;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:r,l[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,o={unversionedId:"sdk/reference/interfaces/ElectionMetadata",id:"sdk/reference/interfaces/ElectionMetadata",title:"ElectionMetadata",description:"@vocdoni/sdk / Exports / ElectionMetadata",source:"@site/docs/sdk/reference/interfaces/ElectionMetadata.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ElectionMetadata",permalink:"/sdk/reference/interfaces/ElectionMetadata",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CollectFaucetTx",permalink:"/sdk/reference/interfaces/CollectFaucetTx"},next:{title:"FetchElectionsParameters",permalink:"/sdk/reference/interfaces/FetchElectionsParameters"}},d={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"media",id:"media",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"meta",id:"meta",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"questions",id:"questions",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"version",id:"version",level:3},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:p};function s(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ElectionMetadata"),(0,r.kt)("h1",{id:"interface-electionmetadata"},"Interface: ElectionMetadata"),(0,r.kt)("p",null,"JSON metadata. Intended to be stored on IPFS or similar.\nMore info: ",(0,r.kt)("a",{parentName:"p",href:"https://vocdoni.io/docs/#/architecture/components/process?id=process-metadata-json"},"https://vocdoni.io/docs/#/architecture/components/process?id=process-metadata-json")),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ElectionMetadata#description"},"description")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ElectionMetadata#media"},"media")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ElectionMetadata#meta"},"meta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ElectionMetadata#questions"},"questions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ElectionMetadata#title"},"title")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ElectionMetadata#type"},"type")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ElectionMetadata#version"},"version"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L127"},"types/metadata/election.ts:127")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"media"},"media"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"media"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"header?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"streamUri?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L128"},"types/metadata/election.ts:128")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Arbitrary key/value data that specific applications can use for their own needs"),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[key: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L133"},"types/metadata/election.ts:133")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"questions"},"questions"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"questions"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,r.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L136"},"types/metadata/election.ts:136")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"title"},"title"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"title"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L126"},"types/metadata/election.ts:126")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"type"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#electionresultstype"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionResultsType"))),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L137"},"types/metadata/election.ts:137")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"version"},"version"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"version"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ProtocolVersion")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L125"},"types/metadata/election.ts:125")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/39a96d3a.cc88d067.js b/assets/js/39a96d3a.cc88d067.js new file mode 100644 index 000000000..39b1143e9 --- /dev/null +++ b/assets/js/39a96d3a.cc88d067.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[306],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var a=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var d=a.createContext({}),p=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=p(e.components);return a.createElement(d.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),m=p(n),u=i,k=m["".concat(d,".").concat(u)]||m[u]||c[u]||r;return n?a.createElement(k,l(l({ref:t},s),{},{components:n})):a.createElement(k,l({ref:t},s))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=m;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>r,metadata:()=>o,toc:()=>p});var a=n(87462),i=(n(67294),n(3905));const r={},l=void 0,o={unversionedId:"sdk/reference/interfaces/ElectionMetadata",id:"sdk/reference/interfaces/ElectionMetadata",title:"ElectionMetadata",description:"@vocdoni/sdk / Exports / ElectionMetadata",source:"@site/docs/sdk/reference/interfaces/ElectionMetadata.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ElectionMetadata",permalink:"/sdk/reference/interfaces/ElectionMetadata",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CollectFaucetTx",permalink:"/sdk/reference/interfaces/CollectFaucetTx"},next:{title:"FetchElectionsParameters",permalink:"/sdk/reference/interfaces/FetchElectionsParameters"}},d={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"media",id:"media",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"meta",id:"meta",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"questions",id:"questions",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"version",id:"version",level:3},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:p};function c(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ElectionMetadata"),(0,i.kt)("h1",{id:"interface-electionmetadata"},"Interface: ElectionMetadata"),(0,i.kt)("p",null,"JSON metadata. Intended to be stored on IPFS or similar.\nMore info: ",(0,i.kt)("a",{parentName:"p",href:"https://vocdoni.io/docs/#/architecture/components/process?id=process-metadata-json"},"https://vocdoni.io/docs/#/architecture/components/process?id=process-metadata-json")),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionMetadata#description"},"description")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionMetadata#media"},"media")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionMetadata#meta"},"meta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionMetadata#questions"},"questions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionMetadata#title"},"title")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionMetadata#type"},"type")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionMetadata#version"},"version"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L127"},"types/metadata/election.ts:127")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"media"},"media"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"media"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"header?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"streamUri?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L128"},"types/metadata/election.ts:128")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("p",null,"Arbitrary key/value data that specific applications can use for their own needs"),(0,i.kt)("h4",{id:"index-signature"},"Index signature"),(0,i.kt)("p",null,"\u25aa ","[key: ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L133"},"types/metadata/election.ts:133")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"questions"},"questions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"questions"),": ",(0,i.kt)("a",{parentName:"p",href:"IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L136"},"types/metadata/election.ts:136")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L126"},"types/metadata/election.ts:126")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"../modules#electionresultstype"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionResultsType"))),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L137"},"types/metadata/election.ts:137")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"version"},"version"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"version"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ProtocolVersion")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L125"},"types/metadata/election.ts:125")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/3aefc2b6.56f429b6.js b/assets/js/3aefc2b6.56f429b6.js new file mode 100644 index 000000000..01771cd8d --- /dev/null +++ b/assets/js/3aefc2b6.56f429b6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3868],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function s(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=r.createContext({}),p=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=p(e.components);return r.createElement(d.Provider,{value:t},e.children)},o={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,s=e.originalType,d=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),k=p(n),m=a,c=k["".concat(d,".").concat(m)]||k[m]||o[m]||s;return n?r.createElement(c,i(i({ref:t},u),{},{components:n})):r.createElement(c,i({ref:t},u))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var s=n.length,i=new Array(s);i[0]=k;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l.mdxType="string"==typeof e?e:a,i[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>o,frontMatter:()=>s,metadata:()=>l,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const s={},i=void 0,l={unversionedId:"sdk/reference/classes/TokenCensus",id:"sdk/reference/classes/TokenCensus",title:"TokenCensus",description:"@vocdoni/sdk / Exports / TokenCensus",source:"@site/docs/sdk/reference/classes/TokenCensus.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/TokenCensus",permalink:"/sdk/reference/classes/TokenCensus",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Service",permalink:"/sdk/reference/classes/Service"},next:{title:"UnpublishedElection",permalink:"/sdk/reference/classes/UnpublishedElection"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_censusId",id:"_censusid",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_censusURI",id:"_censusuri",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_token",id:"_token",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"_type",id:"_type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"censusId",id:"censusid",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isPublished",id:"ispublished",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"token",id:"token",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"type",id:"type",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"weight",id:"weight",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Methods",id:"methods-1",level:2},{value:"censusTypeFromCensusOrigin",id:"censustypefromcensusorigin",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-18",level:4}],u={toc:p};function o(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / TokenCensus"),(0,a.kt)("h1",{id:"class-tokencensus"},"Class: TokenCensus"),(0,a.kt)("p",null,"Represents a census3 census"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"PublishedCensus"},(0,a.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"TokenCensus"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"TokenCensus#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#_censusid"},"_","censusId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#_censusuri"},"_","censusURI")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#_token"},"_","token")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#_type"},"_","type"))),(0,a.kt)("h3",{id:"accessors"},"Accessors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"TokenCensus#censusid"},"censusId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"TokenCensus#censusuri"},"censusURI")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"TokenCensus#ispublished"},"isPublished")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"TokenCensus#size"},"size")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"TokenCensus#token"},"token")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"TokenCensus#type"},"type")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"TokenCensus#weight"},"weight"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"TokenCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new TokenCensus"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"censusURI"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"anonymous"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"token"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"size?"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"weight?"),"): ",(0,a.kt)("a",{parentName:"p",href:"TokenCensus"},(0,a.kt)("inlineCode",{parentName:"a"},"TokenCensus"))),(0,a.kt)("p",null,"Constructs a census3 census"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"censusId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The id of the census")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"censusURI")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The URI of the census")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean")),(0,a.kt)("td",{parentName:"tr",align:"left"},"If the census is anonymous")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"token")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../modules#token"},(0,a.kt)("inlineCode",{parentName:"a"},"Token"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"The token of the census")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"size?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The size of the census")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"weight?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"bigint")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The weight of the census")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"TokenCensus"},(0,a.kt)("inlineCode",{parentName:"a"},"TokenCensus"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},"PublishedCensus"),".",(0,a.kt)("a",{parentName:"p",href:"PublishedCensus#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census3.ts#L21"},"types/census/census3.ts:21")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"_censusid"},"_","censusId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","censusId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"PublishedCensus"},"PublishedCensus"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus#_censusid"},"_censusId")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L12"},"types/census/census.ts:12")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_censusuri"},"_","censusURI"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","censusURI"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"PublishedCensus"},"PublishedCensus"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus#_censusuri"},"_censusURI")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L13"},"types/census/census.ts:13")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_token"},"_","token"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","token"),": ",(0,a.kt)("a",{parentName:"p",href:"../modules#token"},(0,a.kt)("inlineCode",{parentName:"a"},"Token"))),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census3.ts#L9"},"types/census/census3.ts:9")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_type"},"_","type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","type"),": ",(0,a.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"PublishedCensus"},"PublishedCensus"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus#_type"},"_type")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L14"},"types/census/census.ts:14")),(0,a.kt)("h2",{id:"accessors-1"},"Accessors"),(0,a.kt)("h3",{id:"censusid"},"censusId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"censusId"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.censusId"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L35"},"types/census/census.ts:35")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"censusId"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.censusId"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L39"},"types/census/census.ts:39")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"censusuri"},"censusURI"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"censusURI"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.censusURI"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L43"},"types/census/census.ts:43")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"censusURI"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.censusURI"),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L47"},"types/census/census.ts:47")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ispublished"},"isPublished"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"isPublished"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.isPublished"),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L75"},"types/census/census.ts:75")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"size"},"size"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"size"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.size"),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L59"},"types/census/census.ts:59")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"size"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.size"),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L63"},"types/census/census.ts:63")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"token"},"token"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"token"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../modules#token"},(0,a.kt)("inlineCode",{parentName:"a"},"Token"))),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../modules#token"},(0,a.kt)("inlineCode",{parentName:"a"},"Token"))),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census3.ts#L33"},"types/census/census3.ts:33")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"token"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-4"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../modules#token"},(0,a.kt)("inlineCode",{parentName:"a"},"Token")))))),(0,a.kt)("h4",{id:"returns-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census3.ts#L37"},"types/census/census3.ts:37")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"type"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,a.kt)("h4",{id:"returns-10"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,a.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.type"),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L51"},"types/census/census.ts:51")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"type"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-5"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType")))))),(0,a.kt)("h4",{id:"returns-11"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.type"),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L55"},"types/census/census.ts:55")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"weight"},"weight"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"weight"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint")),(0,a.kt)("h4",{id:"returns-12"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"bigint")),(0,a.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.weight"),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L67"},"types/census/census.ts:67")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"weight"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-6"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,a.kt)("h4",{id:"returns-13"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.weight"),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L71"},"types/census/census.ts:71")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"censustypefromcensusorigin"},"censusTypeFromCensusOrigin"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"censusTypeFromCensusOrigin"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"censusOrigin"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,a.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,a.kt)("h4",{id:"parameters-7"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"censusOrigin")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"false"))))),(0,a.kt)("h4",{id:"returns-14"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,a.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},"PublishedCensus"),".",(0,a.kt)("a",{parentName:"p",href:"PublishedCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin")),(0,a.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L81"},"types/census/census.ts:81")))}o.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/3aefc2b6.7b08e0e6.js b/assets/js/3aefc2b6.7b08e0e6.js deleted file mode 100644 index e5b8abf51..000000000 --- a/assets/js/3aefc2b6.7b08e0e6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3868],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>c});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function s(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=r.createContext({}),p=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=p(e.components);return r.createElement(d.Provider,{value:t},e.children)},o={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,s=e.originalType,d=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),k=p(n),c=a,m=k["".concat(d,".").concat(c)]||k[c]||o[c]||s;return n?r.createElement(m,i(i({ref:t},u),{},{components:n})):r.createElement(m,i({ref:t},u))}));function c(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var s=n.length,i=new Array(s);i[0]=k;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l.mdxType="string"==typeof e?e:a,i[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>o,frontMatter:()=>s,metadata:()=>l,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const s={},i=void 0,l={unversionedId:"sdk/reference/classes/TokenCensus",id:"sdk/reference/classes/TokenCensus",title:"TokenCensus",description:"@vocdoni/sdk / Exports / TokenCensus",source:"@site/docs/sdk/reference/classes/TokenCensus.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/TokenCensus",permalink:"/sdk/reference/classes/TokenCensus",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Service",permalink:"/sdk/reference/classes/Service"},next:{title:"UnpublishedElection",permalink:"/sdk/reference/classes/UnpublishedElection"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_censusId",id:"_censusid",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_censusURI",id:"_censusuri",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_token",id:"_token",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"_type",id:"_type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"censusId",id:"censusid",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isPublished",id:"ispublished",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"token",id:"token",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"type",id:"type",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"weight",id:"weight",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Methods",id:"methods-1",level:2},{value:"censusTypeFromCensusOrigin",id:"censustypefromcensusorigin",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-18",level:4}],u={toc:p};function o(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / TokenCensus"),(0,a.kt)("h1",{id:"class-tokencensus"},"Class: TokenCensus"),(0,a.kt)("p",null,"Represents a census3 census"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},(0,a.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"TokenCensus"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#_censusid"},"_","censusId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#_censusuri"},"_","censusURI")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#_token"},"_","token")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#_type"},"_","type"))),(0,a.kt)("h3",{id:"accessors"},"Accessors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#censusid"},"censusId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#censusuri"},"censusURI")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#ispublished"},"isPublished")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#size"},"size")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#token"},"token")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#type"},"type")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#weight"},"weight"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new TokenCensus"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"censusURI"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"anonymous"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"token"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"size?"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"weight?"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/TokenCensus"},(0,a.kt)("inlineCode",{parentName:"a"},"TokenCensus"))),(0,a.kt)("p",null,"Constructs a census3 census"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"censusId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The id of the census")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"censusURI")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The URI of the census")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean")),(0,a.kt)("td",{parentName:"tr",align:"left"},"If the census is anonymous")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"token")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/modules#token"},(0,a.kt)("inlineCode",{parentName:"a"},"Token"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"The token of the census")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"size?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The size of the census")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"weight?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"bigint")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The weight of the census")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/TokenCensus"},(0,a.kt)("inlineCode",{parentName:"a"},"TokenCensus"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},"PublishedCensus"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census3.ts#L21"},"types/census/census3.ts:21")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"_censusid"},"_","censusId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","censusId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},"PublishedCensus"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus#_censusid"},"_censusId")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L12"},"types/census/census.ts:12")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_censusuri"},"_","censusURI"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","censusURI"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},"PublishedCensus"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus#_censusuri"},"_censusURI")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L13"},"types/census/census.ts:13")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_token"},"_","token"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","token"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules#token"},(0,a.kt)("inlineCode",{parentName:"a"},"Token"))),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census3.ts#L9"},"types/census/census3.ts:9")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_type"},"_","type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","type"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},"PublishedCensus"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus#_type"},"_type")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L14"},"types/census/census.ts:14")),(0,a.kt)("h2",{id:"accessors-1"},"Accessors"),(0,a.kt)("h3",{id:"censusid"},"censusId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"censusId"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.censusId"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L35"},"types/census/census.ts:35")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"censusId"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.censusId"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L39"},"types/census/census.ts:39")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"censusuri"},"censusURI"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"censusURI"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.censusURI"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L43"},"types/census/census.ts:43")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"censusURI"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.censusURI"),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L47"},"types/census/census.ts:47")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ispublished"},"isPublished"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"isPublished"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.isPublished"),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L75"},"types/census/census.ts:75")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"size"},"size"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"size"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.size"),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L59"},"types/census/census.ts:59")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"size"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.size"),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L63"},"types/census/census.ts:63")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"token"},"token"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"token"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules#token"},(0,a.kt)("inlineCode",{parentName:"a"},"Token"))),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules#token"},(0,a.kt)("inlineCode",{parentName:"a"},"Token"))),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census3.ts#L33"},"types/census/census3.ts:33")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"token"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-4"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/modules#token"},(0,a.kt)("inlineCode",{parentName:"a"},"Token")))))),(0,a.kt)("h4",{id:"returns-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census3.ts#L37"},"types/census/census3.ts:37")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"type"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,a.kt)("h4",{id:"returns-10"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,a.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.type"),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L51"},"types/census/census.ts:51")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"type"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-5"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType")))))),(0,a.kt)("h4",{id:"returns-11"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.type"),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L55"},"types/census/census.ts:55")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"weight"},"weight"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"weight"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint")),(0,a.kt)("h4",{id:"returns-12"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"bigint")),(0,a.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.weight"),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L67"},"types/census/census.ts:67")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"weight"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-6"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,a.kt)("h4",{id:"returns-13"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,a.kt)("p",null,"PublishedCensus.weight"),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L71"},"types/census/census.ts:71")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"censustypefromcensusorigin"},"censusTypeFromCensusOrigin"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"censusTypeFromCensusOrigin"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"censusOrigin"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,a.kt)("h4",{id:"parameters-7"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"censusOrigin")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"false"))))),(0,a.kt)("h4",{id:"returns-14"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,a.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},"PublishedCensus"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin")),(0,a.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L81"},"types/census/census.ts:81")))}o.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/3c152c78.db6d56b7.js b/assets/js/3c152c78.0212d1ef.js similarity index 79% rename from assets/js/3c152c78.db6d56b7.js rename to assets/js/3c152c78.0212d1ef.js index 929f4b8de..67658efe5 100644 --- a/assets/js/3c152c78.db6d56b7.js +++ b/assets/js/3c152c78.0212d1ef.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3625],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>f});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),c=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(r),f=a,k=u["".concat(l,".").concat(f)]||u[f]||d[f]||i;return r?n.createElement(k,o(o({ref:t},p),{},{components:r})):n.createElement(k,o({ref:t},p))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var n=r(87462),a=(r(67294),r(3905));const i={},o=void 0,s={unversionedId:"sdk/reference/interfaces/ICensus3ValidatePredicateToken",id:"sdk/reference/interfaces/ICensus3ValidatePredicateToken",title:"ICensus3ValidatePredicateToken",description:"@vocdoni/sdk / Exports / ICensus3ValidatePredicateToken",source:"@site/docs/sdk/reference/interfaces/ICensus3ValidatePredicateToken.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3ValidatePredicateToken",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateToken",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3ValidatePredicateResponse",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse"},next:{title:"ICensusExportResponse",permalink:"/sdk/reference/interfaces/ICensusExportResponse"}},l={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"literal",id:"literal",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:c};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3ValidatePredicateToken"),(0,a.kt)("h1",{id:"interface-icensus3validatepredicatetoken"},"Interface: ICensus3ValidatePredicateToken"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3ValidatePredicateToken#literal"},"literal"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"literal"},"literal"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"literal"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The literal of the predicate"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L204"},"api/census3/strategy.ts:204")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3625],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>f});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),c=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(r),f=a,k=u["".concat(l,".").concat(f)]||u[f]||d[f]||i;return r?n.createElement(k,o(o({ref:t},p),{},{components:r})):n.createElement(k,o({ref:t},p))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var n=r(87462),a=(r(67294),r(3905));const i={},o=void 0,s={unversionedId:"sdk/reference/interfaces/ICensus3ValidatePredicateToken",id:"sdk/reference/interfaces/ICensus3ValidatePredicateToken",title:"ICensus3ValidatePredicateToken",description:"@vocdoni/sdk / Exports / ICensus3ValidatePredicateToken",source:"@site/docs/sdk/reference/interfaces/ICensus3ValidatePredicateToken.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3ValidatePredicateToken",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateToken",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3ValidatePredicateResponse",permalink:"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse"},next:{title:"ICensusExportResponse",permalink:"/sdk/reference/interfaces/ICensusExportResponse"}},l={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"literal",id:"literal",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:c};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3ValidatePredicateToken"),(0,a.kt)("h1",{id:"interface-icensus3validatepredicatetoken"},"Interface: ICensus3ValidatePredicateToken"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3ValidatePredicateToken#literal"},"literal"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"literal"},"literal"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"literal"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The literal of the predicate"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L204"},"api/census3/strategy.ts:204")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/3fa72254.34b95aee.js b/assets/js/3fa72254.3000b4a0.js similarity index 60% rename from assets/js/3fa72254.34b95aee.js rename to assets/js/3fa72254.3000b4a0.js index 410ec4e21..8d18326ea 100644 --- a/assets/js/3fa72254.34b95aee.js +++ b/assets/js/3fa72254.3000b4a0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9217],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>u});var r=t(67294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var c=r.createContext({}),l=function(e){var n=r.useContext(c),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},p=function(e){var n=l(e.components);return r.createElement(c.Provider,{value:n},e.children)},f={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,a=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=l(t),u=i,m=d["".concat(c,".").concat(u)]||d[u]||f[u]||a;return t?r.createElement(m,o(o({ref:n},p),{},{components:t})):r.createElement(m,o({ref:n},p))}));function u(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var a=t.length,o=new Array(a);o[0]=d;var s={};for(var c in n)hasOwnProperty.call(n,c)&&(s[c]=n[c]);s.originalType=e,s.mdxType="string"==typeof e?e:i,o[1]=s;for(var l=2;l{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>f,frontMatter:()=>a,metadata:()=>s,toc:()=>l});var r=t(87462),i=(t(67294),t(3905));const a={},o=void 0,s={unversionedId:"sdk/reference/interfaces/IChainOrganizationResponse",id:"sdk/reference/interfaces/IChainOrganizationResponse",title:"IChainOrganizationResponse",description:"@vocdoni/sdk / Exports / IChainOrganizationResponse",source:"@site/docs/sdk/reference/interfaces/IChainOrganizationResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainOrganizationResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainOrganizationListResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationListResponse"},next:{title:"IChainSubmitTxResponse",permalink:"/sdk/reference/interfaces/IChainSubmitTxResponse"}},c={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"electionCount",id:"electioncount",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"organizationID",id:"organizationid",level:3},{value:"Defined in",id:"defined-in-1",level:4}],p={toc:l};function f(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IChainOrganizationResponse"),(0,i.kt)("h1",{id:"interface-ichainorganizationresponse"},"Interface: IChainOrganizationResponse"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainOrganizationResponse#electioncount"},"electionCount")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainOrganizationResponse#organizationid"},"organizationID"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"electioncount"},"electionCount"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"electionCount"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The number of elections"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L253"},"api/chain.ts:253")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"organizationid"},"organizationID"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"organizationID"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The identifier of the organization"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L248"},"api/chain.ts:248")))}f.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9217],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>f});var r=t(67294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var l=r.createContext({}),p=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},c=function(e){var n=p(e.components);return r.createElement(l.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,a=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=p(t),f=i,m=d["".concat(l,".").concat(f)]||d[f]||u[f]||a;return t?r.createElement(m,o(o({ref:n},c),{},{components:t})):r.createElement(m,o({ref:n},c))}));function f(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var a=t.length,o=new Array(a);o[0]=d;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s.mdxType="string"==typeof e?e:i,o[1]=s;for(var p=2;p{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>p});var r=t(87462),i=(t(67294),t(3905));const a={},o=void 0,s={unversionedId:"sdk/reference/interfaces/IChainOrganizationResponse",id:"sdk/reference/interfaces/IChainOrganizationResponse",title:"IChainOrganizationResponse",description:"@vocdoni/sdk / Exports / IChainOrganizationResponse",source:"@site/docs/sdk/reference/interfaces/IChainOrganizationResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainOrganizationResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainOrganizationListResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationListResponse"},next:{title:"IChainSubmitTxResponse",permalink:"/sdk/reference/interfaces/IChainSubmitTxResponse"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"electionCount",id:"electioncount",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"organizationID",id:"organizationid",level:3},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:p};function u(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IChainOrganizationResponse"),(0,i.kt)("h1",{id:"interface-ichainorganizationresponse"},"Interface: IChainOrganizationResponse"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IChainOrganizationResponse#electioncount"},"electionCount")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IChainOrganizationResponse#organizationid"},"organizationID"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"electioncount"},"electionCount"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"electionCount"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The number of elections"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L253"},"api/chain.ts:253")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"organizationid"},"organizationID"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"organizationID"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The identifier of the organization"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L248"},"api/chain.ts:248")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/404eb028.16e71fec.js b/assets/js/404eb028.16e71fec.js new file mode 100644 index 000000000..4342c2f58 --- /dev/null +++ b/assets/js/404eb028.16e71fec.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2827],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var o=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function r(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=o.createContext({}),c=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},p=function(e){var t=c(e.components);return o.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},d=o.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=c(n),h=a,m=d["".concat(l,".").concat(h)]||d[h]||u[h]||i;return n?o.createElement(m,r(r({ref:t},p),{},{components:n})):o.createElement(m,r({ref:t},p))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,r=new Array(i);r[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,r[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var o=n(87462),a=(n(67294),n(3905));const i={},r="Quadratic voting",s={unversionedId:"sdk/integration-details/voting-types/quadratic",id:"sdk/integration-details/voting-types/quadratic",title:"Quadratic voting",description:"Quadratic voting is a voting mechanism that allows individuals to express their preferences on different issues with",source:"@site/docs/sdk/integration-details/voting-types/quadratic.md",sourceDirName:"sdk/integration-details/voting-types",slug:"/sdk/integration-details/voting-types/quadratic",permalink:"/sdk/integration-details/voting-types/quadratic",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Weighted voting",permalink:"/sdk/integration-details/voting-types/weighted"},next:{title:"Account",permalink:"/sdk/reference/classes/Account"}},l={},c=[{value:"Setting up the election",id:"setting-up-the-election",level:2},{value:"Voter credits",id:"voter-credits",level:3},{value:"Casting a vote",id:"casting-a-vote",level:2},{value:"Results interpretation",id:"results-interpretation",level:2}],p={toc:c};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,o.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"quadratic-voting"},"Quadratic voting"),(0,a.kt)("p",null,"Quadratic voting is a voting mechanism that allows individuals to express their preferences on different issues with\nmore granularity and intensity. In quadratic voting, voters are allocated a fixed number of voting credits, and they can\ndistribute those credits across various options or issues in a quadratic manner. This means that voters can assign more\ncredits to options they care strongly about while still being able to express preferences on multiple issues."),(0,a.kt)("p",null,"The quadratic aspect of the system ensures that the cost of allocating additional credits increases quadratically, which\nhelps prevent a small number of voters from dominating the decision-making process. Quadratic voting aims to promote a\nmore accurate representation of individual preferences and allocate resources based on the collective intensity of\npreferences rather than just a simple majority rule."),(0,a.kt)("p",null,"See:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/examples/typescript/src/quadratic.ts"},"Complete example")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/protocol/ballot-protocol#quadratic-voting"},"Ballot protocol implementation"))),(0,a.kt)("h2",{id:"setting-up-the-election"},"Setting up the election"),(0,a.kt)("p",null,"Here we are going to describe how to configure an election to set up a quadratic voting. When the election object is\ncreated,"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"const election_opts: IVoteType = {\n maxValue: 0, // Must be 0 for quadratic elections\n maxCount: CHOICES_LENGTH, // Number of choices for the question\n uniqueChoices: false,\n costFromWeight: true, // This will set that the weight on a weighted census is actually the credits available\n costExponent: 2, // In the context of quadratic voting, this value is usually set to 2\n};\n")),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"The actual Vocdoni implementation only allow quadratic elections with only one question. For that, the ",(0,a.kt)("inlineCode",{parentName:"li"},"maxCount"),"\nrefers to the choices length for this unique question. "),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"costExponent")," define the exponent for quadratic voting calculation. In the context of quadratic voting, this value is\nusually set to 2. This exponent determines the cost of a vote. For example, if a voter assigns 2 credits to an option,\nthe cost of that vote would be 2^2 = 4. Look at SDK docs for more info.")),(0,a.kt)("h3",{id:"voter-credits"},"Voter credits"),(0,a.kt)("p",null,"To determine the number of credits each voter can use, the configuration must be defined in one of two ways:"),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Adjusting the ",(0,a.kt)("inlineCode",{parentName:"p"},"maxTotalCost"),", on the election options, and using a ",(0,a.kt)("inlineCode",{parentName:"p"},"PlainCensus")," allows for an equal number of credits to be\nallocated to each voter.")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Alternatively, by enabling ",(0,a.kt)("inlineCode",{parentName:"p"},"costFromWeight")," and using a ",(0,a.kt)("inlineCode",{parentName:"p"},"WeightedCensus"),", the number of credits available will\ncorrespond to the voter's weight."))),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"}," const census = new WeightedCensus();\n census.add(\n participants.map((participant, index) => ({\n key: participant.address,\n weight: BigInt(20), // Give 20 credits to every voter\n }))\n );\n")),(0,a.kt)("p",null,"Using this method will enable the possibility to give different number of credits for every voter. "),(0,a.kt)("h2",{id:"casting-a-vote"},"Casting a vote"),(0,a.kt)("p",null,"As of now, the ",(0,a.kt)("a",{parentName:"p",href:"/protocol/ballot-protocol#vocdoni-results-interpretation"},"protocol"),"\nfor quadratic elections only supports single question elections with discrete values. "),(0,a.kt)("p",null,"Therefore, to cast a vote, you can use the following method:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"client.submitVote(new Vote([2, 3]));\n")),(0,a.kt)("p",null,"This approach calculates the cost of each vote based on the costExponent, for example, allocating 2 votes for option 0\nwill consume 4 credits (2^2 = 4 credits) and 3 votes for option 1 will consume 9 credits (3^2 = 9 credits), with a\ntotal of 13 (4 + 9) credits spent:"),(0,a.kt)("p",null,"The formula (in this case) is like:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"Votes | Credits\n1\xb2 = 1\n2\xb2 = 4\n3\xb2 = 9\n4\xb2 = 16\n")),(0,a.kt)("h2",{id:"results-interpretation"},"Results interpretation"),(0,a.kt)("p",null,"Let's imagine a scenario where we have 10 voters and each of them casts the same vote ",(0,a.kt)("inlineCode",{parentName:"p"},"[2, 3]"),"."),(0,a.kt)("p",null,"The election results are presented as a bi-dimensional array:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"[ \n [ '20' ], [ '30' ] \n]\n")),(0,a.kt)("p",null,"The first array position ",(0,a.kt)("inlineCode",{parentName:"p"},"[ '20' ]")," and the second ",(0,a.kt)("inlineCode",{parentName:"p"},"[ '30' ]")," represent the sum of votes cast for option one and option\ntwo, respectively. In this instance, each voter assigned two votes to option one and three votes to option two."),(0,a.kt)("p",null,"Given that there are 10 voters and each voted the same way, the sum of all the votes is as follows:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"For option one ",(0,a.kt)("inlineCode",{parentName:"li"},"([ '20' ])"),": Each of the 10 voters gave two votes, leading to a total of 20 votes."),(0,a.kt)("li",{parentName:"ul"},"For option two ",(0,a.kt)("inlineCode",{parentName:"li"},"([ '30' ])"),": Each voter gave three votes, leading to a total of 30 votes.")),(0,a.kt)("p",null,"Remember, this interpretation assumes that all voters have used the same voting pattern. Moreover, under the\nquadratic voting system, while it is possible to cast more votes for a preferred option, it also becomes exponentially\nmore costly to do so, providing a self-balancing mechanism that aims to accurately reflect the strength of voters\npreferences."))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/445f6f2d.83470aeb.js b/assets/js/445f6f2d.83470aeb.js deleted file mode 100644 index 3aabff95b..000000000 --- a/assets/js/445f6f2d.83470aeb.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7456],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>f});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function c(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):c(c({},t),e)),n},s=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),u=p(n),f=a,k=u["".concat(l,".").concat(f)]||u[f]||d[f]||i;return n?r.createElement(k,c(c({ref:t},s),{},{components:n})):r.createElement(k,c({ref:t},s))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,c=new Array(i);c[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,c[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const i={},c=void 0,o={unversionedId:"sdk/reference/interfaces/SetAccountTx",id:"sdk/reference/interfaces/SetAccountTx",title:"SetAccountTx",description:"@vocdoni/sdk / Exports / SetAccountTx",source:"@site/docs/sdk/reference/interfaces/SetAccountTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/SetAccountTx",permalink:"/sdk/reference/interfaces/SetAccountTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ServiceProperties",permalink:"/sdk/reference/interfaces/ServiceProperties"},next:{title:"SetProcessTx",permalink:"/sdk/reference/interfaces/SetProcessTx"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"account",id:"account",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"delegates",id:"delegates",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"faucetPackage",id:"faucetpackage",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"infoURI",id:"infouri",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"txtype",id:"txtype",level:3},{value:"Defined in",id:"defined-in-5",level:4}],s={toc:p};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / SetAccountTx"),(0,a.kt)("h1",{id:"interface-setaccounttx"},"Interface: SetAccountTx"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetAccountTx#account"},"account")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetAccountTx#delegates"},"delegates")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetAccountTx#faucetpackage"},"faucetPackage")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetAccountTx#infouri"},"infoURI")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetAccountTx#nonce"},"nonce")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetAccountTx#txtype"},"txtype"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"account"},"account"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"account"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L151"},"api/chain/transactions.ts:151")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"delegates"},"delegates"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"delegates"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array"),"[]"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L153"},"api/chain/transactions.ts:153")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"faucetpackage"},"faucetPackage"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"faucetPackage"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"FaucetPackage")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L152"},"api/chain/transactions.ts:152")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"infouri"},"infoURI"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"infoURI"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L150"},"api/chain/transactions.ts:150")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"nonce"},"nonce"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"nonce"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L149"},"api/chain/transactions.ts:149")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"txtype"},"txtype"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"txtype"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/TxType"},(0,a.kt)("inlineCode",{parentName:"a"},"TxType"))),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L148"},"api/chain/transactions.ts:148")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/445f6f2d.ee94fdae.js b/assets/js/445f6f2d.ee94fdae.js new file mode 100644 index 000000000..f03936d60 --- /dev/null +++ b/assets/js/445f6f2d.ee94fdae.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7456],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>f});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),p=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},s=function(e){var t=p(e.components);return a.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,s=c(e,["components","mdxType","originalType","parentName"]),u=p(n),f=r,k=u["".concat(l,".").concat(f)]||u[f]||d[f]||i;return n?a.createElement(k,o(o({ref:t},s),{},{components:n})):a.createElement(k,o({ref:t},s))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,o=new Array(i);o[0]=u;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c.mdxType="string"==typeof e?e:r,o[1]=c;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>p});var a=n(87462),r=(n(67294),n(3905));const i={},o=void 0,c={unversionedId:"sdk/reference/interfaces/SetAccountTx",id:"sdk/reference/interfaces/SetAccountTx",title:"SetAccountTx",description:"@vocdoni/sdk / Exports / SetAccountTx",source:"@site/docs/sdk/reference/interfaces/SetAccountTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/SetAccountTx",permalink:"/sdk/reference/interfaces/SetAccountTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ServiceProperties",permalink:"/sdk/reference/interfaces/ServiceProperties"},next:{title:"SetProcessTx",permalink:"/sdk/reference/interfaces/SetProcessTx"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"account",id:"account",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"delegates",id:"delegates",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"faucetPackage",id:"faucetpackage",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"infoURI",id:"infouri",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"txtype",id:"txtype",level:3},{value:"Defined in",id:"defined-in-5",level:4}],s={toc:p};function d(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / SetAccountTx"),(0,r.kt)("h1",{id:"interface-setaccounttx"},"Interface: SetAccountTx"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"SetAccountTx#account"},"account")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"SetAccountTx#delegates"},"delegates")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"SetAccountTx#faucetpackage"},"faucetPackage")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"SetAccountTx#infouri"},"infoURI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"SetAccountTx#nonce"},"nonce")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"SetAccountTx#txtype"},"txtype"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"account"},"account"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"account"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L151"},"api/chain/transactions.ts:151")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"delegates"},"delegates"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"delegates"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array"),"[]"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L153"},"api/chain/transactions.ts:153")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"faucetpackage"},"faucetPackage"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"faucetPackage"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"FaucetPackage")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L152"},"api/chain/transactions.ts:152")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"infouri"},"infoURI"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"infoURI"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L150"},"api/chain/transactions.ts:150")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"nonce"},"nonce"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"nonce"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L149"},"api/chain/transactions.ts:149")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"txtype"},"txtype"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"txtype"),": ",(0,r.kt)("a",{parentName:"p",href:"../enums/TxType"},(0,r.kt)("inlineCode",{parentName:"a"},"TxType"))),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L148"},"api/chain/transactions.ts:148")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/467b2519.434732de.js b/assets/js/467b2519.434732de.js new file mode 100644 index 000000000..31e428d76 --- /dev/null +++ b/assets/js/467b2519.434732de.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3158],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>u});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),s=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},o=function(e){var t=s(e.components);return a.createElement(d.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,o=p(e,["components","mdxType","originalType","parentName"]),m=s(n),u=r,N=m["".concat(d,".").concat(u)]||m[u]||k[u]||i;return n?a.createElement(N,l(l({ref:t},o),{},{components:n})):a.createElement(N,l({ref:t},o))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:r,l[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,p={unversionedId:"sdk/reference/classes/CensusAPI",id:"sdk/reference/classes/CensusAPI",title:"CensusAPI",description:"@vocdoni/sdk / Exports / CensusAPI",source:"@site/docs/sdk/reference/classes/CensusAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/CensusAPI",permalink:"/sdk/reference/classes/CensusAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Census3TokenAPI",permalink:"/sdk/reference/classes/Census3TokenAPI"},next:{title:"CensusService",permalink:"/sdk/reference/classes/CensusService"}},d={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"add",id:"add",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"delete",id:"delete",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"export",id:"export",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"import",id:"import",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"proof",id:"proof",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"publish",id:"publish",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"size",id:"size",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"type",id:"type",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"weight",id:"weight",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-12",level:4}],o={toc:s};function k(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / CensusAPI"),(0,r.kt)("h1",{id:"class-censusapi"},"Class: CensusAPI"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"API")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"CensusAPI"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusAPI#constructor"},"constructor"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusAPI#add"},"add")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusAPI#create"},"create")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusAPI#delete"},"delete")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusAPI#export"},"export")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusAPI#import"},"import")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusAPI#isapierror"},"isApiError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusAPI#isundefinederror"},"isUndefinedError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusAPI#proof"},"proof")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusAPI#publish"},"publish")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusAPI#size"},"size")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusAPI#type"},"type")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusAPI#weight"},"weight"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new CensusAPI"),"(): ",(0,r.kt)("a",{parentName:"p",href:"CensusAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusAPI"))),(0,r.kt)("p",null,"Cannot be constructed."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"CensusAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusAPI"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"API.constructor"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L121"},"api/census.ts:121")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"add"},"add"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"add"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"authToken"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusAddResponse"),">"),(0,r.kt)("p",null,"Adds participants to a census"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Authentication token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the census to which participants are being added")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participants")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{"," ",(0,r.kt)("inlineCode",{parentName:"td"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"weight?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"bigint")," }[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"An array of participants")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusAddResponse"),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L153"},"api/census.ts:153")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"create"},"create"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"create"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"authToken"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusCreateResponse"),">"),(0,r.kt)("p",null,"Create's a new census in the API."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Authentication token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"type")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Type of census to be created")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusCreateResponse"),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L133"},"api/census.ts:133")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"delete"},"delete"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"delete"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"authToken"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Deletes the given census"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Authentication token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census ID we want to export")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"on success"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L275"},"api/census.ts:275")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"export"},"export"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"export"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"authToken"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusExportResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusExportResponse")),">"),(0,r.kt)("p",null,"Exports the given census identifier"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Authentication token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census ID we want to export")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusExportResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusExportResponse")),">"),(0,r.kt)("p",null,"on success"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L223"},"api/census.ts:223")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"import"},"import"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"import"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"authToken"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"rootHash"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusImportResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusImportResponse")),">"),(0,r.kt)("p",null,"Imports data into the given census identifier"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Authentication token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census ID we want to export")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"type")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The type of the census")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"rootHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The root hash of the census")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census data to be imported")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusImportResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusImportResponse")),">"),(0,r.kt)("p",null,"on success"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L245"},"api/census.ts:245")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isapierror"},"isApiError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"API.isApiError"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L21"},"api/api.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"API.isUndefinedError"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L64"},"api/api.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"proof"},"proof"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"proof"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusProofResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusProofResponse")),">"),(0,r.kt)("p",null,"Checks if the specified address is in the specified census"),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census ID of which we want the proof from")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The address to be checked")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusProofResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusProofResponse")),">"),(0,r.kt)("p",null,"on success"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L208"},"api/census.ts:208")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"publish"},"publish"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"publish"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"authToken"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusPublishResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusPublishResponse")),">"),(0,r.kt)("p",null,"Publishes the census, so it can be used in processes"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Authentication token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census ID we're publishing")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusPublishResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusPublishResponse")),">"),(0,r.kt)("p",null,"on success"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L189"},"api/census.ts:189")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"size"},"size"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"size"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusSizeResponse"),">"),(0,r.kt)("p",null,"Returns the size of a given census"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census ID")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusSizeResponse"),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L293"},"api/census.ts:293")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"type"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusTypeResponse"),">"),(0,r.kt)("p",null,"Returns the type of given census"),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census ID")))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusTypeResponse"),">"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L321"},"api/census.ts:321")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"weight"},"weight"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"weight"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusWeightResponse"),">"),(0,r.kt)("p",null,"Returns the weight of a given census"),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census ID")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusWeightResponse"),">"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L307"},"api/census.ts:307")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/467b2519.a9a2032f.js b/assets/js/467b2519.a9a2032f.js deleted file mode 100644 index 2da28cf1c..000000000 --- a/assets/js/467b2519.a9a2032f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3158],{3905:(e,t,n)=>{n.d(t,{Zo:()=>k,kt:()=>u});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=a.createContext({}),d=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},k=function(e){var t=d(e.components);return a.createElement(s.Provider,{value:t},e.children)},o={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,k=p(e,["components","mdxType","originalType","parentName"]),m=d(n),u=r,N=m["".concat(s,".").concat(u)]||m[u]||o[u]||i;return n?a.createElement(N,l(l({ref:t},k),{},{components:n})):a.createElement(N,l({ref:t},k))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p.mdxType="string"==typeof e?e:r,l[1]=p;for(var d=2;d{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>o,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,p={unversionedId:"sdk/reference/classes/CensusAPI",id:"sdk/reference/classes/CensusAPI",title:"CensusAPI",description:"@vocdoni/sdk / Exports / CensusAPI",source:"@site/docs/sdk/reference/classes/CensusAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/CensusAPI",permalink:"/sdk/reference/classes/CensusAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Census3TokenAPI",permalink:"/sdk/reference/classes/Census3TokenAPI"},next:{title:"CensusService",permalink:"/sdk/reference/classes/CensusService"}},s={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"add",id:"add",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"delete",id:"delete",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"export",id:"export",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"import",id:"import",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"proof",id:"proof",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"publish",id:"publish",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"size",id:"size",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"type",id:"type",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"weight",id:"weight",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-12",level:4}],k={toc:d};function o(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / CensusAPI"),(0,r.kt)("h1",{id:"class-censusapi"},"Class: CensusAPI"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"API")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"CensusAPI"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusAPI#constructor"},"constructor"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusAPI#add"},"add")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusAPI#create"},"create")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusAPI#delete"},"delete")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusAPI#export"},"export")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusAPI#import"},"import")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusAPI#isapierror"},"isApiError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusAPI#isundefinederror"},"isUndefinedError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusAPI#proof"},"proof")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusAPI#publish"},"publish")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusAPI#size"},"size")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusAPI#type"},"type")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusAPI#weight"},"weight"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new CensusAPI"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CensusAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusAPI"))),(0,r.kt)("p",null,"Cannot be constructed."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CensusAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusAPI"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"API.constructor"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L121"},"api/census.ts:121")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"add"},"add"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"add"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"authToken"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusAddResponse"),">"),(0,r.kt)("p",null,"Adds participants to a census"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Authentication token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the census to which participants are being added")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participants")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{"," ",(0,r.kt)("inlineCode",{parentName:"td"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"weight?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"bigint")," }[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"An array of participants")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusAddResponse"),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L153"},"api/census.ts:153")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"create"},"create"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"create"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"authToken"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusCreateResponse"),">"),(0,r.kt)("p",null,"Create's a new census in the API."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Authentication token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"type")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Type of census to be created")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusCreateResponse"),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L133"},"api/census.ts:133")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"delete"},"delete"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"delete"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"authToken"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Deletes the given census"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Authentication token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census ID we want to export")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"on success"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L275"},"api/census.ts:275")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"export"},"export"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"export"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"authToken"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusExportResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusExportResponse")),">"),(0,r.kt)("p",null,"Exports the given census identifier"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Authentication token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census ID we want to export")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusExportResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusExportResponse")),">"),(0,r.kt)("p",null,"on success"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L223"},"api/census.ts:223")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"import"},"import"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"import"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"authToken"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"rootHash"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusImportResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusImportResponse")),">"),(0,r.kt)("p",null,"Imports data into the given census identifier"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Authentication token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census ID we want to export")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"type")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The type of the census")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"rootHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The root hash of the census")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census data to be imported")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusImportResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusImportResponse")),">"),(0,r.kt)("p",null,"on success"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L245"},"api/census.ts:245")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isapierror"},"isApiError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"API.isApiError"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L21"},"api/api.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"API.isUndefinedError"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L64"},"api/api.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"proof"},"proof"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"proof"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusProofResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusProofResponse")),">"),(0,r.kt)("p",null,"Checks if the specified address is in the specified census"),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census ID of which we want the proof from")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The address to be checked")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusProofResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusProofResponse")),">"),(0,r.kt)("p",null,"on success"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L208"},"api/census.ts:208")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"publish"},"publish"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"publish"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"authToken"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusPublishResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusPublishResponse")),">"),(0,r.kt)("p",null,"Publishes the census, so it can be used in processes"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Authentication token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census ID we're publishing")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusPublishResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusPublishResponse")),">"),(0,r.kt)("p",null,"on success"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L189"},"api/census.ts:189")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"size"},"size"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"size"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusSizeResponse"),">"),(0,r.kt)("p",null,"Returns the size of a given census"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census ID")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusSizeResponse"),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L293"},"api/census.ts:293")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"type"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusTypeResponse"),">"),(0,r.kt)("p",null,"Returns the type of given census"),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census ID")))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusTypeResponse"),">"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L321"},"api/census.ts:321")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"weight"},"weight"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"weight"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusWeightResponse"),">"),(0,r.kt)("p",null,"Returns the weight of a given census"),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census ID")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusWeightResponse"),">"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L307"},"api/census.ts:307")))}o.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/46b36dc0.7cf4efeb.js b/assets/js/46b36dc0.7cf4efeb.js new file mode 100644 index 000000000..92bcd20d7 --- /dev/null +++ b/assets/js/46b36dc0.7cf4efeb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3082],{3905:(e,t,n)=>{n.d(t,{Zo:()=>h,kt:()=>u});var i=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function a(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var l=i.createContext({}),p=function(e){var t=i.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},h=function(e){var t=p(e.components);return i.createElement(l.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},d=i.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,l=e.parentName,h=s(e,["components","mdxType","originalType","parentName"]),d=p(n),u=o,g=d["".concat(l,".").concat(u)]||d[u]||c[u]||r;return n?i.createElement(g,a(a({ref:t},h),{},{components:n})):i.createElement(g,a({ref:t},h))}));function u(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,a=new Array(r);a[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:o,a[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>c,frontMatter:()=>r,metadata:()=>s,toc:()=>p});var i=n(87462),o=(n(67294),n(3905));const r={sidebar_position:5,slug:"weighted"},a="Weighted voting",s={unversionedId:"sdk/integration-details/voting-types/weighted",id:"sdk/integration-details/voting-types/weighted",title:"Weighted voting",description:"Weighted voting is a voting system where each voter is assigned a specific weight or value that reflects their relative influence or importance in the decision-making process.",source:"@site/docs/sdk/integration-details/voting-types/weighted.md",sourceDirName:"sdk/integration-details/voting-types",slug:"/sdk/integration-details/voting-types/weighted",permalink:"/sdk/integration-details/voting-types/weighted",draft:!1,tags:[],version:"current",sidebarPosition:5,frontMatter:{sidebar_position:5,slug:"weighted"},sidebar:"defaultSidebar",previous:{title:"Approval Voting (Multiple Choice)",permalink:"/sdk/integration-details/voting-types/approval"},next:{title:"Quadratic voting",permalink:"/sdk/integration-details/voting-types/quadratic"}},l={},p=[{value:"Setting up the election",id:"setting-up-the-election",level:2},{value:"Creating a WeightedCensus",id:"creating-a-weightedcensus",level:3},{value:"Casting a vote",id:"casting-a-vote",level:2},{value:"Results interpretation",id:"results-interpretation",level:2}],h={toc:p};function c(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,i.Z)({},h,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"weighted-voting"},"Weighted voting"),(0,o.kt)("p",null,"Weighted voting is a voting system where each voter is assigned a specific weight or value that reflects their relative influence or importance in the decision-making process."),(0,o.kt)("p",null,"When votes are cast, the value of each individual\u2019s vote is multiplied by their assigned weight, resulting in a weighted score. The sum of all the weighted scores determines the outcome of the vote. This system allows for a more nuanced\nrepresentation of voting power and can reflect the hierarchical structure or distribution of authority within the\norganization."),(0,o.kt)("h2",{id:"setting-up-the-election"},"Setting up the election"),(0,o.kt)("p",null,"The process creation and use of the ballot protocol is the same as on any other Election, the key difference is the\nuse of a ",(0,o.kt)("inlineCode",{parentName:"p"},"WeightedCensus")," instead of a ",(0,o.kt)("inlineCode",{parentName:"p"},"PlainCensus"),"."),(0,o.kt)("admonition",{title:"Where can I use a WeightedCensus?",type:"tip"},(0,o.kt)("p",{parentName:"admonition"},"Essentially, you can use the ",(0,o.kt)("inlineCode",{parentName:"p"},"WeightedCensus")," for any vote type except quadratic voting."),(0,o.kt)("p",{parentName:"admonition"},"Note that ",(0,o.kt)("inlineCode",{parentName:"p"},"quadratic voting")," already uses a ",(0,o.kt)("inlineCode",{parentName:"p"},"WeightedCensus")," but for other purposes. On a ",(0,o.kt)("inlineCode",{parentName:"p"},"quadratic election")," the\nweighted census are used to set the available credits for every voter when the option ",(0,o.kt)("inlineCode",{parentName:"p"},"costFromWeight")," is set to ",(0,o.kt)("inlineCode",{parentName:"p"},"true"),".")),(0,o.kt)("p",null,"The votes are stored on the blockchain with its weight like any other voting process. When the results are retrieved\nfrom the API, the indexer applies the weight to every vote, and this reflects in the results matrix."),(0,o.kt)("h3",{id:"creating-a-weightedcensus"},"Creating a ",(0,o.kt)("inlineCode",{parentName:"h3"},"WeightedCensus")),(0,o.kt)("p",null,"Following de above example, we are going to create a census where the weight is related to the position of the voter on\nthe participants array."),(0,o.kt)("p",null,"The process of generate a ",(0,o.kt)("inlineCode",{parentName:"p"},"WeightedCensus")," is similar to create a ",(0,o.kt)("inlineCode",{parentName:"p"},"PlainCensus")," with the difference that you have to\nadd the vote weight to every participant. As shown below, we are giving to each voter a weight associated to its\nposition on an array. For 4 voters, the first one will have a weight of 1, and the last will have 4."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"}," const census = new WeightedCensus();\n census.add(\n participants.map((participant, index) => ({\n key: participant.address,\n weight: BigInt(index + 1), // Give the weight to each participant\n }))\n );\n")),(0,o.kt)("h2",{id:"casting-a-vote"},"Casting a vote"),(0,o.kt)("p",null,'For instance, consider that 4 voters have to vote on the question: "Do you like chocolate?" with possible answers "yes" and "no".\nThe weight distribution and votes are as follows:'),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Voter 1: Weight = 1, Votes for option 0 (no), hence adds 1 vote."),(0,o.kt)("li",{parentName:"ul"},"Voter 2: Weight = 2, Votes for option 1 (yes), hence adds 2 votes."),(0,o.kt)("li",{parentName:"ul"},"Voter 3: Weight = 3, Votes for option 0 (no), hence adds 3 votes."),(0,o.kt)("li",{parentName:"ul"},"Voter 4: Weight = 4, Votes for option 1 (yes), hence adds 4 votes.")),(0,o.kt)("p",null,"The total census weight is ",(0,o.kt)("inlineCode",{parentName:"p"},"1 + 2 + 3 + 4 = 10")," and will be distributed among the choices."),(0,o.kt)("p",null,"The related code could be something like:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"client.submitVote(new Vote([participantIndex % 2]));\n")),(0,o.kt)("h2",{id:"results-interpretation"},"Results interpretation"),(0,o.kt)("p",null,"The results from a weighted voting process are returned by the API as an array, which encapsulates the sum of the\nweighted votes cast for each choice. In the given example, the API will return the following array:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"[ [ '4', '6' ] ]\n")),(0,o.kt)("p",null,"In this type of election, where there's only one question with two possible choices, the array represents the summed\nweights of votes for each option. Here, each index in the array corresponds to an option from the voting question."),(0,o.kt)("p",null,"The value at each index is the total of weighted votes that the corresponding option received. For the first option (no),\nthe total weighted votes are ",(0,o.kt)("inlineCode",{parentName:"p"},"1 (from voter 1) + 3 (from voter 3) = 4"),", hence '4' at the first index of the array."),(0,o.kt)("p",null,"For the second option (yes), the total weighted votes are ",(0,o.kt)("inlineCode",{parentName:"p"},"2 (from voter 2) + 4 (from voter 4) = 6"),", thus '6' at the\nsecond index."),(0,o.kt)("p",null,"The array ",(0,o.kt)("inlineCode",{parentName:"p"},"[ [ '4', '6' ] ]")," encapsulates this result, which can be interpreted as \"4 weighted votes for 'no' and 6\nweighted votes for 'yes'\"."))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/491af8ad.320db25b.js b/assets/js/491af8ad.320db25b.js new file mode 100644 index 000000000..7329e1080 --- /dev/null +++ b/assets/js/491af8ad.320db25b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[135],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>f});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var p=r.createContext({}),s=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},d=function(e){var t=s(e.components);return r.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=s(n),f=o,m=u["".concat(p,".").concat(f)]||u[f]||c[f]||i;return n?r.createElement(m,a(a({ref:t},d),{},{components:n})):r.createElement(m,a({ref:t},d))}));function f(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:o,a[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>a,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=n(87462),o=(n(67294),n(3905));const i={},a=void 0,l={unversionedId:"sdk/reference/interfaces/IVoteMode",id:"sdk/reference/interfaces/IVoteMode",title:"IVoteMode",description:"@vocdoni/sdk / Exports / IVoteMode",source:"@site/docs/sdk/reference/interfaces/IVoteMode.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IVoteMode",permalink:"/sdk/reference/interfaces/IVoteMode",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IVoteInfoResponse",permalink:"/sdk/reference/interfaces/IVoteInfoResponse"},next:{title:"IVoteSubmitResponse",permalink:"/sdk/reference/interfaces/IVoteSubmitResponse"}},p={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"anonymous",id:"anonymous",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"costFromWeight",id:"costfromweight",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"encryptedVotes",id:"encryptedvotes",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"serial",id:"serial",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"uniqueValues",id:"uniquevalues",level:3},{value:"Defined in",id:"defined-in-4",level:4}],d={toc:s};function c(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IVoteMode"),(0,o.kt)("h1",{id:"interface-ivotemode"},"Interface: IVoteMode"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteMode#anonymous"},"anonymous")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteMode#costfromweight"},"costFromWeight")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteMode#encryptedvotes"},"encryptedVotes")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteMode#serial"},"serial")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteMode#uniquevalues"},"uniqueValues"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"anonymous"},"anonymous"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"anonymous"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")),(0,o.kt)("p",null,"If the vote is anonymous"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L53"},"api/election.ts:53")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"costfromweight"},"costFromWeight"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"costFromWeight"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")),(0,o.kt)("p",null,"Cost from weight of the election"),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L68"},"api/election.ts:68")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"encryptedvotes"},"encryptedVotes"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"encryptedVotes"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")),(0,o.kt)("p",null,"If the vote is encrypted"),(0,o.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L58"},"api/election.ts:58")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"serial"},"serial"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"serial"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")),(0,o.kt)("p",null,"If the vote is serial"),(0,o.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L48"},"api/election.ts:48")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"uniquevalues"},"uniqueValues"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"uniqueValues"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")),(0,o.kt)("p",null,"If the vote values are unique"),(0,o.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L63"},"api/election.ts:63")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/491af8ad.63b707d0.js b/assets/js/491af8ad.63b707d0.js deleted file mode 100644 index 721cebbd8..000000000 --- a/assets/js/491af8ad.63b707d0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[135],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>f});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=r.createContext({}),c=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},p=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),u=c(n),f=o,k=u["".concat(s,".").concat(f)]||u[f]||d[f]||i;return n?r.createElement(k,a(a({ref:t},p),{},{components:n})):r.createElement(k,a({ref:t},p))}));function f(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:o,a[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var r=n(87462),o=(n(67294),n(3905));const i={},a=void 0,l={unversionedId:"sdk/reference/interfaces/IVoteMode",id:"sdk/reference/interfaces/IVoteMode",title:"IVoteMode",description:"@vocdoni/sdk / Exports / IVoteMode",source:"@site/docs/sdk/reference/interfaces/IVoteMode.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IVoteMode",permalink:"/sdk/reference/interfaces/IVoteMode",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IVoteInfoResponse",permalink:"/sdk/reference/interfaces/IVoteInfoResponse"},next:{title:"IVoteSubmitResponse",permalink:"/sdk/reference/interfaces/IVoteSubmitResponse"}},s={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"anonymous",id:"anonymous",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"costFromWeight",id:"costfromweight",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"encryptedVotes",id:"encryptedvotes",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"serial",id:"serial",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"uniqueValues",id:"uniquevalues",level:3},{value:"Defined in",id:"defined-in-4",level:4}],p={toc:c};function d(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IVoteMode"),(0,o.kt)("h1",{id:"interface-ivotemode"},"Interface: IVoteMode"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteMode#anonymous"},"anonymous")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteMode#costfromweight"},"costFromWeight")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteMode#encryptedvotes"},"encryptedVotes")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteMode#serial"},"serial")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteMode#uniquevalues"},"uniqueValues"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"anonymous"},"anonymous"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"anonymous"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")),(0,o.kt)("p",null,"If the vote is anonymous"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L53"},"api/election.ts:53")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"costfromweight"},"costFromWeight"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"costFromWeight"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")),(0,o.kt)("p",null,"Cost from weight of the election"),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L68"},"api/election.ts:68")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"encryptedvotes"},"encryptedVotes"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"encryptedVotes"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")),(0,o.kt)("p",null,"If the vote is encrypted"),(0,o.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L58"},"api/election.ts:58")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"serial"},"serial"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"serial"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")),(0,o.kt)("p",null,"If the vote is serial"),(0,o.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L48"},"api/election.ts:48")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"uniquevalues"},"uniqueValues"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"uniqueValues"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")),(0,o.kt)("p",null,"If the vote values are unique"),(0,o.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L63"},"api/election.ts:63")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/49b14676.433ea344.js b/assets/js/49b14676.433ea344.js deleted file mode 100644 index f5cbbe6a8..000000000 --- a/assets/js/49b14676.433ea344.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7583],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>m});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),d=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},o=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),c=d(n),m=a,f=c["".concat(p,".").concat(m)]||c[m]||k[m]||i;return n?r.createElement(f,l(l({ref:t},o),{},{components:n})):r.createElement(f,l({ref:t},o))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=c;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s.mdxType="string"==typeof e?e:a,l[1]=s;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=n(87462),a=(n(67294),n(3905));const i={},l=void 0,s={unversionedId:"sdk/reference/classes/CspService",id:"sdk/reference/classes/CspService",title:"CspService",description:"@vocdoni/sdk / Exports / CspService",source:"@site/docs/sdk/reference/classes/CspService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/CspService",permalink:"/sdk/reference/classes/CspService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CspCensus",permalink:"/sdk/reference/classes/CspCensus"},next:{title:"CspVote",permalink:"/sdk/reference/classes/CspVote"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"info",id:"info",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods-1",level:2},{value:"cspSign",id:"cspsign",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"cspStep",id:"cspstep",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"cspVote",id:"cspvote",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"setInfo",id:"setinfo",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"setUrlFromElection",id:"seturlfromelection",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"cspVote",id:"cspvote-1",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"fetchUrlFromElection",id:"fetchurlfromelection",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-9",level:4}],o={toc:d};function k(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / CspService"),(0,a.kt)("h1",{id:"class-cspservice"},"Class: CspService"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},(0,a.kt)("inlineCode",{parentName:"a"},"Service"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"CspService"))))),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"CspServiceProperties"))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspService#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspService#info"},"info")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspService#url"},"url"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspService#cspsign"},"cspSign")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspService#cspstep"},"cspStep")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspService#cspvote"},"cspVote")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspService#setinfo"},"setInfo")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspService#seturlfromelection"},"setUrlFromElection")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspService#cspvote-1"},"cspVote")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspService#fetchurlfromelection"},"fetchUrlFromElection"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new CspService"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CspService"},(0,a.kt)("inlineCode",{parentName:"a"},"CspService"))),(0,a.kt)("p",null,"Instantiate the CSP service."),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"CspServiceParameters"),">"),(0,a.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CspService"},(0,a.kt)("inlineCode",{parentName:"a"},"CspService"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/csp.ts#L29"},"services/csp.ts:29")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"info"},"info"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"info"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ICspInfoResponse")),(0,a.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,a.kt)("p",null,"CspServiceProperties.info"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/csp.ts#L22"},"services/csp.ts:22")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"url"},"url"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"url"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#url"},"url")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/service.ts#L6"},"services/service.ts:6")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"cspsign"},"cspSign"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"cspSign"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"electionId"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"token"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"electionId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"address")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"token")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/csp.ts#L64"},"services/csp.ts:64")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"cspstep"},"cspStep"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"cspStep"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"electionId"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stepNumber"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"authToken?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"ICspIntermediateStepResponse")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"ICspFinalStepResponse"),">"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"electionId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"stepNumber")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"data")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"any"),"[]")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"authToken?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"ICspIntermediateStepResponse")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"ICspFinalStepResponse"),">"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/csp.ts#L49"},"services/csp.ts:49")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"cspvote"},"cspVote"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"cspVote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"vote"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"proof_type?"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CspVote"},(0,a.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"vote")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote")))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"signature")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"proof_type?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CspProofType"},(0,a.kt)("inlineCode",{parentName:"a"},"CspProofType")))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CspVote"},(0,a.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/csp.ts#L75"},"services/csp.ts:75")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"setinfo"},"setInfo"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"setInfo"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"ICspInfoResponse"),">"),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"ICspInfoResponse"),">"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/csp.ts#L43"},"services/csp.ts:43")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"seturlfromelection"},"setUrlFromElection"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"setUrlFromElection"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"parameters-4"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"election")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Election"},(0,a.kt)("inlineCode",{parentName:"a"},"Election")))))),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/csp.ts#L39"},"services/csp.ts:39")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"cspvote-1"},"cspVote"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"cspVote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"vote"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"proof_type?"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CspVote"},(0,a.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,a.kt)("h4",{id:"parameters-5"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"vote")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote")))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"signature")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"proof_type?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CspProofType"},(0,a.kt)("inlineCode",{parentName:"a"},"CspProofType")))))),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CspVote"},(0,a.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/csp.ts#L79"},"services/csp.ts:79")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"fetchurlfromelection"},"fetchUrlFromElection"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"fetchUrlFromElection"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"parameters-6"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"election")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Election"},(0,a.kt)("inlineCode",{parentName:"a"},"Election")))))),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/csp.ts#L34"},"services/csp.ts:34")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/49b14676.b95adf72.js b/assets/js/49b14676.b95adf72.js new file mode 100644 index 000000000..1c5bbc4f6 --- /dev/null +++ b/assets/js/49b14676.b95adf72.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7583],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>c});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),o=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=o(e.components);return r.createElement(s.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),m=o(n),c=a,u=m["".concat(s,".").concat(c)]||m[c]||k[c]||i;return n?r.createElement(u,l(l({ref:t},d),{},{components:n})):r.createElement(u,l({ref:t},d))}));function c(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=m;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p.mdxType="string"==typeof e?e:a,l[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var r=n(87462),a=(n(67294),n(3905));const i={},l=void 0,p={unversionedId:"sdk/reference/classes/CspService",id:"sdk/reference/classes/CspService",title:"CspService",description:"@vocdoni/sdk / Exports / CspService",source:"@site/docs/sdk/reference/classes/CspService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/CspService",permalink:"/sdk/reference/classes/CspService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CspCensus",permalink:"/sdk/reference/classes/CspCensus"},next:{title:"CspVote",permalink:"/sdk/reference/classes/CspVote"}},s={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"info",id:"info",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods-1",level:2},{value:"cspSign",id:"cspsign",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"cspStep",id:"cspstep",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"cspVote",id:"cspvote",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"setInfo",id:"setinfo",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"setUrlFromElection",id:"seturlfromelection",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"cspVote",id:"cspvote-1",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"fetchUrlFromElection",id:"fetchurlfromelection",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:o};function k(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / CspService"),(0,a.kt)("h1",{id:"class-cspservice"},"Class: CspService"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"Service"},(0,a.kt)("inlineCode",{parentName:"a"},"Service"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"CspService"))))),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"CspServiceProperties"))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"CspService#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"CspService#info"},"info")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"CspService#url"},"url"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"CspService#cspsign"},"cspSign")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"CspService#cspstep"},"cspStep")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"CspService#cspvote"},"cspVote")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"CspService#setinfo"},"setInfo")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"CspService#seturlfromelection"},"setUrlFromElection")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspService#cspvote-1"},"cspVote")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"CspService#fetchurlfromelection"},"fetchUrlFromElection"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new CspService"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"CspService"},(0,a.kt)("inlineCode",{parentName:"a"},"CspService"))),(0,a.kt)("p",null,"Instantiate the CSP service."),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"CspServiceParameters"),">"),(0,a.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"CspService"},(0,a.kt)("inlineCode",{parentName:"a"},"CspService"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,a.kt)("a",{parentName:"p",href:"Service#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/csp.ts#L29"},"services/csp.ts:29")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"info"},"info"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"info"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ICspInfoResponse")),(0,a.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,a.kt)("p",null,"CspServiceProperties.info"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/csp.ts#L22"},"services/csp.ts:22")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"url"},"url"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"url"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,a.kt)("a",{parentName:"p",href:"Service#url"},"url")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/service.ts#L6"},"services/service.ts:6")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"cspsign"},"cspSign"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"cspSign"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"electionId"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"token"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"electionId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"address")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"token")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/csp.ts#L64"},"services/csp.ts:64")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"cspstep"},"cspStep"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"cspStep"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"electionId"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stepNumber"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"authToken?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"ICspIntermediateStepResponse")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"ICspFinalStepResponse"),">"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"electionId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"stepNumber")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"data")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"any"),"[]")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"authToken?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"ICspIntermediateStepResponse")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"ICspFinalStepResponse"),">"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/csp.ts#L49"},"services/csp.ts:49")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"cspvote"},"cspVote"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"cspVote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"vote"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"proof_type?"),"): ",(0,a.kt)("a",{parentName:"p",href:"CspVote"},(0,a.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"vote")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote")))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"signature")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"proof_type?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../enums/CspProofType"},(0,a.kt)("inlineCode",{parentName:"a"},"CspProofType")))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"CspVote"},(0,a.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/csp.ts#L75"},"services/csp.ts:75")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"setinfo"},"setInfo"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"setInfo"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"ICspInfoResponse"),">"),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"ICspInfoResponse"),">"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/csp.ts#L43"},"services/csp.ts:43")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"seturlfromelection"},"setUrlFromElection"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"setUrlFromElection"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"parameters-4"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"election")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"Election"},(0,a.kt)("inlineCode",{parentName:"a"},"Election")))))),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/csp.ts#L39"},"services/csp.ts:39")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"cspvote-1"},"cspVote"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"cspVote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"vote"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"proof_type?"),"): ",(0,a.kt)("a",{parentName:"p",href:"CspVote"},(0,a.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,a.kt)("h4",{id:"parameters-5"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"vote")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote")))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"signature")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"proof_type?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../enums/CspProofType"},(0,a.kt)("inlineCode",{parentName:"a"},"CspProofType")))))),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"CspVote"},(0,a.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/csp.ts#L79"},"services/csp.ts:79")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"fetchurlfromelection"},"fetchUrlFromElection"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"fetchUrlFromElection"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"parameters-6"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"election")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"Election"},(0,a.kt)("inlineCode",{parentName:"a"},"Election")))))),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/csp.ts#L34"},"services/csp.ts:34")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4a1ec646.7a3fa26e.js b/assets/js/4a1ec646.7a3fa26e.js new file mode 100644 index 000000000..b163bd33a --- /dev/null +++ b/assets/js/4a1ec646.7a3fa26e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5909],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>f});var a=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=a.createContext({}),l=function(e){var t=a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=l(e.components);return a.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=l(n),f=i,h=u["".concat(c,".").concat(f)]||u[f]||d[f]||r;return n?a.createElement(h,o(o({ref:t},p),{},{components:n})):a.createElement(h,o({ref:t},p))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,o=new Array(r);o[0]=u;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s.mdxType="string"==typeof e?e:i,o[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>s,toc:()=>l});var a=n(87462),i=(n(67294),n(3905));const r={},o="Off-chain Credential Service Provider",s={unversionedId:"sdk/integration-details/census-types/off-chain-csp",id:"sdk/integration-details/census-types/off-chain-csp",title:"Off-chain Credential Service Provider",description:"A Credential Service Provider is an external component that serves as a validator for the identities of voters. An example of this could be a service set up by a municipal government that validates if a given voter is registered, or a forum that validates if a given voter has an active account. With this type of census, voters show proof of registry and receive a cryptographic package from the CSP allowing them to cast a vote.",source:"@site/docs/sdk/integration-details/census-types/off-chain-csp.md",sourceDirName:"sdk/integration-details/census-types",slug:"/sdk/integration-details/census-types/off-chain-csp",permalink:"/sdk/integration-details/census-types/off-chain-csp",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Census Types",permalink:"/sdk/integration-details/census-types/"},next:{title:"Off-chain Merkle Tree",permalink:"/sdk/integration-details/census-types/off-chain-tree"}},c={},l=[{value:"Anonymity",id:"anonymity",level:2}],p={toc:l};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"off-chain-credential-service-provider"},"Off-chain Credential Service Provider"),(0,i.kt)("p",null,"A Credential Service Provider is an external component that serves as a validator for the identities of voters. An example of this could be a service set up by a municipal government that validates if a given voter is registered, or a forum that validates if a given voter has an active account. With this type of census, voters show proof of registry and receive a cryptographic package from the CSP allowing them to cast a vote. "),(0,i.kt)("p",null,"Because using an off-chain CSP census requires a custom CSP for each use-case, it is not ready to use out-of-the-box. If you are interested in setting up a CSP election, please ",(0,i.kt)("a",{parentName:"p",href:"https://chat.vocdoni.io"},"reach out to us")," for help."),(0,i.kt)("p",null,"CSP census elections have the option of full-anonymity with the use of ",(0,i.kt)("a",{parentName:"p",href:"/protocol/Census/off-chain-csp#blind-signatures"},"Blind Signatures"),". "),(0,i.kt)("p",null,"If a CSP is set up for a census, minor modifications are needed on the client side. For creating a CSP based election, a ",(0,i.kt)("inlineCode",{parentName:"p"},"CspCensus")," has to be used with the CSP's public key and URL as parameters. "),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"const election = Election.from({\n title: 'Election title',\n description: 'Election description',\n // a header image for your process (this is for example purposes; avoid using random sources)\n header: 'https://source.unsplash.com/random/2048x600',\n endDate: new Date('2023-01-23 23:23:23'),\n census: new CspCensus(CSP_PUBKEY, CSP_URL),\n})\n// The election can be created the same way from here...\n")),(0,i.kt)("p",null,"The next step is requesting a blind signature from the CSP for each voter before casting their vote. "),(0,i.kt)("p",null,"This is done with ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#cspstep"},(0,i.kt)("inlineCode",{parentName:"a"},"client.cspStep")),'. This function sends an API call to the given CSP to perform an "authentication step" predefined by whoever sets up the CSP. A step could be validating a name, sending an authentication token, or anything else. Non-final steps should return a ',(0,i.kt)("inlineCode",{parentName:"p"},"ICspIntermediateStepResponse")," object containing an ",(0,i.kt)("inlineCode",{parentName:"p"},"authToken")," and arbitrary ",(0,i.kt)("inlineCode",{parentName:"p"},"response")," data.\nOnce the predefined set of steps has been performed successfully, the final step should return a ",(0,i.kt)("inlineCode",{parentName:"p"},"ICspFinalStepResponse")," object containing a ",(0,i.kt)("inlineCode",{parentName:"p"},"token")," registered to the verified voter."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"// Client initialization\nconst client = new VocdoniSDKClient({\n env: EnvOptions.DEV,\n wallet: voter, // the signer used (Metamask, Walletconnect)\n electionId: '934234...', // The election identifier (has to be a CSP configured election)\n})\n\n// Auth steps for the CSP (can vary of the type of the CSP)\nconst step0 = (await client.cspStep(0, ['Name test'])) as ICspIntermediateStepResponse;\nconst step1 = (await client.cspStep(\n 1,\n [step0.response.reduce((acc, v) => +acc + +v, 0).toString()],\n step0.authToken\n)) as ICspFinalStepResponse;\n")),(0,i.kt)("p",null,"Once this token has been received, the client requests blind signature from the CSP and then uses this signature to cast vote. Because this signature is blinded, the vote cannot be traced back to the voter address or verification information."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"// Get the blind signature\nconst signature = await client.cspSign(voter.address, step1.token);\n\n// Get the vote based on the signature\nconst vote = client.cspVote(new Vote([Math.round(Math.random())]), signature);\n\n// Vote\nconst voteId = await client.submitVote(vote);\n")),(0,i.kt)("h2",{id:"anonymity"},"Anonymity"),(0,i.kt)("p",null,"Credential Service Provider elections provide strong anonymity by the use of ",(0,i.kt)("a",{parentName:"p",href:"/protocol/Census/off-chain-csp#blind-signatures"},"Blind Signatures"),'. This is a slight modification on the standard CSP Census design, in which users are able to send a "blinded" version of their vote to the CSP after getting verified. The CSP signs this blinded package, and the user is then able cast their vote signed by the CSP without their identity being traced to that vote by anybody, including the CSP.'),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://chat.vocdoni.io"},"Ask us")," if you would like to try setting up at CSP that can compute blind signatures. "))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4adb919a.149d7c33.js b/assets/js/4adb919a.149d7c33.js deleted file mode 100644 index 69aafb943..000000000 --- a/assets/js/4adb919a.149d7c33.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8033],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>u});var a=t(67294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function l(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var d=a.createContext({}),o=function(e){var n=a.useContext(d),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},p=function(e){var n=o(e.components);return a.createElement(d.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},k=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,r=e.originalType,d=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),k=o(t),u=i,_=k["".concat(d,".").concat(u)]||k[u]||c[u]||r;return t?a.createElement(_,l(l({ref:n},p),{},{components:t})):a.createElement(_,l({ref:n},p))}));function u(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var r=t.length,l=new Array(r);l[0]=k;var s={};for(var d in n)hasOwnProperty.call(n,d)&&(s[d]=n[d]);s.originalType=e,s.mdxType="string"==typeof e?e:i,l[1]=s;for(var o=2;o{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>r,metadata:()=>s,toc:()=>o});var a=t(87462),i=(t(67294),t(3905));const r={},l=void 0,s={unversionedId:"sdk/reference/enums/TxType",id:"sdk/reference/enums/TxType",title:"TxType",description:"@vocdoni/sdk / Exports / TxType",source:"@site/docs/sdk/reference/enums/TxType.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/TxType",permalink:"/sdk/reference/enums/TxType",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"TransactionType",permalink:"/sdk/reference/enums/TransactionType"},next:{title:"VoteSteps",permalink:"/sdk/reference/enums/VoteSteps"}},d={},o=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"ADD_DELEGATE_FOR_ACCOUNT",id:"add_delegate_for_account",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ADD_KEYKEEPER",id:"add_keykeeper",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ADD_ORACLE",id:"add_oracle",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"ADD_PROCESS_KEYS",id:"add_process_keys",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"ADD_VALIDATOR",id:"add_validator",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"COLLECT_FAUCET",id:"collect_faucet",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"CREATE_ACCOUNT",id:"create_account",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"DELETE_KEYKEEPER",id:"delete_keykeeper",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"DEL_DELEGATE_FOR_ACCOUNT",id:"del_delegate_for_account",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"MINT_TOKENS",id:"mint_tokens",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"NEW_PROCESS",id:"new_process",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"REGISTER_VOTER_KEY",id:"register_voter_key",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"REMOVE_ORACLE",id:"remove_oracle",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"REMOVE_VALIDATOR",id:"remove_validator",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"REVEAL_PROCESS_KEYS",id:"reveal_process_keys",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"SEND_TOKENS",id:"send_tokens",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"SET_ACCOUNT_INFO_URI",id:"set_account_info_uri",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"SET_PROCESS_CENSUS",id:"set_process_census",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"SET_PROCESS_QUESTION_INDEX",id:"set_process_question_index",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"SET_PROCESS_RESULTS",id:"set_process_results",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"SET_PROCESS_STATUS",id:"set_process_status",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"SET_TRANSACTION_COSTS",id:"set_transaction_costs",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"TX_UNKNOWN",id:"tx_unknown",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"UNRECOGNIZED",id:"unrecognized",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"VOTE",id:"vote",level:3},{value:"Defined in",id:"defined-in-24",level:4}],p={toc:o};function c(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,a.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / TxType"),(0,i.kt)("h1",{id:"enumeration-txtype"},"Enumeration: TxType"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#add_delegate_for_account"},"ADD","_","DELEGATE","_","FOR","_","ACCOUNT")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#add_keykeeper"},"ADD","_","KEYKEEPER")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#add_oracle"},"ADD","_","ORACLE")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#add_process_keys"},"ADD","_","PROCESS","_","KEYS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#add_validator"},"ADD","_","VALIDATOR")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#collect_faucet"},"COLLECT","_","FAUCET")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#create_account"},"CREATE","_","ACCOUNT")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#delete_keykeeper"},"DELETE","_","KEYKEEPER")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#del_delegate_for_account"},"DEL","_","DELEGATE","_","FOR","_","ACCOUNT")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#mint_tokens"},"MINT","_","TOKENS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#new_process"},"NEW","_","PROCESS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#register_voter_key"},"REGISTER","_","VOTER","_","KEY")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#remove_oracle"},"REMOVE","_","ORACLE")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#remove_validator"},"REMOVE","_","VALIDATOR")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#reveal_process_keys"},"REVEAL","_","PROCESS","_","KEYS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#send_tokens"},"SEND","_","TOKENS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#set_account_info_uri"},"SET","_","ACCOUNT","_","INFO","_","URI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#set_process_census"},"SET","_","PROCESS","_","CENSUS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#set_process_question_index"},"SET","_","PROCESS","_","QUESTION","_","INDEX")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#set_process_results"},"SET","_","PROCESS","_","RESULTS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#set_process_status"},"SET","_","PROCESS","_","STATUS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#set_transaction_costs"},"SET","_","TRANSACTION","_","COSTS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#tx_unknown"},"TX","_","UNKNOWN")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#unrecognized"},"UNRECOGNIZED")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#vote"},"VOTE"))),(0,i.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,i.kt)("h3",{id:"add_delegate_for_account"},"ADD","_","DELEGATE","_","FOR","_","ACCOUNT"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ADD","_","DELEGATE","_","FOR","_","ACCOUNT")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"18")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L331"},"api/chain/transactions.ts:331")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"add_keykeeper"},"ADD","_","KEYKEEPER"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ADD","_","KEYKEEPER")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"21")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L334"},"api/chain/transactions.ts:334")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"add_oracle"},"ADD","_","ORACLE"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ADD","_","ORACLE")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"7")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L320"},"api/chain/transactions.ts:320")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"add_process_keys"},"ADD","_","PROCESS","_","KEYS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ADD","_","PROCESS","_","KEYS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"5")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L318"},"api/chain/transactions.ts:318")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"add_validator"},"ADD","_","VALIDATOR"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ADD","_","VALIDATOR")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"9")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L322"},"api/chain/transactions.ts:322")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"collect_faucet"},"COLLECT","_","FAUCET"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"COLLECT","_","FAUCET")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"20")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L333"},"api/chain/transactions.ts:333")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"create_account"},"CREATE","_","ACCOUNT"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"CREATE","_","ACCOUNT")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"23")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L336"},"api/chain/transactions.ts:336")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"delete_keykeeper"},"DELETE","_","KEYKEEPER"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"DELETE","_","KEYKEEPER")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"22")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L335"},"api/chain/transactions.ts:335")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"del_delegate_for_account"},"DEL","_","DELEGATE","_","FOR","_","ACCOUNT"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"DEL","_","DELEGATE","_","FOR","_","ACCOUNT")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"19")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L332"},"api/chain/transactions.ts:332")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"mint_tokens"},"MINT","_","TOKENS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"MINT","_","TOKENS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"14")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L327"},"api/chain/transactions.ts:327")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"new_process"},"NEW","_","PROCESS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"NEW","_","PROCESS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"1")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L314"},"api/chain/transactions.ts:314")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"register_voter_key"},"REGISTER","_","VOTER","_","KEY"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"REGISTER","_","VOTER","_","KEY")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"13")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L326"},"api/chain/transactions.ts:326")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"remove_oracle"},"REMOVE","_","ORACLE"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"REMOVE","_","ORACLE")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"8")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L321"},"api/chain/transactions.ts:321")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"remove_validator"},"REMOVE","_","VALIDATOR"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"REMOVE","_","VALIDATOR")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"10")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L323"},"api/chain/transactions.ts:323")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"reveal_process_keys"},"REVEAL","_","PROCESS","_","KEYS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"REVEAL","_","PROCESS","_","KEYS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"6")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L319"},"api/chain/transactions.ts:319")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"send_tokens"},"SEND","_","TOKENS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SEND","_","TOKENS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"15")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L328"},"api/chain/transactions.ts:328")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"set_account_info_uri"},"SET","_","ACCOUNT","_","INFO","_","URI"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SET","_","ACCOUNT","_","INFO","_","URI")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"17")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L330"},"api/chain/transactions.ts:330")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"set_process_census"},"SET","_","PROCESS","_","CENSUS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SET","_","PROCESS","_","CENSUS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"3")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L316"},"api/chain/transactions.ts:316")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"set_process_question_index"},"SET","_","PROCESS","_","QUESTION","_","INDEX"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SET","_","PROCESS","_","QUESTION","_","INDEX")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"4")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L317"},"api/chain/transactions.ts:317")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"set_process_results"},"SET","_","PROCESS","_","RESULTS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SET","_","PROCESS","_","RESULTS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"12")),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L325"},"api/chain/transactions.ts:325")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"set_process_status"},"SET","_","PROCESS","_","STATUS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SET","_","PROCESS","_","STATUS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"2")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L315"},"api/chain/transactions.ts:315")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"set_transaction_costs"},"SET","_","TRANSACTION","_","COSTS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SET","_","TRANSACTION","_","COSTS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"16")),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L329"},"api/chain/transactions.ts:329")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tx_unknown"},"TX","_","UNKNOWN"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"TX","_","UNKNOWN")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"0")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L313"},"api/chain/transactions.ts:313")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"unrecognized"},"UNRECOGNIZED"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"UNRECOGNIZED")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"-1")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L337"},"api/chain/transactions.ts:337")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"vote"},"VOTE"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"VOTE")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"11")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L324"},"api/chain/transactions.ts:324")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4adb919a.a773e70d.js b/assets/js/4adb919a.a773e70d.js new file mode 100644 index 000000000..5a99426ea --- /dev/null +++ b/assets/js/4adb919a.a773e70d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8033],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>u});var a=t(67294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function l(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var d=a.createContext({}),o=function(e){var n=a.useContext(d),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},p=function(e){var n=o(e.components);return a.createElement(d.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},k=a.forwardRef((function(e,n){var t=e.components,i=e.mdxType,r=e.originalType,d=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),k=o(t),u=i,_=k["".concat(d,".").concat(u)]||k[u]||c[u]||r;return t?a.createElement(_,l(l({ref:n},p),{},{components:t})):a.createElement(_,l({ref:n},p))}));function u(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var r=t.length,l=new Array(r);l[0]=k;var s={};for(var d in n)hasOwnProperty.call(n,d)&&(s[d]=n[d]);s.originalType=e,s.mdxType="string"==typeof e?e:i,l[1]=s;for(var o=2;o{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>r,metadata:()=>s,toc:()=>o});var a=t(87462),i=(t(67294),t(3905));const r={},l=void 0,s={unversionedId:"sdk/reference/enums/TxType",id:"sdk/reference/enums/TxType",title:"TxType",description:"@vocdoni/sdk / Exports / TxType",source:"@site/docs/sdk/reference/enums/TxType.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/TxType",permalink:"/sdk/reference/enums/TxType",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"TransactionType",permalink:"/sdk/reference/enums/TransactionType"},next:{title:"VoteSteps",permalink:"/sdk/reference/enums/VoteSteps"}},d={},o=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"ADD_DELEGATE_FOR_ACCOUNT",id:"add_delegate_for_account",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ADD_KEYKEEPER",id:"add_keykeeper",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ADD_ORACLE",id:"add_oracle",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"ADD_PROCESS_KEYS",id:"add_process_keys",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"ADD_VALIDATOR",id:"add_validator",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"COLLECT_FAUCET",id:"collect_faucet",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"CREATE_ACCOUNT",id:"create_account",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"DELETE_KEYKEEPER",id:"delete_keykeeper",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"DEL_DELEGATE_FOR_ACCOUNT",id:"del_delegate_for_account",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"MINT_TOKENS",id:"mint_tokens",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"NEW_PROCESS",id:"new_process",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"REGISTER_VOTER_KEY",id:"register_voter_key",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"REMOVE_ORACLE",id:"remove_oracle",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"REMOVE_VALIDATOR",id:"remove_validator",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"REVEAL_PROCESS_KEYS",id:"reveal_process_keys",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"SEND_TOKENS",id:"send_tokens",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"SET_ACCOUNT_INFO_URI",id:"set_account_info_uri",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"SET_PROCESS_CENSUS",id:"set_process_census",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"SET_PROCESS_QUESTION_INDEX",id:"set_process_question_index",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"SET_PROCESS_RESULTS",id:"set_process_results",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"SET_PROCESS_STATUS",id:"set_process_status",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"SET_TRANSACTION_COSTS",id:"set_transaction_costs",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"TX_UNKNOWN",id:"tx_unknown",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"UNRECOGNIZED",id:"unrecognized",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"VOTE",id:"vote",level:3},{value:"Defined in",id:"defined-in-24",level:4}],p={toc:o};function c(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,a.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / TxType"),(0,i.kt)("h1",{id:"enumeration-txtype"},"Enumeration: TxType"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#add_delegate_for_account"},"ADD","_","DELEGATE","_","FOR","_","ACCOUNT")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#add_keykeeper"},"ADD","_","KEYKEEPER")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#add_oracle"},"ADD","_","ORACLE")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#add_process_keys"},"ADD","_","PROCESS","_","KEYS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#add_validator"},"ADD","_","VALIDATOR")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#collect_faucet"},"COLLECT","_","FAUCET")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#create_account"},"CREATE","_","ACCOUNT")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#delete_keykeeper"},"DELETE","_","KEYKEEPER")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#del_delegate_for_account"},"DEL","_","DELEGATE","_","FOR","_","ACCOUNT")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#mint_tokens"},"MINT","_","TOKENS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#new_process"},"NEW","_","PROCESS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#register_voter_key"},"REGISTER","_","VOTER","_","KEY")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#remove_oracle"},"REMOVE","_","ORACLE")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#remove_validator"},"REMOVE","_","VALIDATOR")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#reveal_process_keys"},"REVEAL","_","PROCESS","_","KEYS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#send_tokens"},"SEND","_","TOKENS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#set_account_info_uri"},"SET","_","ACCOUNT","_","INFO","_","URI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#set_process_census"},"SET","_","PROCESS","_","CENSUS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#set_process_question_index"},"SET","_","PROCESS","_","QUESTION","_","INDEX")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#set_process_results"},"SET","_","PROCESS","_","RESULTS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#set_process_status"},"SET","_","PROCESS","_","STATUS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#set_transaction_costs"},"SET","_","TRANSACTION","_","COSTS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType#tx_unknown"},"TX","_","UNKNOWN")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"TxType#unrecognized"},"UNRECOGNIZED")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"TxType#vote"},"VOTE"))),(0,i.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,i.kt)("h3",{id:"add_delegate_for_account"},"ADD","_","DELEGATE","_","FOR","_","ACCOUNT"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ADD","_","DELEGATE","_","FOR","_","ACCOUNT")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"18")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L331"},"api/chain/transactions.ts:331")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"add_keykeeper"},"ADD","_","KEYKEEPER"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ADD","_","KEYKEEPER")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"21")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L334"},"api/chain/transactions.ts:334")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"add_oracle"},"ADD","_","ORACLE"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ADD","_","ORACLE")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"7")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L320"},"api/chain/transactions.ts:320")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"add_process_keys"},"ADD","_","PROCESS","_","KEYS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ADD","_","PROCESS","_","KEYS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"5")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L318"},"api/chain/transactions.ts:318")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"add_validator"},"ADD","_","VALIDATOR"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ADD","_","VALIDATOR")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"9")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L322"},"api/chain/transactions.ts:322")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"collect_faucet"},"COLLECT","_","FAUCET"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"COLLECT","_","FAUCET")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"20")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L333"},"api/chain/transactions.ts:333")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"create_account"},"CREATE","_","ACCOUNT"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"CREATE","_","ACCOUNT")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"23")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L336"},"api/chain/transactions.ts:336")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"delete_keykeeper"},"DELETE","_","KEYKEEPER"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"DELETE","_","KEYKEEPER")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"22")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L335"},"api/chain/transactions.ts:335")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"del_delegate_for_account"},"DEL","_","DELEGATE","_","FOR","_","ACCOUNT"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"DEL","_","DELEGATE","_","FOR","_","ACCOUNT")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"19")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L332"},"api/chain/transactions.ts:332")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"mint_tokens"},"MINT","_","TOKENS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"MINT","_","TOKENS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"14")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L327"},"api/chain/transactions.ts:327")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"new_process"},"NEW","_","PROCESS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"NEW","_","PROCESS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"1")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L314"},"api/chain/transactions.ts:314")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"register_voter_key"},"REGISTER","_","VOTER","_","KEY"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"REGISTER","_","VOTER","_","KEY")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"13")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L326"},"api/chain/transactions.ts:326")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"remove_oracle"},"REMOVE","_","ORACLE"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"REMOVE","_","ORACLE")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"8")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L321"},"api/chain/transactions.ts:321")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"remove_validator"},"REMOVE","_","VALIDATOR"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"REMOVE","_","VALIDATOR")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"10")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L323"},"api/chain/transactions.ts:323")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"reveal_process_keys"},"REVEAL","_","PROCESS","_","KEYS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"REVEAL","_","PROCESS","_","KEYS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"6")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L319"},"api/chain/transactions.ts:319")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"send_tokens"},"SEND","_","TOKENS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SEND","_","TOKENS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"15")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L328"},"api/chain/transactions.ts:328")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"set_account_info_uri"},"SET","_","ACCOUNT","_","INFO","_","URI"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SET","_","ACCOUNT","_","INFO","_","URI")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"17")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L330"},"api/chain/transactions.ts:330")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"set_process_census"},"SET","_","PROCESS","_","CENSUS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SET","_","PROCESS","_","CENSUS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"3")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L316"},"api/chain/transactions.ts:316")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"set_process_question_index"},"SET","_","PROCESS","_","QUESTION","_","INDEX"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SET","_","PROCESS","_","QUESTION","_","INDEX")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"4")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L317"},"api/chain/transactions.ts:317")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"set_process_results"},"SET","_","PROCESS","_","RESULTS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SET","_","PROCESS","_","RESULTS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"12")),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L325"},"api/chain/transactions.ts:325")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"set_process_status"},"SET","_","PROCESS","_","STATUS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SET","_","PROCESS","_","STATUS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"2")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L315"},"api/chain/transactions.ts:315")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"set_transaction_costs"},"SET","_","TRANSACTION","_","COSTS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SET","_","TRANSACTION","_","COSTS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"16")),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L329"},"api/chain/transactions.ts:329")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tx_unknown"},"TX","_","UNKNOWN"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"TX","_","UNKNOWN")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"0")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L313"},"api/chain/transactions.ts:313")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"unrecognized"},"UNRECOGNIZED"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"UNRECOGNIZED")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"-1")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L337"},"api/chain/transactions.ts:337")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"vote"},"VOTE"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"VOTE")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"11")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L324"},"api/chain/transactions.ts:324")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4b742bf9.35ad00c1.js b/assets/js/4b742bf9.35ad00c1.js deleted file mode 100644 index 641ab5df4..000000000 --- a/assets/js/4b742bf9.35ad00c1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5882],{3905:(e,n,t)=>{t.d(n,{Zo:()=>s,kt:()=>k});var r=t(67294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var p=r.createContext({}),c=function(e){var n=r.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},s=function(e){var n=c(e.components);return r.createElement(p.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},f=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,a=e.originalType,p=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),f=c(t),k=i,u=f["".concat(p,".").concat(k)]||f[k]||d[k]||a;return t?r.createElement(u,o(o({ref:n},s),{},{components:t})):r.createElement(u,o({ref:n},s))}));function k(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var a=t.length,o=new Array(a);o[0]=f;var l={};for(var p in n)hasOwnProperty.call(n,p)&&(l[p]=n[p]);l.originalType=e,l.mdxType="string"==typeof e?e:i,o[1]=l;for(var c=2;c{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var r=t(87462),i=(t(67294),t(3905));const a={},o=void 0,l={unversionedId:"sdk/reference/interfaces/VoteEnvelope",id:"sdk/reference/interfaces/VoteEnvelope",title:"VoteEnvelope",description:"@vocdoni/sdk / Exports / VoteEnvelope",source:"@site/docs/sdk/reference/interfaces/VoteEnvelope.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/VoteEnvelope",permalink:"/sdk/reference/interfaces/VoteEnvelope",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Tx",permalink:"/sdk/reference/interfaces/Tx"},next:{title:"modules",permalink:"/sdk/reference/modules"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"encryptionKeyIndexes",id:"encryptionkeyindexes",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"nullifier",id:"nullifier",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"processId",id:"processid",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"proof",id:"proof",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"votePackage",id:"votepackage",level:3},{value:"Defined in",id:"defined-in-5",level:4}],s={toc:c};function d(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},s,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / VoteEnvelope"),(0,i.kt)("h1",{id:"interface-voteenvelope"},"Interface: VoteEnvelope"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/VoteEnvelope#encryptionkeyindexes"},"encryptionKeyIndexes")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/VoteEnvelope#nonce"},"nonce")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/VoteEnvelope#nullifier"},"nullifier")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/VoteEnvelope#processid"},"processId")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/VoteEnvelope#proof"},"proof")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/VoteEnvelope#votepackage"},"votePackage"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"encryptionkeyindexes"},"encryptionKeyIndexes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"encryptionKeyIndexes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,i.kt)("p",null,"On encrypted votes, contains the (sorted) indexes of the keys used to encrypt"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L80"},"api/chain/transactions.ts:80")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"nonce"},"nonce"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"nonce"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Unique number per vote attempt, so that replay attacks can't reuse this payload"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L60"},"api/chain/transactions.ts:60")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"nullifier"},"nullifier"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"nullifier"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Hash of the private key + processId"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L76"},"api/chain/transactions.ts:76")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"processid"},"processId"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"processId"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The process for which the vote is casted"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L64"},"api/chain/transactions.ts:64")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"proof"},"proof"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"proof"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/Proof"},(0,i.kt)("inlineCode",{parentName:"a"},"Proof"))),(0,i.kt)("p",null,"Franchise proof"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L68"},"api/chain/transactions.ts:68")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votepackage"},"votePackage"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"votePackage"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"JSON string of the Vote Package (potentially encrypted), encoded as bytes."),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L72"},"api/chain/transactions.ts:72")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4b742bf9.c32488ef.js b/assets/js/4b742bf9.c32488ef.js new file mode 100644 index 000000000..ec2b90644 --- /dev/null +++ b/assets/js/4b742bf9.c32488ef.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5882],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var p=r.createContext({}),c=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},s=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,p=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),f=c(n),u=i,k=f["".concat(p,".").concat(u)]||f[u]||d[u]||o;return n?r.createElement(k,a(a({ref:t},s),{},{components:n})):r.createElement(k,a({ref:t},s))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,a=new Array(o);a[0]=f;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:i,a[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var r=n(87462),i=(n(67294),n(3905));const o={},a=void 0,l={unversionedId:"sdk/reference/interfaces/VoteEnvelope",id:"sdk/reference/interfaces/VoteEnvelope",title:"VoteEnvelope",description:"@vocdoni/sdk / Exports / VoteEnvelope",source:"@site/docs/sdk/reference/interfaces/VoteEnvelope.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/VoteEnvelope",permalink:"/sdk/reference/interfaces/VoteEnvelope",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Tx",permalink:"/sdk/reference/interfaces/Tx"},next:{title:"modules",permalink:"/sdk/reference/modules"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"encryptionKeyIndexes",id:"encryptionkeyindexes",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"nullifier",id:"nullifier",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"processId",id:"processid",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"proof",id:"proof",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"votePackage",id:"votepackage",level:3},{value:"Defined in",id:"defined-in-5",level:4}],s={toc:c};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / VoteEnvelope"),(0,i.kt)("h1",{id:"interface-voteenvelope"},"Interface: VoteEnvelope"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VoteEnvelope#encryptionkeyindexes"},"encryptionKeyIndexes")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VoteEnvelope#nonce"},"nonce")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VoteEnvelope#nullifier"},"nullifier")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VoteEnvelope#processid"},"processId")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VoteEnvelope#proof"},"proof")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VoteEnvelope#votepackage"},"votePackage"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"encryptionkeyindexes"},"encryptionKeyIndexes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"encryptionKeyIndexes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,i.kt)("p",null,"On encrypted votes, contains the (sorted) indexes of the keys used to encrypt"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L80"},"api/chain/transactions.ts:80")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"nonce"},"nonce"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"nonce"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Unique number per vote attempt, so that replay attacks can't reuse this payload"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L60"},"api/chain/transactions.ts:60")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"nullifier"},"nullifier"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"nullifier"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Hash of the private key + processId"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L76"},"api/chain/transactions.ts:76")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"processid"},"processId"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"processId"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The process for which the vote is casted"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L64"},"api/chain/transactions.ts:64")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"proof"},"proof"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"proof"),": ",(0,i.kt)("a",{parentName:"p",href:"Proof"},(0,i.kt)("inlineCode",{parentName:"a"},"Proof"))),(0,i.kt)("p",null,"Franchise proof"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L68"},"api/chain/transactions.ts:68")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votepackage"},"votePackage"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"votePackage"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"JSON string of the Vote Package (potentially encrypted), encoded as bytes."),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L72"},"api/chain/transactions.ts:72")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4bef2fb3.f10ecef1.js b/assets/js/4bef2fb3.f10ecef1.js new file mode 100644 index 000000000..a1258e6ae --- /dev/null +++ b/assets/js/4bef2fb3.f10ecef1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5277],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>f});var i=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function a(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var p=i.createContext({}),d=function(e){var t=i.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},s=function(e){var t=d(e.components);return i.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,p=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),k=d(n),f=o,u=k["".concat(p,".").concat(f)]||k[f]||c[f]||r;return n?i.createElement(u,a(a({ref:t},s),{},{components:n})):i.createElement(u,a({ref:t},s))}));function f(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,a=new Array(r);a[0]=k;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:o,a[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>a,default:()=>c,frontMatter:()=>r,metadata:()=>l,toc:()=>d});var i=n(87462),o=(n(67294),n(3905));const r={},a=void 0,l={unversionedId:"sdk/reference/interfaces/IVoteInfoResponse",id:"sdk/reference/interfaces/IVoteInfoResponse",title:"IVoteInfoResponse",description:"@vocdoni/sdk / Exports / IVoteInfoResponse",source:"@site/docs/sdk/reference/interfaces/IVoteInfoResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IVoteInfoResponse",permalink:"/sdk/reference/interfaces/IVoteInfoResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ITallyMode",permalink:"/sdk/reference/interfaces/ITallyMode"},next:{title:"IVoteMode",permalink:"/sdk/reference/interfaces/IVoteMode"}},p={},d=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"blockHeight",id:"blockheight",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"date",id:"date",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"electionID",id:"electionid",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"encryptionKeys",id:"encryptionkeys",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"overwriteCount",id:"overwritecount",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"package",id:"package",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"transactionIndex",id:"transactionindex",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"txHash",id:"txhash",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"voteID",id:"voteid",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"weight",id:"weight",level:3},{value:"Defined in",id:"defined-in-9",level:4}],s={toc:d};function c(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,i.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IVoteInfoResponse"),(0,o.kt)("h1",{id:"interface-ivoteinforesponse"},"Interface: IVoteInfoResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteInfoResponse#blockheight"},"blockHeight")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteInfoResponse#date"},"date")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteInfoResponse#electionid"},"electionID")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteInfoResponse#encryptionkeys"},"encryptionKeys")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteInfoResponse#overwritecount"},"overwriteCount")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteInfoResponse#package"},"package")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteInfoResponse#transactionindex"},"transactionIndex")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteInfoResponse#txhash"},"txHash")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteInfoResponse#voteid"},"voteID")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteInfoResponse#weight"},"weight"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"blockheight"},"blockHeight"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"blockHeight"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"The block number where the transaction is mined."),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/vote.ts#L56"},"api/vote.ts:56")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"date"},"date"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"date"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"Date when the vote was emitted"),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/vote.ts#L71"},"api/vote.ts:71")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"electionid"},"electionID"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"electionID"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The identifier of the election."),(0,o.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/vote.ts#L51"},"api/vote.ts:51")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"encryptionkeys"},"encryptionKeys"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"encryptionKeys"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,o.kt)("p",null,"Encryption key indexes used"),(0,o.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/vote.ts#L36"},"api/vote.ts:36")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"overwritecount"},"overwriteCount"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"overwriteCount"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"The number of votes overwrites."),(0,o.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/vote.ts#L66"},"api/vote.ts:66")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"package"},"package"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"package"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The stringified vote package JSON."),(0,o.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/vote.ts#L41"},"api/vote.ts:41")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"transactionindex"},"transactionIndex"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"transactionIndex"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"The index inside the block where the transaction is mined."),(0,o.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/vote.ts#L61"},"api/vote.ts:61")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"txhash"},"txHash"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"txHash"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The hash of the transaction"),(0,o.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/vote.ts#L26"},"api/vote.ts:26")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"voteid"},"voteID"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"voteID"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The identifier of the vote, also called nullifier."),(0,o.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/vote.ts#L31"},"api/vote.ts:31")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"weight"},"weight"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"weight"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The weight of the vote."),(0,o.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/vote.ts#L46"},"api/vote.ts:46")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4bef2fb3.f3696914.js b/assets/js/4bef2fb3.f3696914.js deleted file mode 100644 index 76e10b2c0..000000000 --- a/assets/js/4bef2fb3.f3696914.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5277],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var i=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function a(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=i.createContext({}),s=function(e){var t=i.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},d=function(e){var t=s(e.components);return i.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},f=i.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),f=s(n),k=r,u=f["".concat(p,".").concat(k)]||f[k]||c[k]||o;return n?i.createElement(u,a(a({ref:t},d),{},{components:n})):i.createElement(u,a({ref:t},d))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,a=new Array(o);a[0]=f;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:r,a[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>a,default:()=>c,frontMatter:()=>o,metadata:()=>l,toc:()=>s});var i=n(87462),r=(n(67294),n(3905));const o={},a=void 0,l={unversionedId:"sdk/reference/interfaces/IVoteInfoResponse",id:"sdk/reference/interfaces/IVoteInfoResponse",title:"IVoteInfoResponse",description:"@vocdoni/sdk / Exports / IVoteInfoResponse",source:"@site/docs/sdk/reference/interfaces/IVoteInfoResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IVoteInfoResponse",permalink:"/sdk/reference/interfaces/IVoteInfoResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ITallyMode",permalink:"/sdk/reference/interfaces/ITallyMode"},next:{title:"IVoteMode",permalink:"/sdk/reference/interfaces/IVoteMode"}},p={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"blockHeight",id:"blockheight",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"date",id:"date",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"electionID",id:"electionid",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"encryptionKeys",id:"encryptionkeys",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"overwriteCount",id:"overwritecount",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"package",id:"package",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"transactionIndex",id:"transactionindex",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"txHash",id:"txhash",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"voteID",id:"voteid",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"weight",id:"weight",level:3},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:s};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,i.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IVoteInfoResponse"),(0,r.kt)("h1",{id:"interface-ivoteinforesponse"},"Interface: IVoteInfoResponse"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteInfoResponse#blockheight"},"blockHeight")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteInfoResponse#date"},"date")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteInfoResponse#electionid"},"electionID")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteInfoResponse#encryptionkeys"},"encryptionKeys")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteInfoResponse#overwritecount"},"overwriteCount")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteInfoResponse#package"},"package")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteInfoResponse#transactionindex"},"transactionIndex")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteInfoResponse#txhash"},"txHash")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteInfoResponse#voteid"},"voteID")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteInfoResponse#weight"},"weight"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"blockheight"},"blockHeight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"blockHeight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The block number where the transaction is mined."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/vote.ts#L56"},"api/vote.ts:56")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"date"},"date"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"date"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Date when the vote was emitted"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/vote.ts#L71"},"api/vote.ts:71")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electionid"},"electionID"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"electionID"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The identifier of the election."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/vote.ts#L51"},"api/vote.ts:51")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"encryptionkeys"},"encryptionKeys"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"encryptionKeys"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Encryption key indexes used"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/vote.ts#L36"},"api/vote.ts:36")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"overwritecount"},"overwriteCount"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"overwriteCount"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The number of votes overwrites."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/vote.ts#L66"},"api/vote.ts:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"package"},"package"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"package"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The stringified vote package JSON."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/vote.ts#L41"},"api/vote.ts:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"transactionindex"},"transactionIndex"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"transactionIndex"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The index inside the block where the transaction is mined."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/vote.ts#L61"},"api/vote.ts:61")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"txhash"},"txHash"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"txHash"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The hash of the transaction"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/vote.ts#L26"},"api/vote.ts:26")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"voteid"},"voteID"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"voteID"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The identifier of the vote, also called nullifier."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/vote.ts#L31"},"api/vote.ts:31")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"weight"},"weight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"weight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The weight of the vote."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/vote.ts#L46"},"api/vote.ts:46")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4d61d27d.e1f5666a.js b/assets/js/4d61d27d.1df7540a.js similarity index 82% rename from assets/js/4d61d27d.e1f5666a.js rename to assets/js/4d61d27d.1df7540a.js index 88fc691a7..2133a514f 100644 --- a/assets/js/4d61d27d.e1f5666a.js +++ b/assets/js/4d61d27d.1df7540a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4253],{3905:(e,n,r)=>{r.d(n,{Zo:()=>u,kt:()=>d});var t=r(67294);function s(e,n,r){return n in e?Object.defineProperty(e,n,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[n]=r,e}function o(e,n){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(e);n&&(t=t.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),r.push.apply(r,t)}return r}function i(e){for(var n=1;n=0||(s[r]=e[r]);return s}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(s[r]=e[r])}return s}var p=t.createContext({}),c=function(e){var n=t.useContext(p),r=n;return e&&(r="function"==typeof e?e(n):i(i({},n),e)),r},u=function(e){var n=c(e.components);return t.createElement(p.Provider,{value:n},e.children)},l={inlineCode:"code",wrapper:function(e){var n=e.children;return t.createElement(t.Fragment,{},n)}},f=t.forwardRef((function(e,n){var r=e.components,s=e.mdxType,o=e.originalType,p=e.parentName,u=a(e,["components","mdxType","originalType","parentName"]),f=c(r),d=s,v=f["".concat(p,".").concat(d)]||f[d]||l[d]||o;return r?t.createElement(v,i(i({ref:n},u),{},{components:r})):t.createElement(v,i({ref:n},u))}));function d(e,n){var r=arguments,s=n&&n.mdxType;if("string"==typeof e||s){var o=r.length,i=new Array(o);i[0]=f;var a={};for(var p in n)hasOwnProperty.call(n,p)&&(a[p]=n[p]);a.originalType=e,a.mdxType="string"==typeof e?e:s,i[1]=a;for(var c=2;c{r.r(n),r.d(n,{assets:()=>p,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var t=r(87462),s=(r(67294),r(3905));const o={},i=void 0,a={unversionedId:"sdk/reference/interfaces/ICensus3ServiceInfoResponse",id:"sdk/reference/interfaces/ICensus3ServiceInfoResponse",title:"ICensus3ServiceInfoResponse",description:"@vocdoni/sdk / Exports / ICensus3ServiceInfoResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3ServiceInfoResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3ServiceInfoResponse",permalink:"/sdk/reference/interfaces/ICensus3ServiceInfoResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3CensusResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusResponse"},next:{title:"ICensus3StrategiesListResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategiesListResponse"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"supportedChains",id:"supportedchains",level:3},{value:"Defined in",id:"defined-in",level:4}],u={toc:c};function l(e){let{components:n,...r}=e;return(0,s.kt)("wrapper",(0,t.Z)({},u,r,{components:n,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3ServiceInfoResponse"),(0,s.kt)("h1",{id:"interface-icensus3serviceinforesponse"},"Interface: ICensus3ServiceInfoResponse"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3ServiceInfoResponse#supportedchains"},"supportedChains"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"supportedchains"},"supportedChains"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"supportedChains"),": ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3SupportedChain"},(0,s.kt)("inlineCode",{parentName:"a"},"ICensus3SupportedChain")),"[]"),(0,s.kt)("p",null,"The list of supported chains"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/service.ts#L29"},"api/census3/service.ts:29")))}l.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4253],{3905:(e,n,r)=>{r.d(n,{Zo:()=>u,kt:()=>d});var t=r(67294);function s(e,n,r){return n in e?Object.defineProperty(e,n,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[n]=r,e}function o(e,n){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(e);n&&(t=t.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),r.push.apply(r,t)}return r}function i(e){for(var n=1;n=0||(s[r]=e[r]);return s}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(s[r]=e[r])}return s}var p=t.createContext({}),c=function(e){var n=t.useContext(p),r=n;return e&&(r="function"==typeof e?e(n):i(i({},n),e)),r},u=function(e){var n=c(e.components);return t.createElement(p.Provider,{value:n},e.children)},l={inlineCode:"code",wrapper:function(e){var n=e.children;return t.createElement(t.Fragment,{},n)}},f=t.forwardRef((function(e,n){var r=e.components,s=e.mdxType,o=e.originalType,p=e.parentName,u=a(e,["components","mdxType","originalType","parentName"]),f=c(r),d=s,v=f["".concat(p,".").concat(d)]||f[d]||l[d]||o;return r?t.createElement(v,i(i({ref:n},u),{},{components:r})):t.createElement(v,i({ref:n},u))}));function d(e,n){var r=arguments,s=n&&n.mdxType;if("string"==typeof e||s){var o=r.length,i=new Array(o);i[0]=f;var a={};for(var p in n)hasOwnProperty.call(n,p)&&(a[p]=n[p]);a.originalType=e,a.mdxType="string"==typeof e?e:s,i[1]=a;for(var c=2;c{r.r(n),r.d(n,{assets:()=>p,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var t=r(87462),s=(r(67294),r(3905));const o={},i=void 0,a={unversionedId:"sdk/reference/interfaces/ICensus3ServiceInfoResponse",id:"sdk/reference/interfaces/ICensus3ServiceInfoResponse",title:"ICensus3ServiceInfoResponse",description:"@vocdoni/sdk / Exports / ICensus3ServiceInfoResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3ServiceInfoResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3ServiceInfoResponse",permalink:"/sdk/reference/interfaces/ICensus3ServiceInfoResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3CensusResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusResponse"},next:{title:"ICensus3StrategiesListResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategiesListResponse"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"supportedChains",id:"supportedchains",level:3},{value:"Defined in",id:"defined-in",level:4}],u={toc:c};function l(e){let{components:n,...r}=e;return(0,s.kt)("wrapper",(0,t.Z)({},u,r,{components:n,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3ServiceInfoResponse"),(0,s.kt)("h1",{id:"interface-icensus3serviceinforesponse"},"Interface: ICensus3ServiceInfoResponse"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus3ServiceInfoResponse#supportedchains"},"supportedChains"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"supportedchains"},"supportedChains"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"supportedChains"),": ",(0,s.kt)("a",{parentName:"p",href:"ICensus3SupportedChain"},(0,s.kt)("inlineCode",{parentName:"a"},"ICensus3SupportedChain")),"[]"),(0,s.kt)("p",null,"The list of supported chains"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/service.ts#L29"},"api/census3/service.ts:29")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4f61726b.87a165f1.js b/assets/js/4f61726b.87a165f1.js new file mode 100644 index 000000000..01baf2c94 --- /dev/null +++ b/assets/js/4f61726b.87a165f1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8882],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var o=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function r(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var c=o.createContext({}),l=function(e){var t=o.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},u=function(e){var t=l(e.components);return o.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},p=o.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,c=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),p=l(n),m=a,h=p["".concat(c,".").concat(m)]||p[m]||d[m]||i;return n?o.createElement(h,r(r({ref:t},u),{},{components:n})):o.createElement(h,r({ref:t},u))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,r=new Array(i);r[0]=p;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s.mdxType="string"==typeof e?e:a,r[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var o=n(87462),a=(n(67294),n(3905));const i={},r="Vocdoni Tokens",s={unversionedId:"sdk/integration-details/vocdoni-tokens",id:"sdk/integration-details/vocdoni-tokens",title:"Vocdoni Tokens",description:'Behind-the-scenes, Vocdoni is powered by a custom blockchain. This component provides universal verifiability, but it also introduces some complexity. In order to distribute workload and verify transactions, our blockchain uses a digital "currency" of Vocdoni tokens that have no real-world value but help with load-balancing and spam reduction. Actions that update data on the blockchain, such as creating an election, incur a "cost." Integrators are responsible for ensuring that accounts creating elections have a sufficient balance of tokens.',source:"@site/docs/sdk/integration-details/vocdoni-tokens.md",sourceDirName:"sdk/integration-details",slug:"/sdk/integration-details/vocdoni-tokens",permalink:"/sdk/integration-details/vocdoni-tokens",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Complex Census",permalink:"/sdk/integration-details/census-types/on-chain/complex-census"},next:{title:"Voting Types",permalink:"/sdk/integration-details/voting-types/"}},c={},l=[{value:"Initial Tokens",id:"initial-tokens",level:2},{value:"Checking Token Balance",id:"checking-token-balance",level:2},{value:"Election Cost",id:"election-cost",level:3},{value:"Requesting Tokens: The Faucet",id:"requesting-tokens-the-faucet",level:2},{value:"DEV & STG",id:"dev--stg",level:3},{value:"PROD",id:"prod",level:3}],u={toc:l};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,o.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"vocdoni-tokens"},"Vocdoni Tokens"),(0,a.kt)("p",null,"Behind-the-scenes, Vocdoni is powered by a custom ",(0,a.kt)("a",{parentName:"p",href:"/protocol#11-the-blockchain"},"blockchain"),'. This component provides universal verifiability, but it also introduces some complexity. In order to distribute workload and verify transactions, our blockchain uses a digital "currency" of Vocdoni tokens that have no real-world value but help with load-balancing and spam reduction. Actions that update data on the blockchain, such as creating an election, incur a "cost." Integrators are responsible for ensuring that accounts creating elections have a sufficient balance of tokens.'),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"Casting a vote ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("em",{parentName:"strong"},"never"))," requires Vocdoni tokens.")),(0,a.kt)("h2",{id:"initial-tokens"},"Initial Tokens"),(0,a.kt)("p",null,"Because accounts cannot hold Vocdoni tokens before they are created, ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#createaccount"},(0,a.kt)("inlineCode",{parentName:"a"},"client.createAccount()"))," automatically requests tokens from the blockchain. In ",(0,a.kt)("strong",{parentName:"p"},"production environments"),", only enough tokens to create the account itself are provided. Moving forward, more tokens must be requested in order to create elections.\nIn ",(0,a.kt)("strong",{parentName:"p"},"non-production environments"),", a large amount of tokens is automatically supplied to accounts when they are created. You can create many elections in the ",(0,a.kt)("inlineCode",{parentName:"p"},"STG")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"DEV")," environments before worrying about maintaining a balance."),(0,a.kt)("h2",{id:"checking-token-balance"},"Checking Token Balance"),(0,a.kt)("p",null,"From this point on, you can check your account balance with ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#createaccount"},(0,a.kt)("inlineCode",{parentName:"a"},"client.createAccount()"))," or ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#fetchaccount"},(0,a.kt)("inlineCode",{parentName:"a"},"client.fetchAccountInfo()")),". This provides all the information associated with the account, including the balance."),(0,a.kt)("h3",{id:"election-cost"},"Election Cost"),(0,a.kt)("p",null,"The token cost of a voting process is not constant; it is determined by many factors. After creating an election, but before publishing it to the blockchain, you should get a sense of the cost of the operation in order to ensure your account has sufficient balance. There are two methods to do this: ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#estimateelectioncost"},(0,a.kt)("inlineCode",{parentName:"a"},"client.estimateElectionCost()"))," quickly provides a decent estimate of the cost and can be useful for writing UI components. ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#calculateelectioncost"},(0,a.kt)("inlineCode",{parentName:"a"},"client.calculateElectionCost()"))," makes a time-intensive API call but provides an exact figure. It is helpful to use this directly before publishing the election to ensure it can be published."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"const price = await client.estimateElectionCost(election); // Should be an UnpublishedElection with a maxCensusSize\nconsole.log(price); // shows the estimated price\n")),(0,a.kt)("admonition",{title:"estimate election cost",type:"note"},(0,a.kt)("p",{parentName:"admonition"},"In order to estimate the cost of an election quickly, the election must be created with a specified ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#maxcensussize"},(0,a.kt)("inlineCode",{parentName:"a"},"maxCensusSize")),". This restricts the number of users who can enter the census but enables quick election cost estimation. If you want an unlimited census size, just use ",(0,a.kt)("inlineCode",{parentName:"p"},"calculateElectionCost")," instead.")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"const electionCost = await client.calculateElectionCost(election);\nconst info = await client.createAccount();\nif (info.balance < electionCost) {\n console.log('Need to request more tokens');\n}\n")),(0,a.kt)("h2",{id:"requesting-tokens-the-faucet"},"Requesting Tokens: The Faucet"),(0,a.kt)("p",null,"The main way for users to gain tokens in a production environment is via a faucet, a free provider of tokens. A faucet enables users to generate a ",(0,a.kt)("inlineCode",{parentName:"p"},"faucetPackage"),". This package is essentially a set of instructions; it must still be sent to the blockchain in order to request the actual tokens."),(0,a.kt)("admonition",{title:"users & tokens",type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"Some systems require election administrators to request tokens manually for their elections. In other systems, integrators may handle token requests automatically on behalf of their users. This can be done manually or with a custom faucet implementation. ",(0,a.kt)("a",{parentName:"p",href:"https://chat.vocdoni.io"},"Reach out")," for help with this.")),(0,a.kt)("h3",{id:"dev--stg"},"DEV & STG"),(0,a.kt)("p",null,"In development and staging environments, the faucet functionality is handled automatically. Behind-the-scenes, ",(0,a.kt)("inlineCode",{parentName:"p"},"createAccount")," requests a large amount of tokens from a development faucet. These tokens should last a while, but once the account balance is low, more tokens must be requested. This can be done with "),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"await client.collectFaucetTokens();\n")),(0,a.kt)("p",null,"This method uses the default development faucet to generate a ",(0,a.kt)("inlineCode",{parentName:"p"},"faucetPackage")," requesting new tokens. It can be used any number of times. In development environments, this is all that needs to be done! "),(0,a.kt)("h3",{id:"prod"},"PROD"),(0,a.kt)("p",null,"Production environments require more hands-on generation of a ",(0,a.kt)("inlineCode",{parentName:"p"},"faucetPackage"),". First you need to identify the ",(0,a.kt)("strong",{parentName:"p"},"account address")," you are requesting tokens for. "),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"console.log((await client.fetchAccountInfo()).address);\n")),(0,a.kt)("p",null,"There are multiple ways to request a faucet package:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Use ",(0,a.kt)("a",{parentName:"li",href:"https://app.vocdoni.io/faucet"},"https://app.vocdoni.io/faucet"),", our web-based faucet that requires users to login with some form of existing account (google, github, social media). It provides a large amount of tokens to the given address but limits the number of times a single user can request tokens per week."),(0,a.kt)("li",{parentName:"ul"},"Reach out via ",(0,a.kt)("a",{parentName:"li",href:"https://chat.vocdoni.io"},"discord")," to request tokens sent to your account address. "),(0,a.kt)("li",{parentName:"ul"},"If you are an integrator who needs to manage your own faucet to provide tokens to users automatically, ask us for help with creating a custom faucet.")),(0,a.kt)("p",null,"All of these faucets should provide you with a base-64 string containing the necessary information to request tokens from the blockchain with ",(0,a.kt)("inlineCode",{parentName:"p"},"collectFaucetTokens"),". Note that each faucet package can only be used once."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},'await client.collectFaucetTokens("")\n')),(0,a.kt)("admonition",{title:"collect faucet tokens",type:"note"},(0,a.kt)("p",{parentName:"admonition"},"In production environments, the ",(0,a.kt)("inlineCode",{parentName:"p"},"collectFaucetTokens")," method requires a ",(0,a.kt)("inlineCode",{parentName:"p"},"faucetPackage")," to be provided. In development and stage, this is optional as a package is generated automatically by default.")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5125b704.2e32c787.js b/assets/js/5125b704.2e32c787.js new file mode 100644 index 000000000..07e554ae2 --- /dev/null +++ b/assets/js/5125b704.2e32c787.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1205],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var p=r.createContext({}),c=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},s=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,p=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),u=c(n),f=i,k=u["".concat(p,".").concat(f)]||u[f]||d[f]||a;return n?r.createElement(k,o(o({ref:t},s),{},{components:n})):r.createElement(k,o({ref:t},s))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:i,o[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var r=n(87462),i=(n(67294),n(3905));const a={},o=void 0,l={unversionedId:"sdk/reference/interfaces/MintTokensTx",id:"sdk/reference/interfaces/MintTokensTx",title:"MintTokensTx",description:"@vocdoni/sdk / Exports / MintTokensTx",source:"@site/docs/sdk/reference/interfaces/MintTokensTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/MintTokensTx",permalink:"/sdk/reference/interfaces/MintTokensTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IVoteType",permalink:"/sdk/reference/interfaces/IVoteType"},next:{title:"NewProcessTx",permalink:"/sdk/reference/interfaces/NewProcessTx"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"to",id:"to",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"txtype",id:"txtype",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"value",id:"value",level:3},{value:"Defined in",id:"defined-in-3",level:4}],s={toc:c};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / MintTokensTx"),(0,i.kt)("h1",{id:"interface-minttokenstx"},"Interface: MintTokensTx"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"MintTokensTx#nonce"},"nonce")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"MintTokensTx#to"},"to")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"MintTokensTx#txtype"},"txtype")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"MintTokensTx#value"},"value"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"nonce"},"nonce"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"nonce"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L128"},"api/chain/transactions.ts:128")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"to"},"to"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"to"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L129"},"api/chain/transactions.ts:129")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"txtype"},"txtype"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"txtype"),": ",(0,i.kt)("a",{parentName:"p",href:"../enums/TxType"},(0,i.kt)("inlineCode",{parentName:"a"},"TxType"))),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L127"},"api/chain/transactions.ts:127")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"value"},"value"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"value"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L130"},"api/chain/transactions.ts:130")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5125b704.7669ad11.js b/assets/js/5125b704.7669ad11.js deleted file mode 100644 index c019351dc..000000000 --- a/assets/js/5125b704.7669ad11.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1205],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=r.createContext({}),s=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=s(e.components);return r.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,l=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),f=s(n),u=i,k=f["".concat(l,".").concat(u)]||f[u]||d[u]||a;return n?r.createElement(k,o(o({ref:t},p),{},{components:n})):r.createElement(k,o({ref:t},p))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=f;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c.mdxType="string"==typeof e?e:i,o[1]=c;for(var s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>c,toc:()=>s});var r=n(87462),i=(n(67294),n(3905));const a={},o=void 0,c={unversionedId:"sdk/reference/interfaces/MintTokensTx",id:"sdk/reference/interfaces/MintTokensTx",title:"MintTokensTx",description:"@vocdoni/sdk / Exports / MintTokensTx",source:"@site/docs/sdk/reference/interfaces/MintTokensTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/MintTokensTx",permalink:"/sdk/reference/interfaces/MintTokensTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IVoteType",permalink:"/sdk/reference/interfaces/IVoteType"},next:{title:"NewProcessTx",permalink:"/sdk/reference/interfaces/NewProcessTx"}},l={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"to",id:"to",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"txtype",id:"txtype",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"value",id:"value",level:3},{value:"Defined in",id:"defined-in-3",level:4}],p={toc:s};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / MintTokensTx"),(0,i.kt)("h1",{id:"interface-minttokenstx"},"Interface: MintTokensTx"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/MintTokensTx#nonce"},"nonce")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/MintTokensTx#to"},"to")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/MintTokensTx#txtype"},"txtype")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/MintTokensTx#value"},"value"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"nonce"},"nonce"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"nonce"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L128"},"api/chain/transactions.ts:128")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"to"},"to"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"to"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L129"},"api/chain/transactions.ts:129")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"txtype"},"txtype"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"txtype"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/TxType"},(0,i.kt)("inlineCode",{parentName:"a"},"TxType"))),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L127"},"api/chain/transactions.ts:127")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"value"},"value"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"value"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L130"},"api/chain/transactions.ts:130")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/515de0d7.4ac7a442.js b/assets/js/515de0d7.2e6f0f63.js similarity index 57% rename from assets/js/515de0d7.4ac7a442.js rename to assets/js/515de0d7.2e6f0f63.js index af0ba0eda..1dc454343 100644 --- a/assets/js/515de0d7.4ac7a442.js +++ b/assets/js/515de0d7.2e6f0f63.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7136],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>d});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function c(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},s=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,c=e.originalType,l=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),f=p(n),d=a,k=f["".concat(l,".").concat(d)]||f[d]||u[d]||c;return n?r.createElement(k,i(i({ref:t},s),{},{components:n})):r.createElement(k,i({ref:t},s))}));function d(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var c=n.length,i=new Array(c);i[0]=f;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,i[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const c={},i=void 0,o={unversionedId:"sdk/reference/interfaces/CollectFaucetTx",id:"sdk/reference/interfaces/CollectFaucetTx",title:"CollectFaucetTx",description:"@vocdoni/sdk / Exports / CollectFaucetTx",source:"@site/docs/sdk/reference/interfaces/CollectFaucetTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/CollectFaucetTx",permalink:"/sdk/reference/interfaces/CollectFaucetTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CircuitInputs",permalink:"/sdk/reference/interfaces/CircuitInputs"},next:{title:"ElectionMetadata",permalink:"/sdk/reference/interfaces/ElectionMetadata"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"faucetPackage",id:"faucetpackage",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"txType",id:"txtype",level:3},{value:"Defined in",id:"defined-in-2",level:4}],s={toc:p};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / CollectFaucetTx"),(0,a.kt)("h1",{id:"interface-collectfaucettx"},"Interface: CollectFaucetTx"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CollectFaucetTx#faucetpackage"},"faucetPackage")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CollectFaucetTx#nonce"},"nonce")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CollectFaucetTx#txtype"},"txType"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"faucetpackage"},"faucetPackage"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"faucetPackage"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"FaucetPackage")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L158"},"api/chain/transactions.ts:158")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"nonce"},"nonce"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"nonce"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L159"},"api/chain/transactions.ts:159")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"txtype"},"txType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"txType"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/TxType"},(0,a.kt)("inlineCode",{parentName:"a"},"TxType"))),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L157"},"api/chain/transactions.ts:157")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7136],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>f});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function c(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},s=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,c=e.originalType,l=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),d=p(n),f=a,k=d["".concat(l,".").concat(f)]||d[f]||u[f]||c;return n?r.createElement(k,i(i({ref:t},s),{},{components:n})):r.createElement(k,i({ref:t},s))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var c=n.length,i=new Array(c);i[0]=d;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,i[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const c={},i=void 0,o={unversionedId:"sdk/reference/interfaces/CollectFaucetTx",id:"sdk/reference/interfaces/CollectFaucetTx",title:"CollectFaucetTx",description:"@vocdoni/sdk / Exports / CollectFaucetTx",source:"@site/docs/sdk/reference/interfaces/CollectFaucetTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/CollectFaucetTx",permalink:"/sdk/reference/interfaces/CollectFaucetTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CircuitInputs",permalink:"/sdk/reference/interfaces/CircuitInputs"},next:{title:"ElectionMetadata",permalink:"/sdk/reference/interfaces/ElectionMetadata"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"faucetPackage",id:"faucetpackage",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"txType",id:"txtype",level:3},{value:"Defined in",id:"defined-in-2",level:4}],s={toc:p};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / CollectFaucetTx"),(0,a.kt)("h1",{id:"interface-collectfaucettx"},"Interface: CollectFaucetTx"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"CollectFaucetTx#faucetpackage"},"faucetPackage")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"CollectFaucetTx#nonce"},"nonce")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"CollectFaucetTx#txtype"},"txType"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"faucetpackage"},"faucetPackage"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"faucetPackage"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"FaucetPackage")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L158"},"api/chain/transactions.ts:158")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"nonce"},"nonce"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"nonce"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L159"},"api/chain/transactions.ts:159")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"txtype"},"txType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"txType"),": ",(0,a.kt)("a",{parentName:"p",href:"../enums/TxType"},(0,a.kt)("inlineCode",{parentName:"a"},"TxType"))),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L157"},"api/chain/transactions.ts:157")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5344dd0e.0bc44d8a.js b/assets/js/5344dd0e.61764d38.js similarity index 74% rename from assets/js/5344dd0e.0bc44d8a.js rename to assets/js/5344dd0e.61764d38.js index 26d91b07f..e887699e3 100644 --- a/assets/js/5344dd0e.0bc44d8a.js +++ b/assets/js/5344dd0e.61764d38.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4519],{3905:(e,n,t)=>{t.d(n,{Zo:()=>l,kt:()=>u});var r=t(67294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var p=r.createContext({}),c=function(e){var n=r.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},l=function(e){var n=c(e.components);return r.createElement(p.Provider,{value:n},e.children)},f={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,a=e.originalType,p=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),d=c(t),u=i,g=d["".concat(p,".").concat(u)]||d[u]||f[u]||a;return t?r.createElement(g,o(o({ref:n},l),{},{components:t})):r.createElement(g,o({ref:n},l))}));function u(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var a=t.length,o=new Array(a);o[0]=d;var s={};for(var p in n)hasOwnProperty.call(n,p)&&(s[p]=n[p]);s.originalType=e,s.mdxType="string"==typeof e?e:i,o[1]=s;for(var c=2;c{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>o,default:()=>f,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var r=t(87462),i=(t(67294),t(3905));const a={},o=void 0,s={unversionedId:"sdk/reference/interfaces/IChainOrganizationListResponse",id:"sdk/reference/interfaces/IChainOrganizationListResponse",title:"IChainOrganizationListResponse",description:"@vocdoni/sdk / Exports / IChainOrganizationListResponse",source:"@site/docs/sdk/reference/interfaces/IChainOrganizationListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainOrganizationListResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainOrganizationCountResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationCountResponse"},next:{title:"IChainOrganizationResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationResponse"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"organizations",id:"organizations",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:c};function f(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},l,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IChainOrganizationListResponse"),(0,i.kt)("h1",{id:"interface-ichainorganizationlistresponse"},"Interface: IChainOrganizationListResponse"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainOrganizationListResponse#organizations"},"organizations"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"organizations"},"organizations"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"organizations"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainOrganizationResponse"},(0,i.kt)("inlineCode",{parentName:"a"},"IChainOrganizationResponse")),"[]"),(0,i.kt)("p",null,"The list of organizations"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L260"},"api/chain.ts:260")))}f.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4519],{3905:(e,n,t)=>{t.d(n,{Zo:()=>l,kt:()=>d});var r=t(67294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var p=r.createContext({}),c=function(e){var n=r.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},l=function(e){var n=c(e.components);return r.createElement(p.Provider,{value:n},e.children)},f={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},u=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,a=e.originalType,p=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),u=c(t),d=i,g=u["".concat(p,".").concat(d)]||u[d]||f[d]||a;return t?r.createElement(g,o(o({ref:n},l),{},{components:t})):r.createElement(g,o({ref:n},l))}));function d(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var a=t.length,o=new Array(a);o[0]=u;var s={};for(var p in n)hasOwnProperty.call(n,p)&&(s[p]=n[p]);s.originalType=e,s.mdxType="string"==typeof e?e:i,o[1]=s;for(var c=2;c{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>o,default:()=>f,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var r=t(87462),i=(t(67294),t(3905));const a={},o=void 0,s={unversionedId:"sdk/reference/interfaces/IChainOrganizationListResponse",id:"sdk/reference/interfaces/IChainOrganizationListResponse",title:"IChainOrganizationListResponse",description:"@vocdoni/sdk / Exports / IChainOrganizationListResponse",source:"@site/docs/sdk/reference/interfaces/IChainOrganizationListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainOrganizationListResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainOrganizationCountResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationCountResponse"},next:{title:"IChainOrganizationResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationResponse"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"organizations",id:"organizations",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:c};function f(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},l,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IChainOrganizationListResponse"),(0,i.kt)("h1",{id:"interface-ichainorganizationlistresponse"},"Interface: IChainOrganizationListResponse"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IChainOrganizationListResponse#organizations"},"organizations"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"organizations"},"organizations"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"organizations"),": ",(0,i.kt)("a",{parentName:"p",href:"IChainOrganizationResponse"},(0,i.kt)("inlineCode",{parentName:"a"},"IChainOrganizationResponse")),"[]"),(0,i.kt)("p",null,"The list of organizations"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L260"},"api/chain.ts:260")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5383e2bf.442a1ade.js b/assets/js/5383e2bf.442a1ade.js new file mode 100644 index 000000000..67dc0aeb6 --- /dev/null +++ b/assets/js/5383e2bf.442a1ade.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2323],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>u});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),s=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=s(e.components);return r.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),f=s(n),u=a,k=f["".concat(p,".").concat(u)]||f[u]||d[u]||i;return n?r.createElement(k,o(o({ref:t},c),{},{components:n})):r.createElement(k,o({ref:t},c))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=f;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:a,o[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=n(87462),a=(n(67294),n(3905));const i={},o=void 0,l={unversionedId:"sdk/reference/interfaces/SendTokensTx",id:"sdk/reference/interfaces/SendTokensTx",title:"SendTokensTx",description:"@vocdoni/sdk / Exports / SendTokensTx",source:"@site/docs/sdk/reference/interfaces/SendTokensTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/SendTokensTx",permalink:"/sdk/reference/interfaces/SendTokensTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"RegisterKeyTx",permalink:"/sdk/reference/interfaces/RegisterKeyTx"},next:{title:"ServiceProperties",permalink:"/sdk/reference/interfaces/ServiceProperties"}},p={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"from",id:"from",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"to",id:"to",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"txtype",id:"txtype",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"value",id:"value",level:3},{value:"Defined in",id:"defined-in-4",level:4}],c={toc:s};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / SendTokensTx"),(0,a.kt)("h1",{id:"interface-sendtokenstx"},"Interface: SendTokensTx"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"SendTokensTx#from"},"from")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"SendTokensTx#nonce"},"nonce")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"SendTokensTx#to"},"to")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"SendTokensTx#txtype"},"txtype")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"SendTokensTx#value"},"value"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"from"},"from"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"from"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L136"},"api/chain/transactions.ts:136")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"nonce"},"nonce"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"nonce"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L135"},"api/chain/transactions.ts:135")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"to"},"to"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"to"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L137"},"api/chain/transactions.ts:137")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"txtype"},"txtype"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"txtype"),": ",(0,a.kt)("a",{parentName:"p",href:"../enums/TxType"},(0,a.kt)("inlineCode",{parentName:"a"},"TxType"))),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L134"},"api/chain/transactions.ts:134")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"value"},"value"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"value"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L138"},"api/chain/transactions.ts:138")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5383e2bf.761cb2ec.js b/assets/js/5383e2bf.761cb2ec.js deleted file mode 100644 index bb2763a9c..000000000 --- a/assets/js/5383e2bf.761cb2ec.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2323],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>k});var r=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var c=r.createContext({}),s=function(e){var n=r.useContext(c),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},p=function(e){var n=s(e.components);return r.createElement(c.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},f=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,c=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),f=s(t),k=a,u=f["".concat(c,".").concat(k)]||f[k]||d[k]||i;return t?r.createElement(u,o(o({ref:n},p),{},{components:t})):r.createElement(u,o({ref:n},p))}));function k(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,o=new Array(i);o[0]=f;var l={};for(var c in n)hasOwnProperty.call(n,c)&&(l[c]=n[c]);l.originalType=e,l.mdxType="string"==typeof e?e:a,o[1]=l;for(var s=2;s{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=t(87462),a=(t(67294),t(3905));const i={},o=void 0,l={unversionedId:"sdk/reference/interfaces/SendTokensTx",id:"sdk/reference/interfaces/SendTokensTx",title:"SendTokensTx",description:"@vocdoni/sdk / Exports / SendTokensTx",source:"@site/docs/sdk/reference/interfaces/SendTokensTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/SendTokensTx",permalink:"/sdk/reference/interfaces/SendTokensTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"RegisterKeyTx",permalink:"/sdk/reference/interfaces/RegisterKeyTx"},next:{title:"ServiceProperties",permalink:"/sdk/reference/interfaces/ServiceProperties"}},c={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"from",id:"from",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"to",id:"to",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"txtype",id:"txtype",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"value",id:"value",level:3},{value:"Defined in",id:"defined-in-4",level:4}],p={toc:s};function d(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / SendTokensTx"),(0,a.kt)("h1",{id:"interface-sendtokenstx"},"Interface: SendTokensTx"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SendTokensTx#from"},"from")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SendTokensTx#nonce"},"nonce")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SendTokensTx#to"},"to")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SendTokensTx#txtype"},"txtype")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SendTokensTx#value"},"value"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"from"},"from"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"from"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L136"},"api/chain/transactions.ts:136")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"nonce"},"nonce"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"nonce"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L135"},"api/chain/transactions.ts:135")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"to"},"to"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"to"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L137"},"api/chain/transactions.ts:137")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"txtype"},"txtype"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"txtype"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/TxType"},(0,a.kt)("inlineCode",{parentName:"a"},"TxType"))),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L134"},"api/chain/transactions.ts:134")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"value"},"value"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"value"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L138"},"api/chain/transactions.ts:138")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/545dbd82.d66edf32.js b/assets/js/545dbd82.d66edf32.js new file mode 100644 index 000000000..f410d3154 --- /dev/null +++ b/assets/js/545dbd82.d66edf32.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8119],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>c});var a=n(67294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var p=a.createContext({}),d=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=d(e.components);return a.createElement(p.Provider,{value:t},e.children)},o={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,s=e.mdxType,r=e.originalType,p=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),k=d(n),c=s,m=k["".concat(p,".").concat(c)]||k[c]||o[c]||r;return n?a.createElement(m,i(i({ref:t},u),{},{components:n})):a.createElement(m,i({ref:t},u))}));function c(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var r=n.length,i=new Array(r);i[0]=k;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:s,i[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>o,frontMatter:()=>r,metadata:()=>l,toc:()=>d});var a=n(87462),s=(n(67294),n(3905));const r={},i=void 0,l={unversionedId:"sdk/reference/classes/Census",id:"sdk/reference/classes/Census",title:"Census",description:"@vocdoni/sdk / Exports / Census",source:"@site/docs/sdk/reference/classes/Census.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Census",permalink:"/sdk/reference/classes/Census",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"BudgetElection",permalink:"/sdk/reference/classes/BudgetElection"},next:{title:"Census3CensusAPI",permalink:"/sdk/reference/classes/Census3CensusAPI"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_censusId",id:"_censusid",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"_censusURI",id:"_censusuri",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"_size",id:"_size",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"_type",id:"_type",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"_weight",id:"_weight",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"censusId",id:"censusid",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isPublished",id:"ispublished",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"type",id:"type",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"weight",id:"weight",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Methods",id:"methods-1",level:2},{value:"censusTypeFromCensusOrigin",id:"censustypefromcensusorigin",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-17",level:4}],u={toc:d};function o(e){let{components:t,...n}=e;return(0,s.kt)("wrapper",(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / Census"),(0,s.kt)("h1",{id:"class-census"},"Class: Census"),(0,s.kt)("p",null,"Represents a generic census"),(0,s.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("p",{parentName:"li"},(0,s.kt)("strong",{parentName:"p"},(0,s.kt)("inlineCode",{parentName:"strong"},"Census"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("a",{parentName:"p",href:"CspCensus"},(0,s.kt)("inlineCode",{parentName:"a"},"CspCensus"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("a",{parentName:"p",href:"PublishedCensus"},(0,s.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("a",{parentName:"p",href:"OffchainCensus"},(0,s.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))))),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"constructors"},"Constructors"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"Census#constructor"},"constructor"))),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#_censusid"},"_","censusId")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#_censusuri"},"_","censusURI")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#_size"},"_","size")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#_type"},"_","type")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#_weight"},"_","weight"))),(0,s.kt)("h3",{id:"accessors"},"Accessors"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"Census#censusid"},"censusId")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"Census#censusuri"},"censusURI")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"Census#ispublished"},"isPublished")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"Census#size"},"size")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"Census#type"},"type")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"Census#weight"},"weight"))),(0,s.kt)("h3",{id:"methods"},"Methods"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"Census#censustypefromcensusorigin"},"censusTypeFromCensusOrigin"))),(0,s.kt)("h2",{id:"constructors-1"},"Constructors"),(0,s.kt)("h3",{id:"constructor"},"constructor"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"new Census"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"censusId?"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"censusURI?"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"type?"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"size?"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"weight?"),"): ",(0,s.kt)("a",{parentName:"p",href:"Census"},(0,s.kt)("inlineCode",{parentName:"a"},"Census"))),(0,s.kt)("p",null,"Constructs a generic census"),(0,s.kt)("h4",{id:"parameters"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"censusId?")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The id of the census")),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"censusURI?")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The URI of the census")),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"type?")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("a",{parentName:"td",href:"../enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("td",{parentName:"tr",align:"left"},"The type of the census")),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"size?")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"number")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The size of the census")),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"weight?")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"bigint")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The weight of the census")))),(0,s.kt)("h4",{id:"returns"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"Census"},(0,s.kt)("inlineCode",{parentName:"a"},"Census"))),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L27"},"types/census/census.ts:27")),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"_censusid"},"_","censusId"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,s.kt)("strong",{parentName:"p"},"_","censusId"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L12"},"types/census/census.ts:12")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"_censusuri"},"_","censusURI"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,s.kt)("strong",{parentName:"p"},"_","censusURI"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L13"},"types/census/census.ts:13")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"_size"},"_","size"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,s.kt)("strong",{parentName:"p"},"_","size"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L15"},"types/census/census.ts:15")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"_type"},"_","type"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,s.kt)("strong",{parentName:"p"},"_","type"),": ",(0,s.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L14"},"types/census/census.ts:14")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"_weight"},"_","weight"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,s.kt)("strong",{parentName:"p"},"_","weight"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"bigint")),(0,s.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L16"},"types/census/census.ts:16")),(0,s.kt)("h2",{id:"accessors-1"},"Accessors"),(0,s.kt)("h3",{id:"censusid"},"censusId"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"censusId"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"returns-1"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L35"},"types/census/census.ts:35")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"censusId"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-1"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string"))))),(0,s.kt)("h4",{id:"returns-2"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L39"},"types/census/census.ts:39")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"censusuri"},"censusURI"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"censusURI"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"returns-3"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L43"},"types/census/census.ts:43")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"censusURI"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-2"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string"))))),(0,s.kt)("h4",{id:"returns-4"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L47"},"types/census/census.ts:47")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"ispublished"},"isPublished"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"isPublished"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"boolean")),(0,s.kt)("h4",{id:"returns-5"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"boolean")),(0,s.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L75"},"types/census/census.ts:75")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"size"},"size"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"size"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("h4",{id:"returns-6"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L59"},"types/census/census.ts:59")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"size"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-3"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"number"))))),(0,s.kt)("h4",{id:"returns-7"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L63"},"types/census/census.ts:63")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"type"},"type"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"type"),"(): ",(0,s.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"returns-8"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L51"},"types/census/census.ts:51")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"type"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-4"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("a",{parentName:"td",href:"../enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType")))))),(0,s.kt)("h4",{id:"returns-9"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L55"},"types/census/census.ts:55")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"weight"},"weight"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"weight"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"bigint")),(0,s.kt)("h4",{id:"returns-10"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"bigint")),(0,s.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L67"},"types/census/census.ts:67")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"weight"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-5"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,s.kt)("h4",{id:"returns-11"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L71"},"types/census/census.ts:71")),(0,s.kt)("h2",{id:"methods-1"},"Methods"),(0,s.kt)("h3",{id:"censustypefromcensusorigin"},"censusTypeFromCensusOrigin"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("strong",{parentName:"p"},"censusTypeFromCensusOrigin"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"censusOrigin"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,s.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"parameters-6"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"censusOrigin")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"boolean")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"false"))))),(0,s.kt)("h4",{id:"returns-12"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L81"},"types/census/census.ts:81")))}o.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/545dbd82.dcc43f31.js b/assets/js/545dbd82.dcc43f31.js deleted file mode 100644 index 2a63f4cb5..000000000 --- a/assets/js/545dbd82.dcc43f31.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8119],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>c});var a=n(67294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var p=a.createContext({}),d=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=d(e.components);return a.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},o=a.forwardRef((function(e,t){var n=e.components,s=e.mdxType,r=e.originalType,p=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),o=d(n),c=s,m=o["".concat(p,".").concat(c)]||o[c]||k[c]||r;return n?a.createElement(m,i(i({ref:t},u),{},{components:n})):a.createElement(m,i({ref:t},u))}));function c(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var r=n.length,i=new Array(r);i[0]=o;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:s,i[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>k,frontMatter:()=>r,metadata:()=>l,toc:()=>d});var a=n(87462),s=(n(67294),n(3905));const r={},i=void 0,l={unversionedId:"sdk/reference/classes/Census",id:"sdk/reference/classes/Census",title:"Census",description:"@vocdoni/sdk / Exports / Census",source:"@site/docs/sdk/reference/classes/Census.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Census",permalink:"/sdk/reference/classes/Census",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"BudgetElection",permalink:"/sdk/reference/classes/BudgetElection"},next:{title:"Census3CensusAPI",permalink:"/sdk/reference/classes/Census3CensusAPI"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_censusId",id:"_censusid",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"_censusURI",id:"_censusuri",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"_size",id:"_size",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"_type",id:"_type",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"_weight",id:"_weight",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"censusId",id:"censusid",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isPublished",id:"ispublished",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"type",id:"type",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"weight",id:"weight",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Methods",id:"methods-1",level:2},{value:"censusTypeFromCensusOrigin",id:"censustypefromcensusorigin",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-17",level:4}],u={toc:d};function k(e){let{components:t,...n}=e;return(0,s.kt)("wrapper",(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / Census"),(0,s.kt)("h1",{id:"class-census"},"Class: Census"),(0,s.kt)("p",null,"Represents a generic census"),(0,s.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("p",{parentName:"li"},(0,s.kt)("strong",{parentName:"p"},(0,s.kt)("inlineCode",{parentName:"strong"},"Census"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CspCensus"},(0,s.kt)("inlineCode",{parentName:"a"},"CspCensus"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},(0,s.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},(0,s.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))))),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"constructors"},"Constructors"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#constructor"},"constructor"))),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#_censusid"},"_","censusId")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#_censusuri"},"_","censusURI")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#_size"},"_","size")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#_type"},"_","type")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#_weight"},"_","weight"))),(0,s.kt)("h3",{id:"accessors"},"Accessors"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#censusid"},"censusId")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#censusuri"},"censusURI")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#ispublished"},"isPublished")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#size"},"size")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#type"},"type")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#weight"},"weight"))),(0,s.kt)("h3",{id:"methods"},"Methods"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census#censustypefromcensusorigin"},"censusTypeFromCensusOrigin"))),(0,s.kt)("h2",{id:"constructors-1"},"Constructors"),(0,s.kt)("h3",{id:"constructor"},"constructor"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"new Census"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"censusId?"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"censusURI?"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"type?"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"size?"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"weight?"),"): ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,s.kt)("inlineCode",{parentName:"a"},"Census"))),(0,s.kt)("p",null,"Constructs a generic census"),(0,s.kt)("h4",{id:"parameters"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"censusId?")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The id of the census")),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"censusURI?")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The URI of the census")),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"type?")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("td",{parentName:"tr",align:"left"},"The type of the census")),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"size?")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"number")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The size of the census")),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"weight?")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"bigint")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The weight of the census")))),(0,s.kt)("h4",{id:"returns"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,s.kt)("inlineCode",{parentName:"a"},"Census"))),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L27"},"types/census/census.ts:27")),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"_censusid"},"_","censusId"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,s.kt)("strong",{parentName:"p"},"_","censusId"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L12"},"types/census/census.ts:12")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"_censusuri"},"_","censusURI"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,s.kt)("strong",{parentName:"p"},"_","censusURI"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L13"},"types/census/census.ts:13")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"_size"},"_","size"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,s.kt)("strong",{parentName:"p"},"_","size"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L15"},"types/census/census.ts:15")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"_type"},"_","type"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,s.kt)("strong",{parentName:"p"},"_","type"),": ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L14"},"types/census/census.ts:14")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"_weight"},"_","weight"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,s.kt)("strong",{parentName:"p"},"_","weight"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"bigint")),(0,s.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L16"},"types/census/census.ts:16")),(0,s.kt)("h2",{id:"accessors-1"},"Accessors"),(0,s.kt)("h3",{id:"censusid"},"censusId"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"censusId"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"returns-1"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L35"},"types/census/census.ts:35")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"censusId"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-1"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string"))))),(0,s.kt)("h4",{id:"returns-2"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L39"},"types/census/census.ts:39")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"censusuri"},"censusURI"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"censusURI"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"returns-3"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L43"},"types/census/census.ts:43")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"censusURI"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-2"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string"))))),(0,s.kt)("h4",{id:"returns-4"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L47"},"types/census/census.ts:47")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"ispublished"},"isPublished"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"isPublished"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"boolean")),(0,s.kt)("h4",{id:"returns-5"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"boolean")),(0,s.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L75"},"types/census/census.ts:75")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"size"},"size"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"size"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("h4",{id:"returns-6"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L59"},"types/census/census.ts:59")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"size"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-3"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"number"))))),(0,s.kt)("h4",{id:"returns-7"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L63"},"types/census/census.ts:63")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"type"},"type"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"type"),"(): ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"returns-8"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L51"},"types/census/census.ts:51")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"type"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-4"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType")))))),(0,s.kt)("h4",{id:"returns-9"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L55"},"types/census/census.ts:55")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"weight"},"weight"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"weight"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"bigint")),(0,s.kt)("h4",{id:"returns-10"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"bigint")),(0,s.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L67"},"types/census/census.ts:67")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"weight"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-5"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,s.kt)("h4",{id:"returns-11"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L71"},"types/census/census.ts:71")),(0,s.kt)("h2",{id:"methods-1"},"Methods"),(0,s.kt)("h3",{id:"censustypefromcensusorigin"},"censusTypeFromCensusOrigin"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("strong",{parentName:"p"},"censusTypeFromCensusOrigin"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"censusOrigin"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"parameters-6"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"censusOrigin")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"boolean")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"false"))))),(0,s.kt)("h4",{id:"returns-12"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L81"},"types/census/census.ts:81")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/54bc495f.19b764ac.js b/assets/js/54bc495f.19b764ac.js new file mode 100644 index 000000000..4ae0b8984 --- /dev/null +++ b/assets/js/54bc495f.19b764ac.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3706],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var o=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function r(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=o.createContext({}),c=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},p=function(e){var t=c(e.components);return o.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},d=o.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=c(n),m=i,h=d["".concat(l,".").concat(m)]||d[m]||u[m]||a;return n?o.createElement(h,r(r({ref:t},p),{},{components:n})):o.createElement(h,r({ref:t},p))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,r=new Array(a);r[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:i,r[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var o=n(87462),i=(n(67294),n(3905));const a={slug:"single-choice",sidebar_position:2},r="Single Choice Voting",s={unversionedId:"sdk/integration-details/voting-types/single-choice",id:"sdk/integration-details/voting-types/single-choice",title:"Single Choice Voting",description:"An election with a single-choice result, also known as First-past-the-post voting (FPTP or FPP) or informally called",source:"@site/docs/sdk/integration-details/voting-types/single-choice.md",sourceDirName:"sdk/integration-details/voting-types",slug:"/sdk/integration-details/voting-types/single-choice",permalink:"/sdk/integration-details/voting-types/single-choice",draft:!1,tags:[],version:"current",sidebarPosition:2,frontMatter:{slug:"single-choice",sidebar_position:2},sidebar:"defaultSidebar",previous:{title:"Voting Types",permalink:"/sdk/integration-details/voting-types/"},next:{title:"Ranked Voting",permalink:"/sdk/integration-details/voting-types/ranked"}},l={},c=[{value:"Setting up the election",id:"setting-up-the-election",level:2},{value:"Casting a vote",id:"casting-a-vote",level:2},{value:"Results interpretation",id:"results-interpretation",level:2}],p={toc:c};function u(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,o.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"single-choice-voting"},"Single Choice Voting"),(0,i.kt)("p",null,"An election with a single-choice result, also known as First-past-the-post voting (FPTP or FPP) or informally called\nchoose-one voting, is a voting system where each voter is typically allowed to cast only one vote for their preferred\noption or candidate. The option or candidate with the most votes wins the election."),(0,i.kt)("p",null,'This voting system is considered one of the simplest, as a single-choice election involves selecting a single winner,\nand voters can mark only one option from the list of choices or candidates. However, despite its widespread use and\nsimplicity, it has some drawbacks. Since it operates on a "winner-take-all" principle, it can lead to disproportionate\noutcomes (the candidate/option with the most votes secures victory, even if their margin of victory is slim).'),(0,i.kt)("admonition",{type:"info"},(0,i.kt)("p",{parentName:"admonition"},"This voting system supports ",(0,i.kt)("strong",{parentName:"p"},"one")," or ",(0,i.kt)("strong",{parentName:"p"},"multiple questions"),".")),(0,i.kt)("p",null,"See:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/protocol/ballot-protocol#single-choice"},"Ballot protocol implementation"))),(0,i.kt)("h2",{id:"setting-up-the-election"},"Setting up the election"),(0,i.kt)("p",null,"To establish this kind of election, you can utilize the default parameters:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"const election = Election.from({\n census,\n title: 'Do you like chocolate?',\n description: 'A simple survey to assess chocolate preferences',\n})\n")),(0,i.kt)("p",null,"After creating the election and before publishing, add the questions, ensuring each choice has a distinct value:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"election.addQuestion('Do you like chocolate without milk?', 'This is the description', [\n {\n title: 'Yes',\n value: 0,\n },\n {\n title: 'No',\n value: 1,\n },\n]).addQuestion('Do you like chocolate with milk', 'This is the description', [\n {\n title: 'Yes',\n value: 0,\n },\n {\n title: 'No',\n value: 1,\n },\n {\n title: 'Not always',\n value: 2,\n },\n])\n")),(0,i.kt)("admonition",{title:"About choices values",type:"info"},(0,i.kt)("p",{parentName:"admonition"},"Take note that the question values are ",(0,i.kt)("strong",{parentName:"p"},"incremental")," and the initial value ",(0,i.kt)("strong",{parentName:"p"},"must")," be 0")),(0,i.kt)("admonition",{title:"Multiple questions support",type:"tip"},(0,i.kt)("p",{parentName:"admonition"},"This election type can accommodate multiple questions.")),(0,i.kt)("admonition",{title:"Not all elections type supports multiple questions!",type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"This is the sole type of election that supports multiple questions. Other election types, such as ",(0,i.kt)("inlineCode",{parentName:"p"},"ranked"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"quadratic"),",\netc, ",(0,i.kt)("strong",{parentName:"p"},"only support one question per election"),".")),(0,i.kt)("p",null,"To restrict the maximum number of questions or values an election can contain, adjust the ",(0,i.kt)("inlineCode",{parentName:"p"},"maxCount")," and\n",(0,i.kt)("inlineCode",{parentName:"p"},"maxValue")," parameters in ",(0,i.kt)("inlineCode",{parentName:"p"},"voteOpts"),":"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"const election_opts: IVoteType = {\n maxCount: 2, // Represents the max number of questions\n maxValue: 3, // Represents the max number of choices for a given question.\n}\nconst election = Election.from({\n census,\n election_opts,\n //...\n})\n")),(0,i.kt)("h2",{id:"casting-a-vote"},"Casting a vote"),(0,i.kt)("p",null,"Votes can be submitted using the method below:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"client.submitVote(new Vote([0, 2]));\n")),(0,i.kt)("p",null,"Each position in the vote array corresponds to a question, and the value is the associated selected choice. In this\ninstance, we select the first choice for the first question and the third choice for the second."),(0,i.kt)("admonition",{title:"Single question vote",type:"info"},(0,i.kt)("p",{parentName:"admonition"},"For single question is same philosophy, you could configure the election as:"),(0,i.kt)("pre",{parentName:"admonition"},(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"// If you want to restrict the election creation\n// ...\n maxCount: 1, // Only one question\n maxValue: 3, // That accepts three choices\n// ...\n// And finally casting the vote\nclient.submitVote(new Vote([0, 2])); // Voting the third option\n"))),(0,i.kt)("h2",{id:"results-interpretation"},"Results interpretation"),(0,i.kt)("p",null,"Consider a scenario where 10 voters cast identical votes, i.e., ",(0,i.kt)("inlineCode",{parentName:"p"},"[0, 2]"),"."),(0,i.kt)("p",null,"The election results would be represented as a two-dimensional array:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre"}," [\n [ '10', '0', '0' ],\n [ '0', '0', '10' ]\n ]\n")),(0,i.kt)("p",null,"Each sub-array signifies the results for a question, and each position of the sub-array indicates the number of votes a\nchoice has accumulated."),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"For the first question (",(0,i.kt)("inlineCode",{parentName:"li"},"[ '10', '0', '0' ]"),"): all 10 voters chose the first option."),(0,i.kt)("li",{parentName:"ul"},"For the second question (",(0,i.kt)("inlineCode",{parentName:"li"},"[ '0', '0', '10' ]"),"): all 10 voters chose the third option.")),(0,i.kt)("p",null,"In the example above, the first question offers two options, and the second presents three. However, the results array\nfor the first question contains three elements, as the ",(0,i.kt)("inlineCode",{parentName:"p"},"maxValue")," for all questions is the same (in this case, 3, the\n",(0,i.kt)("inlineCode",{parentName:"p"},"maxValue")," of the question with the most options)."),(0,i.kt)("admonition",{title:"Single question results interpretation",type:"info"},(0,i.kt)("p",{parentName:"admonition"},"Not so different, the results array will look like:"),(0,i.kt)("pre",{parentName:"admonition"},(0,i.kt)("code",{parentName:"pre"},"[ [ '0', '0', '10' ] ]\n")),(0,i.kt)("p",{parentName:"admonition"},"For the only one question, 10 voters select the third option")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5708b463.b5f5bbb6.js b/assets/js/5708b463.b5f5bbb6.js new file mode 100644 index 000000000..b7d727e2c --- /dev/null +++ b/assets/js/5708b463.b5f5bbb6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5861],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>u});var i=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=i.createContext({}),o=function(e){var t=i.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=o(e.components);return i.createElement(p.Provider,{value:t},e.children)},h={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},d=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=o(n),u=a,k=d["".concat(p,".").concat(u)]||d[u]||h[u]||r;return n?i.createElement(k,l(l({ref:t},c),{},{components:n})):i.createElement(k,l({ref:t},c))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,l=new Array(r);l[0]=d;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s.mdxType="string"==typeof e?e:a,l[1]=s;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>h,frontMatter:()=>r,metadata:()=>s,toc:()=>o});var i=n(87462),a=(n(67294),n(3905));const r={},l=void 0,s={unversionedId:"sdk/reference/interfaces/IChainGetCircuitResponse",id:"sdk/reference/interfaces/IChainGetCircuitResponse",title:"IChainGetCircuitResponse",description:"@vocdoni/sdk / Exports / IChainGetCircuitResponse",source:"@site/docs/sdk/reference/interfaces/IChainGetCircuitResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainGetCircuitResponse",permalink:"/sdk/reference/interfaces/IChainGetCircuitResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainBlockInfoResponse",permalink:"/sdk/reference/interfaces/IChainBlockInfoResponse"},next:{title:"IChainGetCostsResponse",permalink:"/sdk/reference/interfaces/IChainGetCostsResponse"}},p={},o=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"circuitPath",id:"circuitpath",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"levels",id:"levels",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"uri",id:"uri",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"vKeyFilename",id:"vkeyfilename",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"vKeyHash",id:"vkeyhash",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"wasmFilename",id:"wasmfilename",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"wasmHash",id:"wasmhash",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"zKeyFilename",id:"zkeyfilename",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"zKeyHash",id:"zkeyhash",level:3},{value:"Defined in",id:"defined-in-8",level:4}],c={toc:o};function h(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IChainGetCircuitResponse"),(0,a.kt)("h1",{id:"interface-ichaingetcircuitresponse"},"Interface: IChainGetCircuitResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetCircuitResponse#circuitpath"},"circuitPath")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetCircuitResponse#levels"},"levels")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetCircuitResponse#uri"},"uri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetCircuitResponse#vkeyfilename"},"vKeyFilename")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetCircuitResponse#vkeyhash"},"vKeyHash")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetCircuitResponse#wasmfilename"},"wasmFilename")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetCircuitResponse#wasmhash"},"wasmHash")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetCircuitResponse#zkeyfilename"},"zKeyFilename")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetCircuitResponse#zkeyhash"},"zKeyHash"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"circuitpath"},"circuitPath"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"circuitPath"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The path of the circuit."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L127"},"api/chain.ts:127")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"levels"},"levels"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"levels"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The circuit levels."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L132"},"api/chain.ts:132")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"uri"},"uri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"uri"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The base uri of the files."),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L122"},"api/chain.ts:122")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"vkeyfilename"},"vKeyFilename"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"vKeyFilename"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The name of the verification key file."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L152"},"api/chain.ts:152")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"vkeyhash"},"vKeyHash"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"vKeyHash"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The hash of the verification key file."),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L147"},"api/chain.ts:147")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"wasmfilename"},"wasmFilename"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"wasmFilename"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The name of the WASM file."),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L162"},"api/chain.ts:162")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"wasmhash"},"wasmHash"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"wasmHash"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The hash of the WASM file."),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L157"},"api/chain.ts:157")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"zkeyfilename"},"zKeyFilename"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"zKeyFilename"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The name of the proving key file."),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L142"},"api/chain.ts:142")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"zkeyhash"},"zKeyHash"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"zKeyHash"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The hash of the proving key file."),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L137"},"api/chain.ts:137")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5708b463.f7c410ef.js b/assets/js/5708b463.f7c410ef.js deleted file mode 100644 index 45f638e32..000000000 --- a/assets/js/5708b463.f7c410ef.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5861],{3905:(e,n,t)=>{t.d(n,{Zo:()=>o,kt:()=>f});var i=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function l(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var p=i.createContext({}),c=function(e){var n=i.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},o=function(e){var n=c(e.components);return i.createElement(p.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},h=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,r=e.originalType,p=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),h=c(t),f=a,u=h["".concat(p,".").concat(f)]||h[f]||d[f]||r;return t?i.createElement(u,l(l({ref:n},o),{},{components:t})):i.createElement(u,l({ref:n},o))}));function f(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var r=t.length,l=new Array(r);l[0]=h;var s={};for(var p in n)hasOwnProperty.call(n,p)&&(s[p]=n[p]);s.originalType=e,s.mdxType="string"==typeof e?e:a,l[1]=s;for(var c=2;c{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>s,toc:()=>c});var i=t(87462),a=(t(67294),t(3905));const r={},l=void 0,s={unversionedId:"sdk/reference/interfaces/IChainGetCircuitResponse",id:"sdk/reference/interfaces/IChainGetCircuitResponse",title:"IChainGetCircuitResponse",description:"@vocdoni/sdk / Exports / IChainGetCircuitResponse",source:"@site/docs/sdk/reference/interfaces/IChainGetCircuitResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainGetCircuitResponse",permalink:"/sdk/reference/interfaces/IChainGetCircuitResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainBlockInfoResponse",permalink:"/sdk/reference/interfaces/IChainBlockInfoResponse"},next:{title:"IChainGetCostsResponse",permalink:"/sdk/reference/interfaces/IChainGetCostsResponse"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"circuitPath",id:"circuitpath",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"levels",id:"levels",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"uri",id:"uri",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"vKeyFilename",id:"vkeyfilename",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"vKeyHash",id:"vkeyhash",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"wasmFilename",id:"wasmfilename",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"wasmHash",id:"wasmhash",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"zKeyFilename",id:"zkeyfilename",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"zKeyHash",id:"zkeyhash",level:3},{value:"Defined in",id:"defined-in-8",level:4}],o={toc:c};function d(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,i.Z)({},o,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IChainGetCircuitResponse"),(0,a.kt)("h1",{id:"interface-ichaingetcircuitresponse"},"Interface: IChainGetCircuitResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetCircuitResponse#circuitpath"},"circuitPath")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetCircuitResponse#levels"},"levels")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetCircuitResponse#uri"},"uri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetCircuitResponse#vkeyfilename"},"vKeyFilename")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetCircuitResponse#vkeyhash"},"vKeyHash")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetCircuitResponse#wasmfilename"},"wasmFilename")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetCircuitResponse#wasmhash"},"wasmHash")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetCircuitResponse#zkeyfilename"},"zKeyFilename")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetCircuitResponse#zkeyhash"},"zKeyHash"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"circuitpath"},"circuitPath"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"circuitPath"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The path of the circuit."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L127"},"api/chain.ts:127")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"levels"},"levels"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"levels"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The circuit levels."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L132"},"api/chain.ts:132")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"uri"},"uri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"uri"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The base uri of the files."),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L122"},"api/chain.ts:122")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"vkeyfilename"},"vKeyFilename"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"vKeyFilename"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The name of the verification key file."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L152"},"api/chain.ts:152")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"vkeyhash"},"vKeyHash"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"vKeyHash"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The hash of the verification key file."),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L147"},"api/chain.ts:147")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"wasmfilename"},"wasmFilename"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"wasmFilename"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The name of the WASM file."),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L162"},"api/chain.ts:162")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"wasmhash"},"wasmHash"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"wasmHash"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The hash of the WASM file."),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L157"},"api/chain.ts:157")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"zkeyfilename"},"zKeyFilename"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"zKeyFilename"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The name of the proving key file."),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L142"},"api/chain.ts:142")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"zkeyhash"},"zKeyHash"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"zKeyHash"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The hash of the proving key file."),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L137"},"api/chain.ts:137")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/58053ccf.f2f7e4d2.js b/assets/js/58053ccf.f2f7e4d2.js deleted file mode 100644 index 5d736225c..000000000 --- a/assets/js/58053ccf.f2f7e4d2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[473],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>h});var o=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function r(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=o.createContext({}),p=function(e){var t=o.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},c=function(e){var t=p(e.components);return o.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},u=o.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),u=p(n),h=i,m=u["".concat(s,".").concat(h)]||u[h]||d[h]||a;return n?o.createElement(m,r(r({ref:t},c),{},{components:n})):o.createElement(m,r({ref:t},c))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,r=new Array(a);r[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:i,r[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>r,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>p});var o=n(87462),i=(n(67294),n(3905));const a={sidebar_position:3,slug:"ranked"},r="Ranked Voting",l={unversionedId:"sdk/voting-types/ranked",id:"sdk/voting-types/ranked",title:"Ranked Voting",description:"Ranked voting, also known as preferential voting or ranked-choice voting (RCV), is an electoral system where voters rank",source:"@site/docs/sdk/voting-types/ranked.md",sourceDirName:"sdk/voting-types",slug:"/sdk/voting-types/ranked",permalink:"/sdk/voting-types/ranked",draft:!1,tags:[],version:"current",sidebarPosition:3,frontMatter:{sidebar_position:3,slug:"ranked"},sidebar:"defaultSidebar",previous:{title:"Single Choice Voting",permalink:"/sdk/voting-types/single-choice"},next:{title:"Approval Voting (Multiple Choice)",permalink:"/sdk/voting-types/approval"}},s={},p=[{value:"Setting up the election",id:"setting-up-the-election",level:2},{value:"Casting a vote",id:"casting-a-vote",level:2},{value:"Results interpretation",id:"results-interpretation",level:2}],c={toc:p};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,o.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"ranked-voting"},"Ranked Voting"),(0,i.kt)("p",null,"Ranked voting, also known as preferential voting or ranked-choice voting (RCV), is an electoral system where voters rank\ncandidates in order of preference on the ballot. This system allows voters to express not only their first-choice\ncandidate but also their second, third, and subsequent choices. In the counting process, candidates with the fewest\nvotes are eliminated, and their supporters' votes are redistributed to the remaining candidates based on the next-ranked\nchoices. This process continues until one candidate receives a majority of the votes, ensuring that the winner has the\nbroadest support among the electorate."),(0,i.kt)("p",null,"Ranked voting aims to provide a more inclusive and representative outcome, mitigate vote splitting and strategic voting,\nand encourage candidates to appeal to a wider range of voters."),(0,i.kt)("p",null,"For example: Sort your 5 favorite blockchains: Bitcoin, Ethereum, Monero, Zcash, Polkadot."),(0,i.kt)("p",null,"See:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/examples/typescript/src/ranked.ts"},"Complete example")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/protocol/ballot-protocol#linear-weighted-choice"},"Ballot protocol implementation"))),(0,i.kt)("h2",{id:"setting-up-the-election"},"Setting up the election"),(0,i.kt)("p",null,"The configuration of the vote type for the election should be set as follows:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"const election_opts: IVoteType = {\n uniqueChoices: true, \n costFromWeight: false,\n maxCount: 5, // Represents the number of choices for the given question.\n maxValue: 4, // Maximum value for a single choice. If voters can rate options on a scale of 0 to 3, then `MAX_VALUE` should be set to `4`.\n maxTotalCost: 0,\n}\n")),(0,i.kt)("p",null,'This configuration could, for example, allow voters to rank their top 5 preferred blockchains: "Bitcoin:0, Ethereum:1, Monero:2, Zcash:3, Polkadot:4"'),(0,i.kt)("admonition",{title:"Multiple questions not supported",type:"danger"},(0,i.kt)("p",{parentName:"admonition"},(0,i.kt)("strong",{parentName:"p"},"This election type not support multiple questions"),": the current Vocdoni implementation restricts this kind of elections to a single question. To create an election with multiple questions check ",(0,i.kt)("a",{parentName:"p",href:"/protocol/ballot-protocol#multiquestion"},"multi question election"))),(0,i.kt)("h2",{id:"casting-a-vote"},"Casting a vote"),(0,i.kt)("p",null,"A vote can be cast using the method below:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"client.submitVote(new Vote([2, 3, 0, 1, 4]));\n")),(0,i.kt)("p",null,"Each entry in the array corresponds to a choice in the election, and the value assigned to each entry represents the\nvoter's rating for that choice. The length of this array should match the total number of choices in the election\n(",(0,i.kt)("inlineCode",{parentName:"p"},"maxCount"),"), and the value assigned to each entry should not exceed ",(0,i.kt)("inlineCode",{parentName:"p"},"maxValue"),"."),(0,i.kt)("p",null,"With the vote array ",(0,i.kt)("inlineCode",{parentName:"p"},"[2, 3, 0, 1, 4]"),", it means:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"1")," is ranked as the ",(0,i.kt)("inlineCode",{parentName:"li"},"3nd")," option"),(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"2")," is ranked as the ",(0,i.kt)("inlineCode",{parentName:"li"},"4rd")," option"),(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"3")," is ranked as the ",(0,i.kt)("inlineCode",{parentName:"li"},"1st")," option"),(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"4")," is ranked as the ",(0,i.kt)("inlineCode",{parentName:"li"},"2nd")," option"),(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"5")," is ranked as the ",(0,i.kt)("inlineCode",{parentName:"li"},"5th")," option")),(0,i.kt)("h2",{id:"results-interpretation"},"Results interpretation"),(0,i.kt)("p",null,"Consider a scenario where 10 voters cast identical votes, i.e., ",(0,i.kt)("inlineCode",{parentName:"p"},"[2, 3, 0, 1, 4]"),"."),(0,i.kt)("p",null,"The election results would be represented as a two-dimensional array:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre"}," [\n [ '0', '0', '10', '0', '0' ],\n [ '0', '0', '0', '10', '0' ],\n [ '10', '0', '0', '0', '0' ],\n [ '0', '10', '0', '0', '0' ],\n [ '0', '0', '0', '0', '10' ]\n ]\n")),(0,i.kt)("p",null,'Each position in the outer array corresponds to the available choices, as in the previous example: "Bitcoin:0,\nEthereum:1, Monero:2, Zcash:3, Polkadot:4".'),(0,i.kt)("p",null,"Every position within the inner arrays indicates how many voters selected the corresponding choice for a specific\nranking:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"0")," (Bitcoin) was selected as the ",(0,i.kt)("inlineCode",{parentName:"li"},"2nd")," option by all 10 voters"),(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"1")," (Ethereum) was selected as the ",(0,i.kt)("inlineCode",{parentName:"li"},"3rd")," option by all 10 voters"),(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"2")," (Monero) was selected as the ",(0,i.kt)("inlineCode",{parentName:"li"},"1st")," option by all 10 voters"),(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"3")," (Zcash) was selected as the ",(0,i.kt)("inlineCode",{parentName:"li"},"2nd")," option by all 10 voters"),(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"4")," (Polkadot) was selected as the ",(0,i.kt)("inlineCode",{parentName:"li"},"5th")," option by all 10 voters")),(0,i.kt)("p",null,"Remember, this interpretation assumes that all voters have used the same voting pattern."))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5977a97c.f0970cac.js b/assets/js/5977a97c.0313c286.js similarity index 54% rename from assets/js/5977a97c.f0970cac.js rename to assets/js/5977a97c.0313c286.js index 08269be80..ddc8b518c 100644 --- a/assets/js/5977a97c.f0970cac.js +++ b/assets/js/5977a97c.0313c286.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9209],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>f});var r=t(67294);function s(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(s[t]=e[t]);return s}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(s[t]=e[t])}return s}var u=r.createContext({}),l=function(e){var n=r.useContext(u),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},p=function(e){var n=l(e.components);return r.createElement(u.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,s=e.mdxType,a=e.originalType,u=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),d=l(t),f=s,k=d["".concat(u,".").concat(f)]||d[f]||c[f]||a;return t?r.createElement(k,o(o({ref:n},p),{},{components:t})):r.createElement(k,o({ref:n},p))}));function f(e,n){var t=arguments,s=n&&n.mdxType;if("string"==typeof e||s){var a=t.length,o=new Array(a);o[0]=d;var i={};for(var u in n)hasOwnProperty.call(n,u)&&(i[u]=n[u]);i.originalType=e,i.mdxType="string"==typeof e?e:s,o[1]=i;for(var l=2;l{t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>o,default:()=>c,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=t(87462),s=(t(67294),t(3905));const a={},o=void 0,i={unversionedId:"sdk/reference/interfaces/ICensus3CensusQueueResponse",id:"sdk/reference/interfaces/ICensus3CensusQueueResponse",title:"ICensus3CensusQueueResponse",description:"@vocdoni/sdk / Exports / ICensus3CensusQueueResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3CensusQueueResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3CensusQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusQueueResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3CensusListResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusListResponse"},next:{title:"ICensus3CensusResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusResponse"}},u={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"census",id:"census",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"done",id:"done",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"error",id:"error",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-2",level:4}],p={toc:l};function c(e){let{components:n,...t}=e;return(0,s.kt)("wrapper",(0,r.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3CensusQueueResponse"),(0,s.kt)("h1",{id:"interface-icensus3censusqueueresponse"},"Interface: ICensus3CensusQueueResponse"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3CensusQueueResponse#census"},"census")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3CensusQueueResponse#done"},"done")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3CensusQueueResponse#error"},"error"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"census"},"census"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"census"),": ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3CensusResponse"},(0,s.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse"))),(0,s.kt)("p",null,"The census"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L84"},"api/census3/census.ts:84")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"done"},"done"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"done"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"boolean")),(0,s.kt)("p",null,"If the queue has been done"),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L64"},"api/census3/census.ts:64")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"error"},"error"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"error"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"Object")),(0,s.kt)("p",null,"The error of the queue"),(0,s.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"code")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"number")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The code of the error")),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"error")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The string of the error")))),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L69"},"api/census3/census.ts:69")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9209],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>f});var r=t(67294);function s(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(s[t]=e[t]);return s}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(s[t]=e[t])}return s}var u=r.createContext({}),l=function(e){var n=r.useContext(u),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},p=function(e){var n=l(e.components);return r.createElement(u.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,s=e.mdxType,a=e.originalType,u=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),d=l(t),f=s,k=d["".concat(u,".").concat(f)]||d[f]||c[f]||a;return t?r.createElement(k,o(o({ref:n},p),{},{components:t})):r.createElement(k,o({ref:n},p))}));function f(e,n){var t=arguments,s=n&&n.mdxType;if("string"==typeof e||s){var a=t.length,o=new Array(a);o[0]=d;var i={};for(var u in n)hasOwnProperty.call(n,u)&&(i[u]=n[u]);i.originalType=e,i.mdxType="string"==typeof e?e:s,o[1]=i;for(var l=2;l{t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>o,default:()=>c,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=t(87462),s=(t(67294),t(3905));const a={},o=void 0,i={unversionedId:"sdk/reference/interfaces/ICensus3CensusQueueResponse",id:"sdk/reference/interfaces/ICensus3CensusQueueResponse",title:"ICensus3CensusQueueResponse",description:"@vocdoni/sdk / Exports / ICensus3CensusQueueResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3CensusQueueResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3CensusQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusQueueResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3CensusListResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusListResponse"},next:{title:"ICensus3CensusResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusResponse"}},u={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"census",id:"census",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"done",id:"done",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"error",id:"error",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-2",level:4}],p={toc:l};function c(e){let{components:n,...t}=e;return(0,s.kt)("wrapper",(0,r.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3CensusQueueResponse"),(0,s.kt)("h1",{id:"interface-icensus3censusqueueresponse"},"Interface: ICensus3CensusQueueResponse"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus3CensusQueueResponse#census"},"census")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus3CensusQueueResponse#done"},"done")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus3CensusQueueResponse#error"},"error"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"census"},"census"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"census"),": ",(0,s.kt)("a",{parentName:"p",href:"ICensus3CensusResponse"},(0,s.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse"))),(0,s.kt)("p",null,"The census"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L84"},"api/census3/census.ts:84")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"done"},"done"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"done"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"boolean")),(0,s.kt)("p",null,"If the queue has been done"),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L64"},"api/census3/census.ts:64")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"error"},"error"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"error"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"Object")),(0,s.kt)("p",null,"The error of the queue"),(0,s.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"code")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"number")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The code of the error")),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"error")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The string of the error")))),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L69"},"api/census3/census.ts:69")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/59d5b983.7aae2030.js b/assets/js/59d5b983.7aae2030.js deleted file mode 100644 index 39f8b994a..000000000 --- a/assets/js/59d5b983.7aae2030.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1557],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>u});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),s=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},o=function(e){var t=s(e.components);return a.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),k=s(n),u=r,m=k["".concat(p,".").concat(u)]||k[u]||c[u]||i;return n?a.createElement(m,l(l({ref:t},o),{},{components:n})):a.createElement(m,l({ref:t},o))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=k;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>s});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,d={unversionedId:"sdk/reference/classes/Account",id:"sdk/reference/classes/Account",title:"Account",description:"@vocdoni/sdk / Exports / Account",source:"@site/docs/sdk/reference/classes/Account.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Account",permalink:"/sdk/reference/classes/Account",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Changelog",permalink:"/sdk/reference/changelog"},next:{title:"AccountAPI",permalink:"/sdk/reference/classes/AccountAPI"}},p={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_avatar",id:"_avatar",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"_description",id:"_description",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"_feed",id:"_feed",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"_header",id:"_header",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"_languages",id:"_languages",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"_logo",id:"_logo",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"_meta",id:"_meta",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"_name",id:"_name",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"avatar",id:"avatar",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"description",id:"description",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"feed",id:"feed",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"header",id:"header",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"languages",id:"languages",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"logo",id:"logo",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"meta",id:"meta",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"name",id:"name",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"Methods",id:"methods-1",level:2},{value:"generateMetadata",id:"generatemetadata",level:3},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"build",id:"build",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-26",level:4}],o={toc:s};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / Account"),(0,r.kt)("h1",{id:"class-account"},"Class: Account"),(0,r.kt)("p",null,"Represents an account"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#_avatar"},"_","avatar")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#_description"},"_","description")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#_feed"},"_","feed")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#_header"},"_","header")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#_languages"},"_","languages")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#_logo"},"_","logo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#_meta"},"_","meta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#_name"},"_","name"))),(0,r.kt)("h3",{id:"accessors"},"Accessors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#avatar"},"avatar")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#description"},"description")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#feed"},"feed")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#header"},"header")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#languages"},"languages")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#logo"},"logo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#meta"},"meta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#name"},"name"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#generatemetadata"},"generateMetadata")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#build"},"build"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new Account"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Account"},(0,r.kt)("inlineCode",{parentName:"a"},"Account"))),(0,r.kt)("p",null,"Constructs an account"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IAccount"},(0,r.kt)("inlineCode",{parentName:"a"},"IAccount"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Account parameters")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Account"},(0,r.kt)("inlineCode",{parentName:"a"},"Account"))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L35"},"types/account.ts:35")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"_avatar"},"_","avatar"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","avatar"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L25"},"types/account.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_description"},"_","description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L22"},"types/account.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_feed"},"_","feed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","feed"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L23"},"types/account.ts:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_header"},"_","header"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","header"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L24"},"types/account.ts:24")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_languages"},"_","languages"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","languages"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L20"},"types/account.ts:20")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_logo"},"_","logo"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","logo"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L26"},"types/account.ts:26")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_meta"},"_","meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","meta"),": ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"value"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }[]"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L27"},"types/account.ts:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_name"},"_","name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L21"},"types/account.ts:21")),(0,r.kt)("h2",{id:"accessors-1"},"Accessors"),(0,r.kt)("h3",{id:"avatar"},"avatar"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"avatar"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L110"},"types/account.ts:110")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"avatar"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L114"},"types/account.ts:114")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"description"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L94"},"types/account.ts:94")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"description"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L98"},"types/account.ts:98")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"feed"},"feed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"feed"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L126"},"types/account.ts:126")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"feed"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L130"},"types/account.ts:130")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"header"},"header"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"header"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L102"},"types/account.ts:102")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"header"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L106"},"types/account.ts:106")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"languages"},"languages"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"languages"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L142"},"types/account.ts:142")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"languages"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L146"},"types/account.ts:146")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"logo"},"logo"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"logo"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L118"},"types/account.ts:118")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"logo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L122"},"types/account.ts:122")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"meta"),"(): ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"value"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }[]"),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,"{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"value"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }[]"),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L134"},"types/account.ts:134")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"meta"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{"," ",(0,r.kt)("inlineCode",{parentName:"td"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"value"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any")," }[]")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L138"},"types/account.ts:138")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"name"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L86"},"types/account.ts:86")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"name"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L90"},"types/account.ts:90")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"generatemetadata"},"generateMetadata"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"generateMetadata"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/AccountMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountMetadata"))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/AccountMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountMetadata"))),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L67"},"types/account.ts:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"build"},"build"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"build"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Account"},(0,r.kt)("inlineCode",{parentName:"a"},"Account"))),(0,r.kt)("p",null,"Returns an account object"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IAccount"},(0,r.kt)("inlineCode",{parentName:"a"},"IAccount"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Account parameters")))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Account"},(0,r.kt)("inlineCode",{parentName:"a"},"Account"))),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L63"},"types/account.ts:63")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/59d5b983.7c729910.js b/assets/js/59d5b983.7c729910.js new file mode 100644 index 000000000..583832c1c --- /dev/null +++ b/assets/js/59d5b983.7c729910.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1557],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>c});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),o=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=o(e.components);return a.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),k=o(n),c=r,m=k["".concat(p,".").concat(c)]||k[c]||u[c]||i;return n?a.createElement(m,l(l({ref:t},s),{},{components:n})):a.createElement(m,l({ref:t},s))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=k;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,d={unversionedId:"sdk/reference/classes/Account",id:"sdk/reference/classes/Account",title:"Account",description:"@vocdoni/sdk / Exports / Account",source:"@site/docs/sdk/reference/classes/Account.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Account",permalink:"/sdk/reference/classes/Account",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Quadratic voting",permalink:"/sdk/integration-details/voting-types/quadratic"},next:{title:"AccountAPI",permalink:"/sdk/reference/classes/AccountAPI"}},p={},o=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_avatar",id:"_avatar",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"_description",id:"_description",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"_feed",id:"_feed",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"_header",id:"_header",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"_languages",id:"_languages",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"_logo",id:"_logo",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"_meta",id:"_meta",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"_name",id:"_name",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"avatar",id:"avatar",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"description",id:"description",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"feed",id:"feed",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"header",id:"header",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"languages",id:"languages",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"logo",id:"logo",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"meta",id:"meta",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"name",id:"name",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"Methods",id:"methods-1",level:2},{value:"generateMetadata",id:"generatemetadata",level:3},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"build",id:"build",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-26",level:4}],s={toc:o};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / Account"),(0,r.kt)("h1",{id:"class-account"},"Class: Account"),(0,r.kt)("p",null,"Represents an account"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Account#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#_avatar"},"_","avatar")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#_description"},"_","description")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#_feed"},"_","feed")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#_header"},"_","header")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#_languages"},"_","languages")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#_logo"},"_","logo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#_meta"},"_","meta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account#_name"},"_","name"))),(0,r.kt)("h3",{id:"accessors"},"Accessors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Account#avatar"},"avatar")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Account#description"},"description")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Account#feed"},"feed")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Account#header"},"header")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Account#languages"},"languages")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Account#logo"},"logo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Account#meta"},"meta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Account#name"},"name"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Account#generatemetadata"},"generateMetadata")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Account#build"},"build"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new Account"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,r.kt)("a",{parentName:"p",href:"Account"},(0,r.kt)("inlineCode",{parentName:"a"},"Account"))),(0,r.kt)("p",null,"Constructs an account"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../interfaces/IAccount"},(0,r.kt)("inlineCode",{parentName:"a"},"IAccount"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Account parameters")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"Account"},(0,r.kt)("inlineCode",{parentName:"a"},"Account"))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L33"},"types/account.ts:33")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"_avatar"},"_","avatar"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","avatar"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L24"},"types/account.ts:24")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_description"},"_","description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L21"},"types/account.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_feed"},"_","feed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","feed"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L22"},"types/account.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_header"},"_","header"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","header"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L23"},"types/account.ts:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_languages"},"_","languages"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","languages"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L19"},"types/account.ts:19")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_logo"},"_","logo"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","logo"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L25"},"types/account.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_meta"},"_","meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","meta"),": ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"value"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }[]"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L26"},"types/account.ts:26")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_name"},"_","name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L20"},"types/account.ts:20")),(0,r.kt)("h2",{id:"accessors-1"},"Accessors"),(0,r.kt)("h3",{id:"avatar"},"avatar"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"avatar"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L108"},"types/account.ts:108")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"avatar"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L112"},"types/account.ts:112")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"description"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L92"},"types/account.ts:92")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"description"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L96"},"types/account.ts:96")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"feed"},"feed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"feed"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L124"},"types/account.ts:124")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"feed"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L128"},"types/account.ts:128")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"header"},"header"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"header"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L100"},"types/account.ts:100")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"header"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L104"},"types/account.ts:104")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"languages"},"languages"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"languages"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L140"},"types/account.ts:140")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"languages"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L144"},"types/account.ts:144")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"logo"},"logo"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"logo"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L116"},"types/account.ts:116")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"logo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L120"},"types/account.ts:120")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"meta"),"(): ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"value"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }[]"),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,"{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"value"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }[]"),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L132"},"types/account.ts:132")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"meta"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{"," ",(0,r.kt)("inlineCode",{parentName:"td"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"value"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any")," }[]")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L136"},"types/account.ts:136")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"name"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L84"},"types/account.ts:84")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"name"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L88"},"types/account.ts:88")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"generatemetadata"},"generateMetadata"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"generateMetadata"),"(): ",(0,r.kt)("a",{parentName:"p",href:"../interfaces/AccountMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountMetadata"))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"../interfaces/AccountMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountMetadata"))),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L65"},"types/account.ts:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"build"},"build"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"build"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,r.kt)("a",{parentName:"p",href:"Account"},(0,r.kt)("inlineCode",{parentName:"a"},"Account"))),(0,r.kt)("p",null,"Returns an account object"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../interfaces/IAccount"},(0,r.kt)("inlineCode",{parentName:"a"},"IAccount"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Account parameters")))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"Account"},(0,r.kt)("inlineCode",{parentName:"a"},"Account"))),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L61"},"types/account.ts:61")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5a8bd590.925093b5.js b/assets/js/5a8bd590.925093b5.js new file mode 100644 index 000000000..bc6bbb72a --- /dev/null +++ b/assets/js/5a8bd590.925093b5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9090],{3905:(e,t,o)=>{o.d(t,{Zo:()=>h,kt:()=>u});var n=o(67294);function r(e,t,o){return t in e?Object.defineProperty(e,t,{value:o,enumerable:!0,configurable:!0,writable:!0}):e[t]=o,e}function a(e,t){var o=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),o.push.apply(o,n)}return o}function s(e){for(var t=1;t=0||(r[o]=e[o]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,o)&&(r[o]=e[o])}return r}var c=n.createContext({}),l=function(e){var t=n.useContext(c),o=t;return e&&(o="function"==typeof e?e(t):s(s({},t),e)),o},h=function(e){var t=l(e.components);return n.createElement(c.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var o=e.components,r=e.mdxType,a=e.originalType,c=e.parentName,h=i(e,["components","mdxType","originalType","parentName"]),d=l(o),u=r,f=d["".concat(c,".").concat(u)]||d[u]||p[u]||a;return o?n.createElement(f,s(s({ref:t},h),{},{components:o})):n.createElement(f,s({ref:t},h))}));function u(e,t){var o=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=o.length,s=new Array(a);s[0]=d;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i.mdxType="string"==typeof e?e:r,s[1]=i;for(var l=2;l{o.r(t),o.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var n=o(87462),r=(o(67294),o(3905));const a={},s="On-Chain Census",i={unversionedId:"protocol/census/on-chain",id:"protocol/census/on-chain",title:"On-Chain Census",description:"There are two types of census origins: Those who depend on a list of public keys maintained off-chain and those dependent on the status of the Ethereum blockchain at a given point in time.",source:"@site/docs/protocol/census/on-chain.md",sourceDirName:"protocol/census",slug:"/protocol/census/on-chain",permalink:"/protocol/census/on-chain",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Off-Chain Tree Census",permalink:"/protocol/census/off-chain-tree"},next:{title:"Data Schemes",permalink:"/protocol/data-schemes/"}},c={},l=[{value:"ERC-20 Token Storage Proofs",id:"erc-20-token-storage-proofs",level:3},{value:"Token Registration",id:"token-registration",level:3},{value:"Election creation",id:"election-creation",level:3},{value:"Voting",id:"voting",level:3}],h={toc:l};function p(e){let{components:t,...o}=e;return(0,r.kt)("wrapper",(0,n.Z)({},h,o,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"on-chain-census"},"On-Chain Census"),(0,r.kt)("p",null,"There are two types of census origins: Those who depend on a list of public keys maintained off-chain and those dependent on the status of the Ethereum blockchain at a given point in time."),(0,r.kt)("p",null,"The second case, referred to as an on-chain census, enables the weighted set of eligible voters for a process to be derived from the token holder balances for some ERC-20 Ethereum token. This is possible through the use of Ethereum Storage Proofs."),(0,r.kt)("admonition",{title:"census3",type:"tip"},(0,r.kt)("p",{parentName:"admonition"},"This page describes how the token-based census works at a low-level. In order to facilitate the usage of token-based censuses, we provide the ",(0,r.kt)("a",{parentName:"p",href:"/sdk/integration-details/census-types/on-chain"},"Census3")," service. The Census3 Service is an API service which provides an easy way to create censuses for elections with holders of a single token or a combination of them. This is a wrapper of the on-chain census design and enables integrators to use on-chain censuses without manually registering tokens or generating storage proofs.")),(0,r.kt)("h3",{id:"erc-20-token-storage-proofs"},"ERC-20 Token Storage Proofs"),(0,r.kt)("p",null,"Each Ethereum account has its own Storage Trie, which is where all of the contract data lives for that account. A 256-bit hash of the storage trie\u2019s root node is stored as the storageRoot value in the global Ethereum state trie. In the context of storage proofs, we are concerned with ERC-20 Token Smart Contract accounts, whose Storage Tries contain the list of token balances of each token holder. "),(0,r.kt)("p",null,"A storage proof is a Merkle Proof computed on this storage trie. For the scope of this proposal, the storage proof allows anyone to demonstrate the balance of a token holder for a given ERC-20 token, at a specific State Root Hash (Ethereum block). In other words, we can cheaply generate a proof of any user's balance of a token, and this proof can be used in a Vocdoni voting census. "),(0,r.kt)("h3",{id:"token-registration"},"Token Registration"),(0,r.kt)("p",null,"Before starting an election, the target token needs to be registered to the Token StorageProof Smart Contract. Any token holder can register the token by providing a valid storage proof."),(0,r.kt)("p",null,"In order to create a storage proof, on a mapping-based ERC20 contract, the ",(0,r.kt)("inlineCode",{parentName:"p"},"index slot")," must be found. This depends on the contract implementation and refers to the storage layout of the Ethereum EVM. Most of the ",(0,r.kt)("inlineCode",{parentName:"p"},"index slots")," are between 1 and 10. "),(0,r.kt)("p",null,"The user registering a new token must first try to find the index slot. To this aim, a web-frontend and a typescript library will be available. Once the index slot is found, the user must send a transaction to the Token StorageProof SC indicating the ",(0,r.kt)("inlineCode",{parentName:"p"},"index slot")," and providing the Merkle proof that demonstrates the index slot and their possession of the token. "),(0,r.kt)("h3",{id:"election-creation"},"Election creation"),(0,r.kt)("p",null,"When a token holder wants to create a process with an on-chain census origin, they must send a transaction to the Vocdoni Smart Contract with the election process details, including the token contract address for which the process is being created.\nThe Smart Contract will check if the sender holds some minimum threshold tokens on the ERC20 contract address. "),(0,r.kt)("h3",{id:"voting"},"Voting"),(0,r.kt)("p",null,"In order to cast a vote, each user needs to fetch their Census Merkle Proof. The client connects to a Web3 endpoint and uses the RPC call ",(0,r.kt)("inlineCode",{parentName:"p"},"eth_getProof")," to retrieve this proof."),(0,r.kt)("p",null,"Once the user decides to cast a vote, a package will be forged containing the census proof, vote choice (represented as an array of integers) and signature (using Metamask)."),(0,r.kt)("p",null,"The transaction of sending a vote is as follows:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-json"},'{\n "eth_getProof": { \n "type":"vote",\n "processId": "0x47384...",\n "weight": "0x123",\n "proof": "MerkleProof",\n "votePackage": "base64encoded vote package",\n "signature": "signature performed with the privkey that computes the address"\n }\n}\n')),(0,r.kt)("p",null,"The vote will be considered valid only if the signature computes an Ethereum address for which\xa0the provided Merkle proof and its weight (balance) is valid for the census root hash (Ethereum storage root) at the height of the process start block."),(0,r.kt)("p",null,"The storage proofs contract acts as a registry which allows token holders to prove that they held funds at a given point in time and therefore are eligible voters for a process."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5a8bd590.dd39520e.js b/assets/js/5a8bd590.dd39520e.js deleted file mode 100644 index 18a8e3082..000000000 --- a/assets/js/5a8bd590.dd39520e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9090],{3905:(e,t,o)=>{o.d(t,{Zo:()=>h,kt:()=>u});var n=o(67294);function r(e,t,o){return t in e?Object.defineProperty(e,t,{value:o,enumerable:!0,configurable:!0,writable:!0}):e[t]=o,e}function a(e,t){var o=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),o.push.apply(o,n)}return o}function s(e){for(var t=1;t=0||(r[o]=e[o]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,o)&&(r[o]=e[o])}return r}var c=n.createContext({}),l=function(e){var t=n.useContext(c),o=t;return e&&(o="function"==typeof e?e(t):s(s({},t),e)),o},h=function(e){var t=l(e.components);return n.createElement(c.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var o=e.components,r=e.mdxType,a=e.originalType,c=e.parentName,h=i(e,["components","mdxType","originalType","parentName"]),d=l(o),u=r,f=d["".concat(c,".").concat(u)]||d[u]||p[u]||a;return o?n.createElement(f,s(s({ref:t},h),{},{components:o})):n.createElement(f,s({ref:t},h))}));function u(e,t){var o=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=o.length,s=new Array(a);s[0]=d;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i.mdxType="string"==typeof e?e:r,s[1]=i;for(var l=2;l{o.r(t),o.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var n=o(87462),r=(o(67294),o(3905));const a={},s="On-Chain Census",i={unversionedId:"protocol/census/on-chain",id:"protocol/census/on-chain",title:"On-Chain Census",description:"There are two types of census origins: Those who depend on a list of public keys maintained off-chain and those dependent on the status of the Ethereum blockchain at a given point in time.",source:"@site/docs/protocol/census/on-chain.md",sourceDirName:"protocol/census",slug:"/protocol/census/on-chain",permalink:"/protocol/census/on-chain",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Off-Chain Tree Census",permalink:"/protocol/census/off-chain-tree"},next:{title:"Data Schemes",permalink:"/protocol/data-schemes/"}},c={},l=[{value:"ERC-20 Token Storage Proofs",id:"erc-20-token-storage-proofs",level:3},{value:"Token Registration",id:"token-registration",level:3},{value:"Election creation",id:"election-creation",level:3},{value:"Voting",id:"voting",level:3}],h={toc:l};function p(e){let{components:t,...o}=e;return(0,r.kt)("wrapper",(0,n.Z)({},h,o,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"on-chain-census"},"On-Chain Census"),(0,r.kt)("p",null,"There are two types of census origins: Those who depend on a list of public keys maintained off-chain and those dependent on the status of the Ethereum blockchain at a given point in time."),(0,r.kt)("p",null,"The second case, referred to as an on-chain census, enables the weighted set of eligible voters for a process to be derived from the token holder balances for some ERC-20 Ethereum token. This is possible through the use of Ethereum Storage Proofs."),(0,r.kt)("h3",{id:"erc-20-token-storage-proofs"},"ERC-20 Token Storage Proofs"),(0,r.kt)("p",null,"Each Ethereum account has its own Storage Trie, which is where all of the contract data lives for that account. A 256-bit hash of the storage trie\u2019s root node is stored as the storageRoot value in the global Ethereum state trie. In the context of storage proofs, we are concerned with ERC-20 Token Smart Contract accounts, whose Storage Tries contain the list of token balances of each token holder. "),(0,r.kt)("p",null,"A storage proof is a Merkle Proof computed on this storage trie. For the scope of this proposal, the storage proof allows anyone to demonstrate the balance of a token holder for a given ERC-20 token, at a specific State Root Hash (Ethereum block). In other words, we can cheaply generate a proof of any user's balance of a token, and this proof can be used in a Vocdoni voting census. "),(0,r.kt)("h3",{id:"token-registration"},"Token Registration"),(0,r.kt)("p",null,"Before starting an election, the target token needs to be registered to the Token StorageProof Smart Contract. Any token holder can register the token by providing a valid storage proof."),(0,r.kt)("p",null,"In order to create a storage proof, on a mapping-based ERC20 contract, the ",(0,r.kt)("inlineCode",{parentName:"p"},"index slot")," must be found. This depends on the contract implementation and refers to the storage layout of the Ethereum EVM. Most of the ",(0,r.kt)("inlineCode",{parentName:"p"},"index slots")," are between 1 and 10. "),(0,r.kt)("p",null,"The user registering a new token must first try to find the index slot. To this aim, a web-frontend and a typescript library will be available. Once the index slot is found, the user must send a transaction to the Token StorageProof SC indicating the ",(0,r.kt)("inlineCode",{parentName:"p"},"index slot")," and providing the Merkle proof that demonstrates the index slot and their possession of the token. "),(0,r.kt)("h3",{id:"election-creation"},"Election creation"),(0,r.kt)("p",null,"When a token holder wants to create a process with an on-chain census origin, they must send a transaction to the Vocdoni Smart Contract with the election process details, including the token contract address for which the process is being created.\nThe Smart Contract will check if the sender holds some minimum threshold tokens on the ERC20 contract address. "),(0,r.kt)("h3",{id:"voting"},"Voting"),(0,r.kt)("p",null,"In order to cast a vote, each user needs to fetch their Census Merkle Proof. The client connects to a Web3 endpoint and uses the RPC call ",(0,r.kt)("inlineCode",{parentName:"p"},"eth_getProof")," to retrieve this proof."),(0,r.kt)("p",null,"Once the user decides to cast a vote, a package will be forged containing the census proof, vote choice (represented as an array of integers) and signature (using Metamask)."),(0,r.kt)("p",null,"The transaction of sending a vote is as follows:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-json"},'{\n "eth_getProof": { \n "type":"vote",\n "processId": "0x47384...",\n "weight": "0x123",\n "proof": "MerkleProof",\n "votePackage": "base64encoded vote package",\n "signature": "signature performed with the privkey that computes the address"\n }\n}\n')),(0,r.kt)("p",null,"The vote will be considered valid only if the signature computes an Ethereum address for which\xa0the provided Merkle proof and its weight (balance) is valid for the census root hash (Ethereum storage root) at the height of the process start block."),(0,r.kt)("p",null,"The storage proofs contract acts as a registry which allows token holders to prove that they held funds at a given point in time and therefore are eligible voters for a process."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5c98d4ea.1adb6ca5.js b/assets/js/5c98d4ea.1adb6ca5.js deleted file mode 100644 index dec3eed12..000000000 --- a/assets/js/5c98d4ea.1adb6ca5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4182],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var i=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function r(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=i.createContext({}),p=function(e){var t=i.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},c=function(e){var t=p(e.components);return i.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},d=i.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),d=p(n),m=o,f=d["".concat(s,".").concat(m)]||d[m]||u[m]||a;return n?i.createElement(f,r(r({ref:t},c),{},{components:n})):i.createElement(f,r({ref:t},c))}));function m(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,r=new Array(a);r[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:o,r[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>r,default:()=>u,frontMatter:()=>a,metadata:()=>l,toc:()=>p});var i=n(87462),o=(n(67294),n(3905));const a={},r=void 0,l={unversionedId:"sdk/reference/interfaces/IVoteType",id:"sdk/reference/interfaces/IVoteType",title:"IVoteType",description:"@vocdoni/sdk / Exports / IVoteType",source:"@site/docs/sdk/reference/interfaces/IVoteType.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IVoteType",permalink:"/sdk/reference/interfaces/IVoteType",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IVoteSubmitResponse",permalink:"/sdk/reference/interfaces/IVoteSubmitResponse"},next:{title:"MintTokensTx",permalink:"/sdk/reference/interfaces/MintTokensTx"}},s={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"costExponent",id:"costexponent",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"costFromWeight",id:"costfromweight",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"maxCount",id:"maxcount",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"maxTotalCost",id:"maxtotalcost",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"maxValue",id:"maxvalue",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"maxVoteOverwrites",id:"maxvoteoverwrites",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"uniqueChoices",id:"uniquechoices",level:3},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:p};function u(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,i.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IVoteType"),(0,o.kt)("h1",{id:"interface-ivotetype"},"Interface: IVoteType"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteType#costexponent"},"costExponent")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteType#costfromweight"},"costFromWeight")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteType#maxcount"},"maxCount")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteType#maxtotalcost"},"maxTotalCost")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteType#maxvalue"},"maxValue")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteType#maxvoteoverwrites"},"maxVoteOverwrites")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteType#uniquechoices"},"uniqueChoices"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"costexponent"},"costExponent"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"costExponent"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"Defines the ",(0,o.kt)("inlineCode",{parentName:"p"},"costExponent"),', which is used in the computation of the total "cost" of the voted options.\nThis total cost is later compared against ',(0,o.kt)("inlineCode",{parentName:"p"},"maxTotalCost"),"."),(0,o.kt)("p",null,"The formula used to calculate the total cost is:\ntotalCost = \u03a3 (value","[i]"," ^ costExponent) <= maxTotalCost"),(0,o.kt)("p",null,"To establish a quadratic voting election, the ",(0,o.kt)("inlineCode",{parentName:"p"},"costExponent")," must be set to 2. As an illustration, consider a vote\narray of ",(0,o.kt)("inlineCode",{parentName:"p"},"[3,4]")," where:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("inlineCode",{parentName:"li"},"3")," represents the credits assigned to option 0,"),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("inlineCode",{parentName:"li"},"4")," represents the credits given to option 1.")),(0,o.kt)("p",null,"The total credits spent are calculated as:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"3^2 = 9 (Credits for option 0)\n4^2 = 16 (Credits for option 1)\nTotal = 25 (Total credits spent)\n")),(0,o.kt)("p",null,"The total credits available for spending (i.e., ",(0,o.kt)("inlineCode",{parentName:"p"},"maxTotalCost"),") can be set in two ways during the election creation:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"By explicitly defining the ",(0,o.kt)("inlineCode",{parentName:"li"},"maxTotalCost")," parameter to set up same amount of credits for each voter,"),(0,o.kt)("li",{parentName:"ul"},"By setting the ",(0,o.kt)("inlineCode",{parentName:"li"},"costFromWeight")," parameter to ",(0,o.kt)("inlineCode",{parentName:"li"},"true")," and using a weighted census. In this method, the weight\nassigned to each voter determines the credits they have available for voting.")),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L46"},"types/election/election.ts:46")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"costfromweight"},"costFromWeight"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"costFromWeight"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")),(0,o.kt)("p",null,"For weighted census, the user's balance will be used as the ",(0,o.kt)("inlineCode",{parentName:"p"},"maxCost"),". This allows splitting the voting power among\nseveral choices, even including quadratic voting scenarios."),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L20"},"types/election/election.ts:20")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"maxcount"},"maxCount"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"maxCount"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"Determines the maximum count or number of votes that can be cast across all fields.\nThe default value corresponds to the total number of questions available in the voting process."),(0,o.kt)("p",null,"For elections involving multiple questions (multiquestion elections), this value should be equivalent to the total\nnumber of questions. In contrast, for elections that don't involve multiple questions (non-multiquestion elections),\nthis value should match the total number of choices available for voting."),(0,o.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L62"},"types/election/election.ts:62")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"maxtotalcost"},"maxTotalCost"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"maxTotalCost"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"Specifies the maximum limit on the total sum of all ballot fields' values, if applicable.\nFor instance, if the vote array is ",(0,o.kt)("inlineCode",{parentName:"p"},"[0,0,3,2]"),", the ",(0,o.kt)("inlineCode",{parentName:"p"},"maxTotalCost")," should be set to ",(0,o.kt)("inlineCode",{parentName:"p"},"3"),"."),(0,o.kt)("p",null,"A value of 0 implies no maximum limit or that this parameter is not applicable in the current voting context."),(0,o.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L69"},"types/election/election.ts:69")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"maxvalue"},"maxValue"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"maxValue"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"Defines the maximum acceptable value for all fields in the voting process.\nBy default, this value corresponds to the total number of choices available in a question."),(0,o.kt)("p",null,"In the context of a quadratic voting system, this value should typically be set to 0."),(0,o.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L53"},"types/election/election.ts:53")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"maxvoteoverwrites"},"maxVoteOverwrites"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"maxVoteOverwrites"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"The number of times a voter con overwrite its vote (change vote option)."),(0,o.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L15"},"types/election/election.ts:15")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"uniquechoices"},"uniqueChoices"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,o.kt)("strong",{parentName:"p"},"uniqueChoices"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"boolean")),(0,o.kt)("p",null,"Voter can only select one answer for question"),(0,o.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L11"},"types/election/election.ts:11")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5c98d4ea.5990328f.js b/assets/js/5c98d4ea.5990328f.js new file mode 100644 index 000000000..bff276ca5 --- /dev/null +++ b/assets/js/5c98d4ea.5990328f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4182],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var o=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=o.createContext({}),p=function(e){var t=o.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=p(e.components);return o.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},d=o.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,c=r(e,["components","mdxType","originalType","parentName"]),d=p(n),m=i,f=d["".concat(s,".").concat(m)]||d[m]||u[m]||a;return n?o.createElement(f,l(l({ref:t},c),{},{components:n})):o.createElement(f,l({ref:t},c))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=d;var r={};for(var s in t)hasOwnProperty.call(t,s)&&(r[s]=t[s]);r.originalType=e,r.mdxType="string"==typeof e?e:i,l[1]=r;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>u,frontMatter:()=>a,metadata:()=>r,toc:()=>p});var o=n(87462),i=(n(67294),n(3905));const a={},l=void 0,r={unversionedId:"sdk/reference/interfaces/IVoteType",id:"sdk/reference/interfaces/IVoteType",title:"IVoteType",description:"@vocdoni/sdk / Exports / IVoteType",source:"@site/docs/sdk/reference/interfaces/IVoteType.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IVoteType",permalink:"/sdk/reference/interfaces/IVoteType",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IVoteSubmitResponse",permalink:"/sdk/reference/interfaces/IVoteSubmitResponse"},next:{title:"MintTokensTx",permalink:"/sdk/reference/interfaces/MintTokensTx"}},s={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"costExponent",id:"costexponent",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"costFromWeight",id:"costfromweight",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"maxCount",id:"maxcount",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"maxTotalCost",id:"maxtotalcost",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"maxValue",id:"maxvalue",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"maxVoteOverwrites",id:"maxvoteoverwrites",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"uniqueChoices",id:"uniquechoices",level:3},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:p};function u(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,o.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IVoteType"),(0,i.kt)("h1",{id:"interface-ivotetype"},"Interface: IVoteType"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IVoteType#costexponent"},"costExponent")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IVoteType#costfromweight"},"costFromWeight")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IVoteType#maxcount"},"maxCount")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IVoteType#maxtotalcost"},"maxTotalCost")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IVoteType#maxvalue"},"maxValue")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IVoteType#maxvoteoverwrites"},"maxVoteOverwrites")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IVoteType#uniquechoices"},"uniqueChoices"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"costexponent"},"costExponent"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"costExponent"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Defines the ",(0,i.kt)("inlineCode",{parentName:"p"},"costExponent"),', which is used in the computation of the total "cost" of the voted options.\nThis total cost is later compared against ',(0,i.kt)("inlineCode",{parentName:"p"},"maxTotalCost"),"."),(0,i.kt)("p",null,"The formula used to calculate the total cost is:\ntotalCost = \u03a3 (value","[i]"," ^ costExponent) <= maxTotalCost"),(0,i.kt)("p",null,"To establish a quadratic voting election, the ",(0,i.kt)("inlineCode",{parentName:"p"},"costExponent")," must be set to 2. As an illustration, consider a vote\narray of ",(0,i.kt)("inlineCode",{parentName:"p"},"[3,4]")," where:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"3")," represents the credits assigned to option 0,"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"4")," represents the credits given to option 1.")),(0,i.kt)("p",null,"The total credits spent are calculated as:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre"},"3^2 = 9 (Credits for option 0)\n4^2 = 16 (Credits for option 1)\nTotal = 25 (Total credits spent)\n")),(0,i.kt)("p",null,"The total credits available for spending (i.e., ",(0,i.kt)("inlineCode",{parentName:"p"},"maxTotalCost"),") can be set in two ways during the election creation:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"By explicitly defining the ",(0,i.kt)("inlineCode",{parentName:"li"},"maxTotalCost")," parameter to set up same amount of credits for each voter,"),(0,i.kt)("li",{parentName:"ul"},"By setting the ",(0,i.kt)("inlineCode",{parentName:"li"},"costFromWeight")," parameter to ",(0,i.kt)("inlineCode",{parentName:"li"},"true")," and using a weighted census. In this method, the weight\nassigned to each voter determines the credits they have available for voting.")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L46"},"types/election/election.ts:46")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"costfromweight"},"costFromWeight"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"costFromWeight"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"For weighted census, the user's balance will be used as the ",(0,i.kt)("inlineCode",{parentName:"p"},"maxCost"),". This allows splitting the voting power among\nseveral choices, even including quadratic voting scenarios."),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L20"},"types/election/election.ts:20")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxcount"},"maxCount"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"maxCount"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Determines the maximum count or number of votes that can be cast across all fields.\nThe default value corresponds to the total number of questions available in the voting process."),(0,i.kt)("p",null,"For elections involving multiple questions (multiquestion elections), this value should be equivalent to the total\nnumber of questions. In contrast, for elections that don't involve multiple questions (non-multiquestion elections),\nthis value should match the total number of choices available for voting."),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L62"},"types/election/election.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxtotalcost"},"maxTotalCost"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"maxTotalCost"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Specifies the maximum limit on the total sum of all ballot fields' values, if applicable.\nFor instance, if the vote array is ",(0,i.kt)("inlineCode",{parentName:"p"},"[0,0,3,2]"),", the ",(0,i.kt)("inlineCode",{parentName:"p"},"maxTotalCost")," should be set to ",(0,i.kt)("inlineCode",{parentName:"p"},"3"),"."),(0,i.kt)("p",null,"A value of 0 implies no maximum limit or that this parameter is not applicable in the current voting context."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L69"},"types/election/election.ts:69")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxvalue"},"maxValue"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"maxValue"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Defines the maximum acceptable value for all fields in the voting process.\nBy default, this value corresponds to the total number of choices available in a question."),(0,i.kt)("p",null,"In the context of a quadratic voting system, this value should typically be set to 0."),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L53"},"types/election/election.ts:53")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxvoteoverwrites"},"maxVoteOverwrites"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"maxVoteOverwrites"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The number of times a voter con overwrite its vote (change vote option)."),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L15"},"types/election/election.ts:15")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"uniquechoices"},"uniqueChoices"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"uniqueChoices"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Voter can only select one answer for question"),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L11"},"types/election/election.ts:11")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5ddc4d53.15dc5e26.js b/assets/js/5ddc4d53.15dc5e26.js deleted file mode 100644 index d5960d2f0..000000000 --- a/assets/js/5ddc4d53.15dc5e26.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6990],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>k});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var d=n.createContext({}),s=function(e){var t=n.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},p=function(e){var t=s(e.components);return n.createElement(d.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),u=s(r),k=a,m=u["".concat(d,".").concat(k)]||u[k]||c[k]||i;return r?n.createElement(m,l(l({ref:t},p),{},{components:r})):n.createElement(m,l({ref:t},p))}));function k(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=u;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var s=2;s{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>s});var n=r(87462),a=(r(67294),r(3905));const i={},l=void 0,o={unversionedId:"sdk/reference/classes/FaucetAPI",id:"sdk/reference/classes/FaucetAPI",title:"FaucetAPI",description:"@vocdoni/sdk / Exports / FaucetAPI",source:"@site/docs/sdk/reference/classes/FaucetAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/FaucetAPI",permalink:"/sdk/reference/classes/FaucetAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ElectionService",permalink:"/sdk/reference/classes/ElectionService"},next:{title:"FaucetService",permalink:"/sdk/reference/classes/FaucetService"}},d={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"collect",id:"collect",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4}],p={toc:s};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / FaucetAPI"),(0,a.kt)("h1",{id:"class-faucetapi"},"Class: FaucetAPI"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"API")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"FaucetAPI"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FaucetAPI#constructor"},"constructor"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FaucetAPI#collect"},"collect")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FaucetAPI#isapierror"},"isApiError")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FaucetAPI#isundefinederror"},"isUndefinedError"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new FaucetAPI"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/FaucetAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"FaucetAPI"))),(0,a.kt)("p",null,"Cannot be constructed."),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/FaucetAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"FaucetAPI"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"API.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/faucet.ts#L24"},"api/faucet.ts:24")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"collect"},"collect"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"collect"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"address"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"IFaucetCollectResponse"),">"),(0,a.kt)("p",null,"Calls the collect tokens method."),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"url")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"address")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"Address to send the tokens to")))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"IFaucetCollectResponse"),">"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/faucet.ts#L35"},"api/faucet.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isapierror"},"isApiError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"API.isApiError"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L21"},"api/api.ts:21")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"API.isUndefinedError"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L64"},"api/api.ts:64")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5ddc4d53.28287519.js b/assets/js/5ddc4d53.28287519.js new file mode 100644 index 000000000..28cce8438 --- /dev/null +++ b/assets/js/5ddc4d53.28287519.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6990],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>k});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var d=n.createContext({}),p=function(e){var t=n.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(d.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),u=p(r),k=a,m=u["".concat(d,".").concat(k)]||u[k]||c[k]||i;return r?n.createElement(m,l(l({ref:t},s),{},{components:r})):n.createElement(m,l({ref:t},s))}));function k(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=u;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var p=2;p{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var n=r(87462),a=(r(67294),r(3905));const i={},l=void 0,o={unversionedId:"sdk/reference/classes/FaucetAPI",id:"sdk/reference/classes/FaucetAPI",title:"FaucetAPI",description:"@vocdoni/sdk / Exports / FaucetAPI",source:"@site/docs/sdk/reference/classes/FaucetAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/FaucetAPI",permalink:"/sdk/reference/classes/FaucetAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ElectionService",permalink:"/sdk/reference/classes/ElectionService"},next:{title:"FaucetService",permalink:"/sdk/reference/classes/FaucetService"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"collect",id:"collect",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / FaucetAPI"),(0,a.kt)("h1",{id:"class-faucetapi"},"Class: FaucetAPI"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"API")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"FaucetAPI"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"FaucetAPI#constructor"},"constructor"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"FaucetAPI#collect"},"collect")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"FaucetAPI#isapierror"},"isApiError")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"FaucetAPI#isundefinederror"},"isUndefinedError"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new FaucetAPI"),"(): ",(0,a.kt)("a",{parentName:"p",href:"FaucetAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"FaucetAPI"))),(0,a.kt)("p",null,"Cannot be constructed."),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"FaucetAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"FaucetAPI"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"API.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/faucet.ts#L24"},"api/faucet.ts:24")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"collect"},"collect"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"collect"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"address"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"IFaucetCollectResponse"),">"),(0,a.kt)("p",null,"Calls the collect tokens method."),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"url")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"address")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"Address to send the tokens to")))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"IFaucetCollectResponse"),">"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/faucet.ts#L35"},"api/faucet.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isapierror"},"isApiError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"API.isApiError"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L21"},"api/api.ts:21")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"API.isUndefinedError"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L64"},"api/api.ts:64")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5f8415ed.a94dc4ae.js b/assets/js/5f8415ed.a94dc4ae.js deleted file mode 100644 index 8110289dd..000000000 --- a/assets/js/5f8415ed.a94dc4ae.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9347],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},y=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),y=p(n),m=o,f=y["".concat(l,".").concat(m)]||y[m]||u[m]||a;return n?r.createElement(f,i(i({ref:t},c),{},{components:n})):r.createElement(f,i({ref:t},c))}));function m(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,i=new Array(a);i[0]=y;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:o,i[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>p});var r=n(87462),o=(n(67294),n(3905));const a={},i="Anonymous Voting",s={unversionedId:"protocol/anonymity/anonymity",id:"protocol/anonymity/anonymity",title:"Anonymous Voting",description:"- Anonymous voting is a type of voting process where the users can vote without revealing their identity, by proving that they are accepted as valid voters. Currently we have 2 types of anonymous voting schemes:",source:"@site/docs/protocol/anonymity/anonymity.md",sourceDirName:"protocol/anonymity",slug:"/protocol/anonymity/",permalink:"/protocol/anonymity/",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Vocdoni Protocol",permalink:"/protocol/"},next:{title:"CSP Blind Signatures",permalink:"/protocol/anonymity/blind-signatures"}},l={},p=[],c={toc:p};function u(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"anonymous-voting"},"Anonymous Voting"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("strong",{parentName:"li"},"Anonymous voting")," is a type of voting process where the users can vote without revealing their identity, by proving that they are accepted as valid voters. Currently we have 2 types of ",(0,o.kt)("em",{parentName:"li"},"anonymous voting")," schemes:",(0,o.kt)("ul",{parentName:"li"},(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/protocol/anonymity/zk-census-proof"},"Anonymous voting with ",(0,o.kt)("strong",{parentName:"a"},"zk census proof")),": type of ",(0,o.kt)("em",{parentName:"li"},"anonymous voting")," where the user proves their ability to vote through a zk census proof (franchise proof)."),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/protocol/anonymity/blind-signatures"},"Anonymous voting with ",(0,o.kt)("strong",{parentName:"a"},"blind signatures")),": type of ",(0,o.kt)("em",{parentName:"li"},"anonymous voting")," using blind signatures.")))))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5f8415ed.dee91760.js b/assets/js/5f8415ed.dee91760.js new file mode 100644 index 000000000..24180e7f7 --- /dev/null +++ b/assets/js/5f8415ed.dee91760.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9347],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var o=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=o.createContext({}),p=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=p(e.components);return o.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},y=o.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),y=p(n),m=r,f=y["".concat(l,".").concat(m)]||y[m]||u[m]||a;return n?o.createElement(f,i(i({ref:t},c),{},{components:n})):o.createElement(f,i({ref:t},c))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,i=new Array(a);i[0]=y;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:r,i[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>p});var o=n(87462),r=(n(67294),n(3905));const a={},i="Anonymous Voting",s={unversionedId:"protocol/anonymity/anonymity",id:"protocol/anonymity/anonymity",title:"Anonymous Voting",description:"- Anonymous voting is a type of voting process where the users can vote without revealing their identity, by proving that they are accepted as valid voters. Currently we have 2 types of anonymous voting schemes:",source:"@site/docs/protocol/anonymity/anonymity.md",sourceDirName:"protocol/anonymity",slug:"/protocol/anonymity/",permalink:"/protocol/anonymity/",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Vocdoni Protocol",permalink:"/protocol/"},next:{title:"CSP Blind Signatures",permalink:"/protocol/anonymity/blind-signatures"}},l={},p=[],c={toc:p};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,o.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"anonymous-voting"},"Anonymous Voting"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Anonymous voting")," is a type of voting process where the users can vote without revealing their identity, by proving that they are accepted as valid voters. Currently we have 2 types of ",(0,r.kt)("em",{parentName:"li"},"anonymous voting")," schemes:",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/protocol/anonymity/zk-census-proof"},"Anonymous voting with ",(0,r.kt)("strong",{parentName:"a"},"zk census proof")),": type of ",(0,r.kt)("em",{parentName:"li"},"anonymous voting")," where the user proves their ability to vote through a zk census proof (franchise proof)."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/protocol/anonymity/blind-signatures"},"Anonymous voting with ",(0,r.kt)("strong",{parentName:"a"},"blind signatures")),": type of ",(0,r.kt)("em",{parentName:"li"},"anonymous voting")," using blind signatures."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/protocol/anonymity/on-chain"},"Anonymous voting with ",(0,r.kt)("strong",{parentName:"a"},"token-based census")),": an implementation of ",(0,r.kt)("em",{parentName:"li"},"anonymous voting")," for on-chain token-based censuses.")))))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/64aa0b9a.1763944e.js b/assets/js/64aa0b9a.32f372bb.js similarity index 50% rename from assets/js/64aa0b9a.1763944e.js rename to assets/js/64aa0b9a.32f372bb.js index 09319efa5..24868a782 100644 --- a/assets/js/64aa0b9a.1763944e.js +++ b/assets/js/64aa0b9a.32f372bb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3038],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>k});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),s=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=s(e.components);return r.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),f=s(n),k=a,m=f["".concat(l,".").concat(k)]||f[k]||d[k]||i;return n?r.createElement(m,o(o({ref:t},c),{},{components:n})):r.createElement(m,o({ref:t},c))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=f;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p.mdxType="string"==typeof e?e:a,o[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var r=n(87462),a=(n(67294),n(3905));const i={},o=void 0,p={unversionedId:"sdk/reference/interfaces/IChainGetCostsResponse",id:"sdk/reference/interfaces/IChainGetCostsResponse",title:"IChainGetCostsResponse",description:"@vocdoni/sdk / Exports / IChainGetCostsResponse",source:"@site/docs/sdk/reference/interfaces/IChainGetCostsResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainGetCostsResponse",permalink:"/sdk/reference/interfaces/IChainGetCostsResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainGetCircuitResponse",permalink:"/sdk/reference/interfaces/IChainGetCircuitResponse"},next:{title:"IChainGetInfoResponse",permalink:"/sdk/reference/interfaces/IChainGetInfoResponse"}},l={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"basePrice",id:"baseprice",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"capacity",id:"capacity",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"factors",id:"factors",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:s};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IChainGetCostsResponse"),(0,a.kt)("h1",{id:"interface-ichaingetcostsresponse"},"Interface: IChainGetCostsResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetCostsResponse#baseprice"},"basePrice")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetCostsResponse#capacity"},"capacity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetCostsResponse#factors"},"factors"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"baseprice"},"basePrice"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"basePrice"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The base price."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L97"},"api/chain.ts:97")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"capacity"},"capacity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"capacity"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The capacity of the chain."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L102"},"api/chain.ts:102")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"factors"},"factors"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"factors"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("p",null,"The factors."),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"k1")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"k2")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"k3")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"k4")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"k5")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"k6")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"k7")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L107"},"api/chain.ts:107")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3038],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>k});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),s=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=s(e.components);return r.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),f=s(n),k=a,m=f["".concat(l,".").concat(k)]||f[k]||d[k]||i;return n?r.createElement(m,o(o({ref:t},c),{},{components:n})):r.createElement(m,o({ref:t},c))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=f;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p.mdxType="string"==typeof e?e:a,o[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var r=n(87462),a=(n(67294),n(3905));const i={},o=void 0,p={unversionedId:"sdk/reference/interfaces/IChainGetCostsResponse",id:"sdk/reference/interfaces/IChainGetCostsResponse",title:"IChainGetCostsResponse",description:"@vocdoni/sdk / Exports / IChainGetCostsResponse",source:"@site/docs/sdk/reference/interfaces/IChainGetCostsResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainGetCostsResponse",permalink:"/sdk/reference/interfaces/IChainGetCostsResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainGetCircuitResponse",permalink:"/sdk/reference/interfaces/IChainGetCircuitResponse"},next:{title:"IChainGetInfoResponse",permalink:"/sdk/reference/interfaces/IChainGetInfoResponse"}},l={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"basePrice",id:"baseprice",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"capacity",id:"capacity",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"factors",id:"factors",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:s};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IChainGetCostsResponse"),(0,a.kt)("h1",{id:"interface-ichaingetcostsresponse"},"Interface: IChainGetCostsResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetCostsResponse#baseprice"},"basePrice")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetCostsResponse#capacity"},"capacity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetCostsResponse#factors"},"factors"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"baseprice"},"basePrice"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"basePrice"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The base price."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L97"},"api/chain.ts:97")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"capacity"},"capacity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"capacity"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The capacity of the chain."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L102"},"api/chain.ts:102")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"factors"},"factors"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"factors"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("p",null,"The factors."),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"k1")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"k2")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"k3")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"k4")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"k5")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"k6")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"k7")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L107"},"api/chain.ts:107")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/64c2e320.170243a8.js b/assets/js/64c2e320.170243a8.js deleted file mode 100644 index 1ce289d2c..000000000 --- a/assets/js/64c2e320.170243a8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4246],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>c});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),s=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},o=function(e){var t=s(e.components);return a.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),m=s(n),c=r,u=m["".concat(p,".").concat(c)]||m[c]||k[c]||i;return n?a.createElement(u,l(l({ref:t},o),{},{components:n})):a.createElement(u,l({ref:t},o))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>d,toc:()=>s});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,d={unversionedId:"sdk/reference/classes/AnonymousService",id:"sdk/reference/classes/AnonymousService",title:"AnonymousService",description:"@vocdoni/sdk / Exports / AnonymousService",source:"@site/docs/sdk/reference/classes/AnonymousService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/AnonymousService",permalink:"/sdk/reference/classes/AnonymousService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"AccountService",permalink:"/sdk/reference/classes/AccountService"},next:{title:"AnonymousVote",permalink:"/sdk/reference/classes/AnonymousVote"}},p={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"chainCircuits",id:"chaincircuits",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"arbo_utils",id:"arbo_utils",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"ff_utils",id:"ff_utils",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"hex_utils",id:"hex_utils",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods-1",level:2},{value:"checkCircuitsHashes",id:"checkcircuitshashes",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetchAccountSIK",id:"fetchaccountsik",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"fetchCircuits",id:"fetchcircuits",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"fetchZKProof",id:"fetchzkproof",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"generateZkProof",id:"generatezkproof",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"hasRegisteredSIK",id:"hasregisteredsik",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"setCircuits",id:"setcircuits",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"signSIKPayload",id:"signsikpayload",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"calcCircuitInputs",id:"calccircuitinputs",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"calcNullifier",id:"calcnullifier",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"calcSik",id:"calcsik",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"calcVoteId",id:"calcvoteid",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"generateGroth16Proof",id:"generategroth16proof",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"prepareCircuitInputs",id:"preparecircuitinputs",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"signatureToVocdoniSikSignature",id:"signaturetovocdonisiksignature",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-20",level:4}],o={toc:s};function k(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / AnonymousService"),(0,r.kt)("h1",{id:"class-anonymousservice"},"Class: AnonymousService"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},(0,r.kt)("inlineCode",{parentName:"a"},"Service"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"AnonymousService"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"AnonymousServiceProperties"))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#chaincircuits"},"chainCircuits")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#url"},"url")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#arbo_utils"},"arbo","_","utils")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#ff_utils"},"ff","_","utils")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#hex_utils"},"hex","_","utils"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#checkcircuitshashes"},"checkCircuitsHashes")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#fetchaccountsik"},"fetchAccountSIK")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#fetchcircuits"},"fetchCircuits")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#fetchzkproof"},"fetchZKProof")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#generatezkproof"},"generateZkProof")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#hasregisteredsik"},"hasRegisteredSIK")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#setcircuits"},"setCircuits")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#signsikpayload"},"signSIKPayload")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#calccircuitinputs"},"calcCircuitInputs")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#calcnullifier"},"calcNullifier")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#calcsik"},"calcSik")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#calcvoteid"},"calcVoteId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#generategroth16proof"},"generateGroth16Proof")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#preparecircuitinputs"},"prepareCircuitInputs")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#signaturetovocdonisiksignature"},"signatureToVocdoniSikSignature"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new AnonymousService"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/AnonymousService"},(0,r.kt)("inlineCode",{parentName:"a"},"AnonymousService"))),(0,r.kt)("p",null,"Instantiate the anonymous service."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"AnonymousServiceParameters"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/AnonymousService"},(0,r.kt)("inlineCode",{parentName:"a"},"AnonymousService"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#constructor"},"constructor")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L71"},"services/anonymous.ts:71")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"chaincircuits"},"chainCircuits"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"chainCircuits"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,"AnonymousServiceProperties.chainCircuits"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L64"},"services/anonymous.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"url"},"url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#url"},"url")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/service.ts#L6"},"services/service.ts:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"arbo_utils"},"arbo","_","utils"),(0,r.kt)("p",null,"\u25aa ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"arbo","_","utils"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"toBigInt")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"str"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"bigint"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"toHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"input"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]",">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"toString")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"n"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"bigint"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L277"},"services/anonymous.ts:277")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ff_utils"},"ff","_","utils"),(0,r.kt)("p",null,"\u25aa ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"ff","_","utils"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"bigIntToFF")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"bi"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"bigint"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"bigint"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hexToFFBigInt")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"hexStr"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"bigint"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"q")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L329"},"services/anonymous.ts:329")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hex_utils"},"hex","_","utils"),(0,r.kt)("p",null,"\u25aa ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"hex","_","utils"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fromArrayBuffer")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"input"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"Uint8Array"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fromBigInt")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"bi"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"bigint"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"toArrayBuffer")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"input"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"Uint8Array"))))),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L304"},"services/anonymous.ts:304")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"checkcircuitshashes"},"checkCircuitsHashes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkCircuitsHashes"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,r.kt)("p",null,"Checks circuit hashes"),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,r.kt)("p",null,"The checked circuit parameters"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L107"},"services/anonymous.ts:107")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchaccountsik"},"fetchAccountSIK"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchAccountSIK"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L82"},"services/anonymous.ts:82")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchcircuits"},"fetchCircuits"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchCircuits"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"circuits?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits")),">"),(0,r.kt)("p",null,"Fetches circuits for anonymous voting"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"circuits?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Omit"),"\\<",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits")),", ",(0,r.kt)("inlineCode",{parentName:"td"},'"zKeyData"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},'"vKeyData"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},'"wasmData"'),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Additional options for custom circuits")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits")),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L131"},"services/anonymous.ts:131")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchzkproof"},"fetchZKProof"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchZKProof"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IZkProofResponse"),">"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IZkProofResponse"),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L93"},"services/anonymous.ts:93")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"generatezkproof"},"generateZkProof"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"generateZkProof"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"inputs"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#zkproof"},(0,r.kt)("inlineCode",{parentName:"a"},"ZkProof")),">"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"inputs")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/CircuitInputs"},(0,r.kt)("inlineCode",{parentName:"a"},"CircuitInputs")))))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#zkproof"},(0,r.kt)("inlineCode",{parentName:"a"},"ZkProof")),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L76"},"services/anonymous.ts:76")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasregisteredsik"},"hasRegisteredSIK"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasRegisteredSIK"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"password?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signature")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"password?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L87"},"services/anonymous.ts:87")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setcircuits"},"setCircuits"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setCircuits"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"circuits"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,r.kt)("p",null,"Sets circuits for anonymous voting"),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"circuits")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Custom circuits")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L187"},"services/anonymous.ts:187")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"signsikpayload"},"signSIKPayload"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"signSIKPayload"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"wallet"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wallet")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Signer"))))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L98"},"services/anonymous.ts:98")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"calccircuitinputs"},"calcCircuitInputs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"calcCircuitInputs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"password"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"arboElectionId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"ffpassword"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"ffsignature"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"nullifier"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }",">"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signature")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"password")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"arboElectionId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"ffpassword"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"ffsignature"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"nullifier"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }",">"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L234"},"services/anonymous.ts:234")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"calcnullifier"},"calcNullifier"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"calcNullifier"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"password"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"bigint"),">"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signature")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"password")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"bigint"),">"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L247"},"services/anonymous.ts:247")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"calcsik"},"calcSik"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"calcSik"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"personal_sign"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"password?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"personal_sign")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"password")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"'0'"))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L257"},"services/anonymous.ts:257")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"calcvoteid"},"calcVoteId"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"calcVoteId"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"password"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signature")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"password")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L251"},"services/anonymous.ts:251")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"generategroth16proof"},"generateGroth16Proof"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"generateGroth16Proof"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"inputs"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"circuitPath"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"provingKey"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#zkproof"},(0,r.kt)("inlineCode",{parentName:"a"},"ZkProof")),">"),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"inputs")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/CircuitInputs"},(0,r.kt)("inlineCode",{parentName:"a"},"CircuitInputs")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"circuitPath")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Uint8Array"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"provingKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Uint8Array"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#zkproof"},(0,r.kt)("inlineCode",{parentName:"a"},"ZkProof")),">"),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L192"},"services/anonymous.ts:192")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"preparecircuitinputs"},"prepareCircuitInputs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"prepareCircuitInputs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"password"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"voteWeight"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"availableWeight"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sikRoot"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sikSiblings"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusRoot"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusSiblings"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"votePackage"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/CircuitInputs"},(0,r.kt)("inlineCode",{parentName:"a"},"CircuitInputs")),">"),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"password")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signature")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"voteWeight")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"availableWeight")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sikRoot")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sikSiblings")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusRoot")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusSiblings")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"votePackage")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Buffer"))))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/CircuitInputs"},(0,r.kt)("inlineCode",{parentName:"a"},"CircuitInputs")),">"),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L200"},"services/anonymous.ts:200")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"signaturetovocdonisiksignature"},"signatureToVocdoniSikSignature"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"signatureToVocdoniSikSignature"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"personal_sign"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"personal_sign")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L270"},"services/anonymous.ts:270")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/64c2e320.7d508ecf.js b/assets/js/64c2e320.7d508ecf.js new file mode 100644 index 000000000..3bdb40a9d --- /dev/null +++ b/assets/js/64c2e320.7d508ecf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4246],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),o=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=o(e.components);return a.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),m=o(n),u=r,c=m["".concat(p,".").concat(u)]||m[u]||k[u]||i;return n?a.createElement(c,l(l({ref:t},s),{},{components:n})):a.createElement(c,l({ref:t},s))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,d={unversionedId:"sdk/reference/classes/AnonymousService",id:"sdk/reference/classes/AnonymousService",title:"AnonymousService",description:"@vocdoni/sdk / Exports / AnonymousService",source:"@site/docs/sdk/reference/classes/AnonymousService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/AnonymousService",permalink:"/sdk/reference/classes/AnonymousService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"AccountService",permalink:"/sdk/reference/classes/AccountService"},next:{title:"AnonymousVote",permalink:"/sdk/reference/classes/AnonymousVote"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"chainCircuits",id:"chaincircuits",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"arbo_utils",id:"arbo_utils",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"ff_utils",id:"ff_utils",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"hex_utils",id:"hex_utils",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods-1",level:2},{value:"checkCircuitsHashes",id:"checkcircuitshashes",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetchAccountSIK",id:"fetchaccountsik",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"fetchCircuits",id:"fetchcircuits",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"fetchZKProof",id:"fetchzkproof",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"generateZkProof",id:"generatezkproof",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"hasRegisteredSIK",id:"hasregisteredsik",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"setCircuits",id:"setcircuits",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"signSIKPayload",id:"signsikpayload",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"calcCircuitInputs",id:"calccircuitinputs",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"calcNullifier",id:"calcnullifier",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"calcSik",id:"calcsik",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"calcVoteId",id:"calcvoteid",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"generateGroth16Proof",id:"generategroth16proof",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"prepareCircuitInputs",id:"preparecircuitinputs",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"signatureToVocdoniSikSignature",id:"signaturetovocdonisiksignature",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-20",level:4}],s={toc:o};function k(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / AnonymousService"),(0,r.kt)("h1",{id:"class-anonymousservice"},"Class: AnonymousService"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"Service"},(0,r.kt)("inlineCode",{parentName:"a"},"Service"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"AnonymousService"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"AnonymousServiceProperties"))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#chaincircuits"},"chainCircuits")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#url"},"url")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#arbo_utils"},"arbo","_","utils")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#ff_utils"},"ff","_","utils")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService#hex_utils"},"hex","_","utils"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#checkcircuitshashes"},"checkCircuitsHashes")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#fetchaccountsik"},"fetchAccountSIK")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#fetchcircuits"},"fetchCircuits")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#fetchzkproof"},"fetchZKProof")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#generatezkproof"},"generateZkProof")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#hasregisteredsik"},"hasRegisteredSIK")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#setcircuits"},"setCircuits")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#signsikpayload"},"signSIKPayload")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#calccircuitinputs"},"calcCircuitInputs")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#calcnullifier"},"calcNullifier")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#calcsik"},"calcSik")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#calcvoteid"},"calcVoteId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#generategroth16proof"},"generateGroth16Proof")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#preparecircuitinputs"},"prepareCircuitInputs")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AnonymousService#signaturetovocdonisiksignature"},"signatureToVocdoniSikSignature"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new AnonymousService"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,r.kt)("a",{parentName:"p",href:"AnonymousService"},(0,r.kt)("inlineCode",{parentName:"a"},"AnonymousService"))),(0,r.kt)("p",null,"Instantiate the anonymous service."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"AnonymousServiceParameters"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"AnonymousService"},(0,r.kt)("inlineCode",{parentName:"a"},"AnonymousService"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,r.kt)("a",{parentName:"p",href:"Service#constructor"},"constructor")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L71"},"services/anonymous.ts:71")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"chaincircuits"},"chainCircuits"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"chainCircuits"),": ",(0,r.kt)("a",{parentName:"p",href:"../modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,"AnonymousServiceProperties.chainCircuits"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L64"},"services/anonymous.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"url"},"url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,r.kt)("a",{parentName:"p",href:"Service#url"},"url")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/service.ts#L6"},"services/service.ts:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"arbo_utils"},"arbo","_","utils"),(0,r.kt)("p",null,"\u25aa ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"arbo","_","utils"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"toBigInt")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"str"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"bigint"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"toHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"input"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]",">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"toString")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"n"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"bigint"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L277"},"services/anonymous.ts:277")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ff_utils"},"ff","_","utils"),(0,r.kt)("p",null,"\u25aa ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"ff","_","utils"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"bigIntToFF")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"bi"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"bigint"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"bigint"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hexToFFBigInt")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"hexStr"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"bigint"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"q")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L329"},"services/anonymous.ts:329")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hex_utils"},"hex","_","utils"),(0,r.kt)("p",null,"\u25aa ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"hex","_","utils"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fromArrayBuffer")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"input"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"Uint8Array"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fromBigInt")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"bi"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"bigint"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"toArrayBuffer")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"input"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"Uint8Array"))))),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L304"},"services/anonymous.ts:304")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"checkcircuitshashes"},"checkCircuitsHashes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkCircuitsHashes"),"(): ",(0,r.kt)("a",{parentName:"p",href:"../modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,r.kt)("p",null,"Checks circuit hashes"),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"../modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,r.kt)("p",null,"The checked circuit parameters"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L107"},"services/anonymous.ts:107")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchaccountsik"},"fetchAccountSIK"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchAccountSIK"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L82"},"services/anonymous.ts:82")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchcircuits"},"fetchCircuits"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchCircuits"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"circuits?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits")),">"),(0,r.kt)("p",null,"Fetches circuits for anonymous voting"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"circuits?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Omit"),"\\<",(0,r.kt)("a",{parentName:"td",href:"../modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits")),", ",(0,r.kt)("inlineCode",{parentName:"td"},'"zKeyData"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},'"vKeyData"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},'"wasmData"'),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Additional options for custom circuits")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits")),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L131"},"services/anonymous.ts:131")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchzkproof"},"fetchZKProof"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchZKProof"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IZkProofResponse"),">"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IZkProofResponse"),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L93"},"services/anonymous.ts:93")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"generatezkproof"},"generateZkProof"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"generateZkProof"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"inputs"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#zkproof"},(0,r.kt)("inlineCode",{parentName:"a"},"ZkProof")),">"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"inputs")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../interfaces/CircuitInputs"},(0,r.kt)("inlineCode",{parentName:"a"},"CircuitInputs")))))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#zkproof"},(0,r.kt)("inlineCode",{parentName:"a"},"ZkProof")),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L76"},"services/anonymous.ts:76")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasregisteredsik"},"hasRegisteredSIK"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasRegisteredSIK"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"password?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signature")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"password?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L87"},"services/anonymous.ts:87")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setcircuits"},"setCircuits"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setCircuits"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"circuits"),"): ",(0,r.kt)("a",{parentName:"p",href:"../modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,r.kt)("p",null,"Sets circuits for anonymous voting"),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"circuits")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Custom circuits")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"../modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L187"},"services/anonymous.ts:187")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"signsikpayload"},"signSIKPayload"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"signSIKPayload"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"wallet"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wallet")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Signer"))))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L98"},"services/anonymous.ts:98")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"calccircuitinputs"},"calcCircuitInputs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"calcCircuitInputs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"password"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"arboElectionId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"ffpassword"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"ffsignature"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"nullifier"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }",">"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signature")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"password")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"arboElectionId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"ffpassword"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"ffsignature"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"nullifier"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }",">"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L234"},"services/anonymous.ts:234")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"calcnullifier"},"calcNullifier"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"calcNullifier"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"password"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"bigint"),">"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signature")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"password")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"bigint"),">"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L247"},"services/anonymous.ts:247")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"calcsik"},"calcSik"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"calcSik"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"personal_sign"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"password?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"personal_sign")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"password")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"'0'"))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L257"},"services/anonymous.ts:257")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"calcvoteid"},"calcVoteId"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"calcVoteId"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"password"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signature")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"password")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L251"},"services/anonymous.ts:251")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"generategroth16proof"},"generateGroth16Proof"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"generateGroth16Proof"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"inputs"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"circuitPath"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"provingKey"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#zkproof"},(0,r.kt)("inlineCode",{parentName:"a"},"ZkProof")),">"),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"inputs")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../interfaces/CircuitInputs"},(0,r.kt)("inlineCode",{parentName:"a"},"CircuitInputs")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"circuitPath")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Uint8Array"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"provingKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Uint8Array"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#zkproof"},(0,r.kt)("inlineCode",{parentName:"a"},"ZkProof")),">"),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L192"},"services/anonymous.ts:192")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"preparecircuitinputs"},"prepareCircuitInputs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"prepareCircuitInputs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"password"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"voteWeight"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"availableWeight"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sikRoot"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sikSiblings"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusRoot"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusSiblings"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"votePackage"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/CircuitInputs"},(0,r.kt)("inlineCode",{parentName:"a"},"CircuitInputs")),">"),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"password")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signature")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"voteWeight")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"availableWeight")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sikRoot")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sikSiblings")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusRoot")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusSiblings")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"votePackage")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Buffer"))))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/CircuitInputs"},(0,r.kt)("inlineCode",{parentName:"a"},"CircuitInputs")),">"),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L200"},"services/anonymous.ts:200")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"signaturetovocdonisiksignature"},"signatureToVocdoniSikSignature"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"signatureToVocdoniSikSignature"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"personal_sign"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"personal_sign")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L270"},"services/anonymous.ts:270")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/65d7ebf2.2ad74ae8.js b/assets/js/65d7ebf2.f43e88bd.js similarity index 59% rename from assets/js/65d7ebf2.2ad74ae8.js rename to assets/js/65d7ebf2.f43e88bd.js index 703f1f6a1..69a676c2a 100644 --- a/assets/js/65d7ebf2.2ad74ae8.js +++ b/assets/js/65d7ebf2.f43e88bd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3802],{3905:(e,n,t)=>{t.d(n,{Zo:()=>l,kt:()=>k});var r=t(67294);function s(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function a(e){for(var n=1;n=0||(s[t]=e[t]);return s}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(s[t]=e[t])}return s}var p=r.createContext({}),c=function(e){var n=r.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},l=function(e){var n=c(e.components);return r.createElement(p.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},f=r.forwardRef((function(e,n){var t=e.components,s=e.mdxType,o=e.originalType,p=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),f=c(t),k=s,d=f["".concat(p,".").concat(k)]||f[k]||u[k]||o;return t?r.createElement(d,a(a({ref:n},l),{},{components:t})):r.createElement(d,a({ref:n},l))}));function k(e,n){var t=arguments,s=n&&n.mdxType;if("string"==typeof e||s){var o=t.length,a=new Array(o);a[0]=f;var i={};for(var p in n)hasOwnProperty.call(n,p)&&(i[p]=n[p]);i.originalType=e,i.mdxType="string"==typeof e?e:s,a[1]=i;for(var c=2;c{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=t(87462),s=(t(67294),t(3905));const o={},a=void 0,i={unversionedId:"sdk/reference/interfaces/ICensus3TokenListResponse",id:"sdk/reference/interfaces/ICensus3TokenListResponse",title:"ICensus3TokenListResponse",description:"@vocdoni/sdk / Exports / ICensus3TokenListResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3TokenListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3TokenListResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3TokenHolderResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenHolderResponse"},next:{title:"ICensus3TokenListResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"tokens",id:"tokens",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:c};function u(e){let{components:n,...t}=e;return(0,s.kt)("wrapper",(0,r.Z)({},l,t,{components:n,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3TokenListResponse"),(0,s.kt)("h1",{id:"interface-icensus3tokenlistresponse"},"Interface: ICensus3TokenListResponse"),(0,s.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("p",{parentName:"li"},(0,s.kt)("strong",{parentName:"p"},(0,s.kt)("inlineCode",{parentName:"strong"},"ICensus3TokenListResponse"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated"},(0,s.kt)("inlineCode",{parentName:"a"},"ICensus3TokenListResponsePaginated"))))),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3TokenListResponse#tokens"},"tokens"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"tokens"},"tokens"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"tokens"),": ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3summarytoken"},(0,s.kt)("inlineCode",{parentName:"a"},"Census3SummaryToken")),"[]"),(0,s.kt)("p",null,"The list of the tokens"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/token.ts#L110"},"api/census3/token.ts:110")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3802],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>k});var r=t(67294);function s(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function a(e){for(var n=1;n=0||(s[t]=e[t]);return s}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(s[t]=e[t])}return s}var p=r.createContext({}),l=function(e){var n=r.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},c=function(e){var n=l(e.components);return r.createElement(p.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},f=r.forwardRef((function(e,n){var t=e.components,s=e.mdxType,o=e.originalType,p=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),f=l(t),k=s,d=f["".concat(p,".").concat(k)]||f[k]||u[k]||o;return t?r.createElement(d,a(a({ref:n},c),{},{components:t})):r.createElement(d,a({ref:n},c))}));function k(e,n){var t=arguments,s=n&&n.mdxType;if("string"==typeof e||s){var o=t.length,a=new Array(o);a[0]=f;var i={};for(var p in n)hasOwnProperty.call(n,p)&&(i[p]=n[p]);i.originalType=e,i.mdxType="string"==typeof e?e:s,a[1]=i;for(var l=2;l{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var r=t(87462),s=(t(67294),t(3905));const o={},a=void 0,i={unversionedId:"sdk/reference/interfaces/ICensus3TokenListResponse",id:"sdk/reference/interfaces/ICensus3TokenListResponse",title:"ICensus3TokenListResponse",description:"@vocdoni/sdk / Exports / ICensus3TokenListResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3TokenListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3TokenListResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3TokenHolderResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenHolderResponse"},next:{title:"ICensus3TokenListResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"tokens",id:"tokens",level:3},{value:"Defined in",id:"defined-in",level:4}],c={toc:l};function u(e){let{components:n,...t}=e;return(0,s.kt)("wrapper",(0,r.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3TokenListResponse"),(0,s.kt)("h1",{id:"interface-icensus3tokenlistresponse"},"Interface: ICensus3TokenListResponse"),(0,s.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("p",{parentName:"li"},(0,s.kt)("strong",{parentName:"p"},(0,s.kt)("inlineCode",{parentName:"strong"},"ICensus3TokenListResponse"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("a",{parentName:"p",href:"ICensus3TokenListResponsePaginated"},(0,s.kt)("inlineCode",{parentName:"a"},"ICensus3TokenListResponsePaginated"))))),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus3TokenListResponse#tokens"},"tokens"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"tokens"},"tokens"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"tokens"),": ",(0,s.kt)("a",{parentName:"p",href:"../modules#census3summarytoken"},(0,s.kt)("inlineCode",{parentName:"a"},"Census3SummaryToken")),"[]"),(0,s.kt)("p",null,"The list of the tokens"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/token.ts#L110"},"api/census3/token.ts:110")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/68ce4a42.b0230b14.js b/assets/js/68ce4a42.b0230b14.js deleted file mode 100644 index e31cefe7a..000000000 --- a/assets/js/68ce4a42.b0230b14.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[887],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var o=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function r(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=o.createContext({}),c=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},p=function(e){var t=c(e.components);return o.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},u=o.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(n),h=a,f=u["".concat(l,".").concat(h)]||u[h]||d[h]||i;return n?o.createElement(f,r(r({ref:t},p),{},{components:n})):o.createElement(f,r({ref:t},p))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,r=new Array(i);r[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,r[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var o=n(87462),a=(n(67294),n(3905));const i={},r="SDK Tutorial",s={unversionedId:"sdk/tutorial",id:"sdk/tutorial",title:"SDK Tutorial",description:"This tutorial will show you how to get your environment set up, start using the SDK, and create and vote in an election. We will be using typescript.",source:"@site/docs/sdk/tutorial.md",sourceDirName:"sdk",slug:"/sdk/tutorial",permalink:"/sdk/tutorial",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"modules",permalink:"/sdk/reference/modules"},next:{title:"Voting Types",permalink:"/sdk/voting-types/"}},l={},c=[{value:"Prerequisites",id:"prerequisites",level:3},{value:"Overview",id:"overview",level:2},{value:"Client",id:"client",level:2},{value:"Census",id:"census",level:2},{value:"Election",id:"election",level:2},{value:"Voting",id:"voting",level:2},{value:"Results",id:"results",level:2},{value:"Running the code",id:"running-the-code",level:2}],p={toc:c};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,o.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"sdk-tutorial"},"SDK Tutorial"),(0,a.kt)("p",null,"This tutorial will show you how to get your environment set up, start using the SDK, and create and vote in an election. We will be using typescript."),(0,a.kt)("h3",{id:"prerequisites"},"Prerequisites"),(0,a.kt)("p",null,"You'll need a working ",(0,a.kt)("a",{parentName:"p",href:"https://nodejs.org"},"nodejs")," environment, but other than that, you're\nfree to use any package manager (either npm, yarn, pnpm...). Let's start by creating a project and adding the SDK:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"# with yarn\nyarn add @vocdoni/sdk\n# with npm\nnpm i @vocdoni/sdk\n# with pnpm\npnpm add @vocdoni/sdk\n")),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"This project has been bundled into many formats in order for you to\nimport it based on the environment you're using it. When importing it via\n",(0,a.kt)("inlineCode",{parentName:"p"},"@vocdoni/sdk")," it will choose a version based on your current environment\n(commonjs or esm). There's also another UMD version which can be accessed via\n",(0,a.kt)("inlineCode",{parentName:"p"},"@vocdoni/sdk/umd")," in case you need it.")),(0,a.kt)("h2",{id:"overview"},"Overview"),(0,a.kt)("p",null,"The following are the main steps we need to implement:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Connecting a client to the Vocdoni network"),(0,a.kt)("li",{parentName:"ul"},"Creating a census with some random members"),(0,a.kt)("li",{parentName:"ul"},"Creating an election"),(0,a.kt)("li",{parentName:"ul"},"Sending votes"),(0,a.kt)("li",{parentName:"ul"},"Checking the election results")),(0,a.kt)("h2",{id:"client"},"Client"),(0,a.kt)("p",null,"The first step will be connecting to a Vocdoni ",(0,a.kt)("a",{parentName:"p",href:"/protocol#12-gateways"},"Gateway")," Node. We can do this easily with the ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient"},"VocdoniSDKClient"),". The client allows us to access all of the Vocdoni API calls."),(0,a.kt)("p",null,"In order to create a client, we need a ",(0,a.kt)("inlineCode",{parentName:"p"},"wallet"),", an envelope that holds a cryptographic key and enables our client to sign transactions for the blockchain. We'll be generating a random wallet with the ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/ethers-io/ethers.js"},"ethers")," signer."),(0,a.kt)("p",null,"We also need to define which Vocdoni ",(0,a.kt)("a",{parentName:"p",href:"/sdk/integration-details#environment"},"environment")," we will connect to. Staging is the ",(0,a.kt)("strong",{parentName:"p"},"recommended")," environment for most testing use cases, since the ",(0,a.kt)("inlineCode",{parentName:"p"},"dev")," environment is more subject to blockchain resets and downtimes than the ",(0,a.kt)("inlineCode",{parentName:"p"},"stg")," one."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/client.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export const getDefaultClient = () => {\n const wallet = Wallet.createRandom();\n const client = new VocdoniSDKClient({\n env: EnvOptions.STG,\n wallet: wallet,\n });\n\n return { wallet, client };\n};\n")),(0,a.kt)("p",null,"Now that we have a client connected to the ",(0,a.kt)("inlineCode",{parentName:"p"},"STG")," environment, we need to register its wallet to the blockchain with ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#createaccount"},"createAccount()"),". Parameters here are optional, but let's define a name and description."),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"An ",(0,a.kt)("inlineCode",{parentName:"p"},"Account")," can represent an organization hosting a voting process. There are many ",(0,a.kt)("a",{parentName:"p",href:"/protocol/data-schemes/organization"},"parameters")," we can optionally add, like ",(0,a.kt)("inlineCode",{parentName:"p"},"logo")," or even arbitrary ",(0,a.kt)("inlineCode",{parentName:"p"},"meta"),". This can all be displayed on a custom frontend implementation. Using ",(0,a.kt)("inlineCode",{parentName:"p"},"createAccount()")," on an account that already exists will fetch the account info from the blockchain.")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/account.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export const createAccount = (client: VocdoniSDKClient) => {\n return client\n .createAccount({\n account: new Account({\n languages: ['en'],\n name: {\n default: 'Account name',\n },\n description: 'Description of the account',\n logo: 'https://logo.io',\n }),\n })\n .then(() => client.fetchAccountInfo().then(info => console.log(info)));\n};\n")),(0,a.kt)("h2",{id:"census"},"Census"),(0,a.kt)("p",null,"With our client created and registered to the Vochain, the next step is to create a ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/census"},"census")," of voters. The protocol enables many ",(0,a.kt)("a",{parentName:"p",href:"/protocol/census"},"types of census"),". For our purposes it's easiest to use a ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/plaincensus"},"plain census"),", the simplest form of ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/offchaincensus"},"offchain census"),"."),(0,a.kt)("p",null,"We can create a random wallet to represent each voter just like we did for the client, and then we can register each voter's address to the census. The voter wallets have to be saved in order to sign their individual votes."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/census.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export async function createCensus () {\n const census = new PlainCensus()\n\n // Create a list of random voters, register them to the census\n let voters: Wallet[] = []\n for (let i = 0; i < 5; i++) {\n voters.push(Wallet.createRandom())\n census.add(await voters[i].getAddress())\n }\n\n return { census, voters }\n}\n")),(0,a.kt)("h2",{id:"election"},"Election"),(0,a.kt)("p",null,"Creating a basic election is easy with ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#from"},"Election.from()"),". We just need to specify the title and description, a header photo, an end date, and the census we created earlier. We can specify some ",(0,a.kt)("inlineCode",{parentName:"p"},"electionType")," options, but this is not necessary as our election is using the default options. "),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/election.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export const createElection = (census: PlainCensus): UnpublishedElection => {\n const election: UnpublishedElection = Election.from({\n title: 'Election title',\n description: 'Election description',\n header: 'https://source.unsplash.com/random',\n endDate: new Date().getTime() + 100000,\n census,\n });\n ...\n")),(0,a.kt)("p",null," Questions can be added to an election with ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#addquestion"},"addQuestion"),". This is a single-choice (binary) election with only one question. "),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/election.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"...\n election.addQuestion('This is a title', 'This is a description', [\n {\n title: 'Option 1',\n value: 0\n },\n {\n title: 'Option 2',\n value: 1\n }\n ])\n\n return election\n}\n")),(0,a.kt)("p",null,"Once our election is defined, it has to be officially created on the blockchain with ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#createelection"},(0,a.kt)("inlineCode",{parentName:"a"},"client.CreateElection()")),". This will also provide us with a unique ",(0,a.kt)("inlineCode",{parentName:"p"},"electionID"),". We want to use ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#setelectionid"},(0,a.kt)("inlineCode",{parentName:"a"},"client.SetElectionID()"))," so that the client knows which voting process to submit votes to. "),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"Now that we have the ",(0,a.kt)("inlineCode",{parentName:"p"},"electionId"),", we can also print out a link to view our voting process on the Vocdoni blockchain ",(0,a.kt)("a",{parentName:"p",href:"https://stg.explorer.vote"},"explorer"),"! The explorer unlocks the universal verifiability of Vocdoni's protocol- even for this small example, the results of this election are verifiable by any observer and cannot be altered. ")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/election.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"const waitForElectionReady = (client: VocdoniSDKClient, electionId: string): Promise => {\n return new Promise(f => setTimeout(f, 5000))\n .then(() => client.fetchElection(electionId))\n .then(election => {\n if (election.status !== ElectionStatus.ONGOING) {\n return waitForElectionReady(client, electionId);\n }\n return Promise.resolve(electionId);\n });\n};\n")),(0,a.kt)("p",null,"Publishing an election registers a transaction to the blockchain. This means we have to wait for the next block to process in order to ensure the transaction was successful. Here we use ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#fetchelection"},"client.fetchElection()")," to fetch the election info from the blockchain, given our ",(0,a.kt)("inlineCode",{parentName:"p"},"electionId"),". This allows us to wait until the election status is ",(0,a.kt)("inlineCode",{parentName:"p"},"ONGOING"),", which means the election has been successfully published and has begun."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/election.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export const publishElection = (client: VocdoniSDKClient, election: UnpublishedElection): Promise => {\n return client.createElection(election).then(electionId => {\n client.setElectionId(electionId);\n console.log('Election created!', electionId);\n console.log('View this election at ' + client.explorerUrl + '/processes/show/#/' + electionId);\n console.log('Waiting for election to be published...');\n return waitForElectionReady(client, electionId);\n });\n};\n")),(0,a.kt)("h2",{id:"voting"},"Voting"),(0,a.kt)("p",null,"With the election published, it's time to vote. We can use each of the wallets that we saved earlier to cast a unique vote for that imaginary voter. We do this by first setting ",(0,a.kt)("inlineCode",{parentName:"p"},"client.wallet = voter"),", telling the client which wallet to use for bundling and submitting this vote. "),(0,a.kt)("p",null,"The we create the vote itself. A ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/vote"},"Vote")," is simply a list of values whose form depends on the type and number of questions in the election."),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"For more info on vote types, see our section on the ",(0,a.kt)("a",{parentName:"p",href:"/protocol/ballot-protocol"},"Ballot Protocol"))),(0,a.kt)("p",null,"Then we can simply call ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#submitvote"},(0,a.kt)("inlineCode",{parentName:"a"},"client.submitVote()")),", and the SDK handles the creation, signing, and submission of the vote package. It returns a ",(0,a.kt)("inlineCode",{parentName:"p"},"voteId")," which can be used to ensure the vote was correctly counted. "),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/vote.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export const castVotes = (electionId: string, voters: Wallet[]) => {\n var votePromises = [];\n for (const voter of voters) {\n const client = new VocdoniSDKClient({ env: EnvOptions.STG, wallet: voter, electionId: electionId });\n // Create a vote for option 0 or 1\n const vote = new Vote([Math.round(Math.random())]);\n votePromises.push(\n client.submitVote(vote).then(voteId => {\n console.log('Vote sent! Vote id: ', voteId);\n console.log('Verify vote at ' + client.explorerUrl + '/verify/#/' + voteId);\n })\n );\n }\n return Promise.all(votePromises);\n};\n")),(0,a.kt)("h2",{id:"results"},"Results"),(0,a.kt)("p",null,"All that's left is checking the results of this election! ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#fetchelection"},(0,a.kt)("inlineCode",{parentName:"a"},"client.fetchElection()"))," returns an object with a simple array of results values- it's up to you to decide how to display them. "),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"Note that the results are available immediately because this election was configured with ",(0,a.kt)("inlineCode",{parentName:"p"},"secretUntilTheEnd=false"))),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/vote.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export const countVotes = (client: VocdoniSDKClient) => {\n return client.fetchElection().then(election => {\n console.log('Election results: ');\n election.questions.forEach(question => {\n question.choices.forEach(choice => {\n console.log(choice.title.default + ': ' + choice.results);\n });\n });\n });\n};\n")),(0,a.kt)("h2",{id:"running-the-code"},"Running the code"),(0,a.kt)("p",null,"Here's a program that combines all the above functions into a working prototype:"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/index.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"async function main () {\n console.log('Initializing client...');\n const { client } = getDefaultClient();\n\n console.log('Creating account...');\n await createAccount(client);\n\n console.log('Creating census with some random wallets...');\n const { census, voters } = await createCensus();\n\n console.log('Creating election...');\n const election = createElection(census);\n const electionId = await publishElection(client, election);\n\n console.log('Voting...');\n await castVotes(electionId, voters);\n\n console.log('Getting results...');\n await countVotes(client);\n}\nmain();\n")),(0,a.kt)("p",null,"All we have to do is run "),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"tutorial $ yarn start\nyarn run v1.22.17\n$ ts-node src/index.ts\nInitializing client...\nCreating account...\n{\n account: Account {\n _languages: [ 'en' ],\n _name: { default: 'Account name' },\n _description: { default: 'Description of the account' },\n _feed: { default: '' },\n _header: '',\n _avatar: '',\n _logo: 'https://logo.io',\n _meta: []\n },\n address: '73b3e1ff1602c6ece34f9b75aa86f5f90b41a209',\n nonce: 0,\n balance: 50,\n electionIndex: 0,\n infoURL: 'ipfs://bafybeif5mbhhwuju2pyd54bxhn3tdsj6m5cukx6f5xvchqfh2wvzkpbjpy',\n metadata: {\n version: '1.0',\n languages: [ 'en' ],\n name: { default: 'Account name' },\n description: { default: 'Description of the account' },\n newsFeed: { default: '' },\n media: { logo: 'https://logo.io' },\n meta: {}\n },\n sik: 'c5321163e98108424f5c25e55980a1ea4811029c1ff72cae95f113dfc95fac22'\n}\nCreating census with some random wallets...\nCreating election...\nElection created! 4ae20a8eb4ca73b3e1ff1602c6ece34f9b75aa86f5f90b41a209020000000000\nView this election at https://stg.explorer.vote/processes/show/#/4ae20a8eb4ca73b3e1ff1602c6ece34f9b75aa86f5f90b41a209020000000000\nWaiting for election to be published...\nVoting...\nVote sent! Vote id: 2fae8af3b02ec78af5a3bf06ec4aff1b7c000a1356a0aff1c07163da23f3d771\nVerify vote at https://stg.explorer.vote/verify/#/2fae8af3b02ec78af5a3bf06ec4aff1b7c000a1356a0aff1c07163da23f3d771\nVote sent! Vote id: 8af200d25a159c9d862e84064a4d977df2b10ea23ffb32ddc2de18b9142df0b6\nVerify vote at https://stg.explorer.vote/verify/#/8af200d25a159c9d862e84064a4d977df2b10ea23ffb32ddc2de18b9142df0b6\nVote sent! Vote id: 3cae37ec5c49ce338bcbc40b5102cf33bf9304c19c3f5e650c7c469b72664fc8\nVerify vote at https://stg.explorer.vote/verify/#/3cae37ec5c49ce338bcbc40b5102cf33bf9304c19c3f5e650c7c469b72664fc8\nVote sent! Vote id: 937911458a52393b75f1428ec1613d3a481112491c51bfcc033e2f0009341022\nVerify vote at https://stg.explorer.vote/verify/#/937911458a52393b75f1428ec1613d3a481112491c51bfcc033e2f0009341022\nVote sent! Vote id: a6e4f4fe0f0e56d41fc21c62473718c9fbbe4c451a6fd9c19dbfca1fef0dac8c\nVerify vote at https://stg.explorer.vote/verify/#/a6e4f4fe0f0e56d41fc21c62473718c9fbbe4c451a6fd9c19dbfca1fef0dac8c\nGetting results...\nElection results:\nOption 1: 2\nOption 2: 3\n\u2728 Done in 45.08s.\n")),(0,a.kt)("p",null,"You can even check out the ",(0,a.kt)("a",{parentName:"p",href:"https://stg.explorer.vote/processes/show/#/4ae20a8eb4ca73b3e1ff1602c6ece34f9b75aa86f5f90b41a209020000000000"},"election I created")," on the blockchain explorer. "),(0,a.kt)("p",null,"Now that you've created a basic example with the SDK, you can integrate this functionality into your own applications. For more details, check out the ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"reference documentation")," and the more extensive ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/examples"},"examples")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6a02f24e.a6bae30e.js b/assets/js/6a02f24e.a6bae30e.js new file mode 100644 index 000000000..0f19fdea5 --- /dev/null +++ b/assets/js/6a02f24e.a6bae30e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5596],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>d});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var c=r.createContext({}),p=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},l=function(e){var t=p(e.components);return r.createElement(c.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),f=p(n),d=o,m=f["".concat(c,".").concat(d)]||f[d]||u[d]||i;return n?r.createElement(m,a(a({ref:t},l),{},{components:n})):r.createElement(m,a({ref:t},l))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=f;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s.mdxType="string"==typeof e?e:o,a[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var r=n(87462),o=(n(67294),n(3905));const i={},a=void 0,s={unversionedId:"sdk/reference/interfaces/IChainTxCountResponse",id:"sdk/reference/interfaces/IChainTxCountResponse",title:"IChainTxCountResponse",description:"@vocdoni/sdk / Exports / IChainTxCountResponse",source:"@site/docs/sdk/reference/interfaces/IChainTxCountResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainTxCountResponse",permalink:"/sdk/reference/interfaces/IChainTxCountResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainSubmitTxResponse",permalink:"/sdk/reference/interfaces/IChainSubmitTxResponse"},next:{title:"IChainTxListResponse",permalink:"/sdk/reference/interfaces/IChainTxListResponse"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"count",id:"count",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function u(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IChainTxCountResponse"),(0,o.kt)("h1",{id:"interface-ichaintxcountresponse"},"Interface: IChainTxCountResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IChainTxCountResponse#count"},"count"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"count"},"count"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"count"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"The number of transactions"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L210"},"api/chain.ts:210")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6a02f24e.f82ab9ba.js b/assets/js/6a02f24e.f82ab9ba.js deleted file mode 100644 index 4c3e10183..000000000 --- a/assets/js/6a02f24e.f82ab9ba.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5596],{3905:(e,n,t)=>{t.d(n,{Zo:()=>l,kt:()=>d});var r=t(67294);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function a(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var c=r.createContext({}),p=function(e){var n=r.useContext(c),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},l=function(e){var n=p(e.components);return r.createElement(c.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},f=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,i=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),f=p(t),d=o,m=f["".concat(c,".").concat(d)]||f[d]||u[d]||i;return t?r.createElement(m,a(a({ref:n},l),{},{components:t})):r.createElement(m,a({ref:n},l))}));function d(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var i=t.length,a=new Array(i);a[0]=f;var s={};for(var c in n)hasOwnProperty.call(n,c)&&(s[c]=n[c]);s.originalType=e,s.mdxType="string"==typeof e?e:o,a[1]=s;for(var p=2;p{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var r=t(87462),o=(t(67294),t(3905));const i={},a=void 0,s={unversionedId:"sdk/reference/interfaces/IChainTxCountResponse",id:"sdk/reference/interfaces/IChainTxCountResponse",title:"IChainTxCountResponse",description:"@vocdoni/sdk / Exports / IChainTxCountResponse",source:"@site/docs/sdk/reference/interfaces/IChainTxCountResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainTxCountResponse",permalink:"/sdk/reference/interfaces/IChainTxCountResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainSubmitTxResponse",permalink:"/sdk/reference/interfaces/IChainSubmitTxResponse"},next:{title:"IChainTxListResponse",permalink:"/sdk/reference/interfaces/IChainTxListResponse"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"count",id:"count",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function u(e){let{components:n,...t}=e;return(0,o.kt)("wrapper",(0,r.Z)({},l,t,{components:n,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IChainTxCountResponse"),(0,o.kt)("h1",{id:"interface-ichaintxcountresponse"},"Interface: IChainTxCountResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainTxCountResponse#count"},"count"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"count"},"count"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"count"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"The number of transactions"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L210"},"api/chain.ts:210")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6b74149a.9b61bc0d.js b/assets/js/6b74149a.9b61bc0d.js new file mode 100644 index 000000000..5247ab8b4 --- /dev/null +++ b/assets/js/6b74149a.9b61bc0d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9470],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>k});var i=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function s(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=i.createContext({}),p=function(e){var n=i.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):s(s({},n),e)),t},d=function(e){var n=p(e.components);return i.createElement(l.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,r=e.originalType,l=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),u=p(t),k=a,h=u["".concat(l,".").concat(k)]||u[k]||c[k]||r;return t?i.createElement(h,s(s({ref:n},d),{},{components:t})):i.createElement(h,s({ref:n},d))}));function k(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var r=t.length,s=new Array(r);s[0]=u;var o={};for(var l in n)hasOwnProperty.call(n,l)&&(o[l]=n[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,s[1]=o;for(var p=2;p{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>c,frontMatter:()=>r,metadata:()=>o,toc:()=>p});var i=t(87462),a=(t(67294),t(3905));const r={},s=void 0,o={unversionedId:"sdk/reference/interfaces/Process",id:"sdk/reference/interfaces/Process",title:"Process",description:"@vocdoni/sdk / Exports / Process",source:"@site/docs/sdk/reference/interfaces/Process.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/Process",permalink:"/sdk/reference/interfaces/Process",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"NewProcessTx",permalink:"/sdk/reference/interfaces/NewProcessTx"},next:{title:"Proof",permalink:"/sdk/reference/interfaces/Proof"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"blockCount",id:"blockcount",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"censusOrigin",id:"censusorigin",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"censusRoot",id:"censusroot",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"encryptionPrivateKeys",id:"encryptionprivatekeys",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"encryptionPublicKeys",id:"encryptionpublickeys",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"entityId",id:"entityid",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"envelopeType",id:"envelopetype",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"ethIndexSlot",id:"ethindexslot",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"keyIndex",id:"keyindex",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"metadata",id:"metadata",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"mode",id:"mode",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"namespace",id:"namespace",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"nullifiersRoot",id:"nullifiersroot",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"owner",id:"owner",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"paramsSignature",id:"paramssignature",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"processId",id:"processid",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"questionCount",id:"questioncount",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"questionIndex",id:"questionindex",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"results",id:"results",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"resultsSignatures",id:"resultssignatures",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"rollingCensusRoot",id:"rollingcensusroot",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"rollingCensusSize",id:"rollingcensussize",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"sourceBlockHeight",id:"sourceblockheight",level:3},{value:"Defined in",id:"defined-in-24",level:4},{value:"sourceNetworkContractAddr",id:"sourcenetworkcontractaddr",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"sourceNetworkId",id:"sourcenetworkid",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"startBlock",id:"startblock",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-28",level:4},{value:"tokenDecimals",id:"tokendecimals",level:3},{value:"Defined in",id:"defined-in-29",level:4},{value:"voteOptions",id:"voteoptions",level:3},{value:"Defined in",id:"defined-in-30",level:4}],d={toc:p};function c(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,i.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / Process"),(0,a.kt)("h1",{id:"interface-process"},"Interface: Process"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#blockcount"},"blockCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#censusorigin"},"censusOrigin")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#censusroot"},"censusRoot")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#censusuri"},"censusURI")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#encryptionprivatekeys"},"encryptionPrivateKeys")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#encryptionpublickeys"},"encryptionPublicKeys")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#entityid"},"entityId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#envelopetype"},"envelopeType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#ethindexslot"},"ethIndexSlot")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#keyindex"},"keyIndex")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#maxcensussize"},"maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#metadata"},"metadata")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#mode"},"mode")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#namespace"},"namespace")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#nullifiersroot"},"nullifiersRoot")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#owner"},"owner")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#paramssignature"},"paramsSignature")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#processid"},"processId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#questioncount"},"questionCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#questionindex"},"questionIndex")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#results"},"results")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#resultssignatures"},"resultsSignatures")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#rollingcensusroot"},"rollingCensusRoot")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#rollingcensussize"},"rollingCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#sourceblockheight"},"sourceBlockHeight")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#sourcenetworkcontractaddr"},"sourceNetworkContractAddr")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#sourcenetworkid"},"sourceNetworkId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#startblock"},"startBlock")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#status"},"status")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#tokendecimals"},"tokenDecimals")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Process#voteoptions"},"voteOptions"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"blockcount"},"blockCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"blockCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"BlockCount represents the amount of tendermint blocks that the process will last"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L174"},"api/chain/transactions.ts:174")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"censusorigin"},"censusOrigin"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"censusOrigin"),": ",(0,a.kt)("a",{parentName:"p",href:"../enums/CensusOrigin"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusOrigin"))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L192"},"api/chain/transactions.ts:192")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"censusroot"},"censusRoot"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"censusRoot"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("p",null,"CensusRoot merkle root of all the census in the process"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L176"},"api/chain/transactions.ts:176")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"censusuri"},"censusURI"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"censusURI"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"CensusURI where to find the census"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L178"},"api/chain/transactions.ts:178")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"encryptionprivatekeys"},"encryptionPrivateKeys"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"encryptionPrivateKeys"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,a.kt)("p",null,"EncryptionPrivateKeys are the keys required to decrypt the votes"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L180"},"api/chain/transactions.ts:180")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"encryptionpublickeys"},"encryptionPublicKeys"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"encryptionPublicKeys"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,a.kt)("p",null,"EncryptionPublicKeys are the keys required to encrypt the votes"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L182"},"api/chain/transactions.ts:182")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"entityid"},"entityId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"entityId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("p",null,"EntityId identifies unequivocally an entity"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L170"},"api/chain/transactions.ts:170")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"envelopetype"},"envelopeType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"envelopeType"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"EnvelopeType")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L187"},"api/chain/transactions.ts:187")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ethindexslot"},"ethIndexSlot"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"ethIndexSlot"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L195"},"api/chain/transactions.ts:195")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"keyindex"},"keyIndex"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"keyIndex"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L183"},"api/chain/transactions.ts:183")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"MaxCensusSize is set by the Process creator."),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L205"},"api/chain/transactions.ts:205")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"metadata"},"metadata"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"metadata"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Metadata is the content hashed URI of the JSON meta data (See Data Origins)"),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L201"},"api/chain/transactions.ts:201")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"mode"},"mode"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"mode"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ProcessMode")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L188"},"api/chain/transactions.ts:188")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"namespace"},"namespace"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"namespace"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L186"},"api/chain/transactions.ts:186")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"nullifiersroot"},"nullifiersRoot"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"nullifiersRoot"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("p",null,"NullifiersRoot is the root of the pre-census nullifiers merkle tree.\nUsed when Mode.PreRegister = true."),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L220"},"api/chain/transactions.ts:220")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"owner"},"owner"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"owner"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("p",null,"Owner is the creator of a process (if any) otherwise is assumed the creator is the entityId"),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L199"},"api/chain/transactions.ts:199")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"paramssignature"},"paramsSignature"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"paramsSignature"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L185"},"api/chain/transactions.ts:185")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"processid"},"processId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"processId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L168"},"api/chain/transactions.ts:168")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"questioncount"},"questionCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"questionCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L190"},"api/chain/transactions.ts:190")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"questionindex"},"questionIndex"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"questionIndex"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L189"},"api/chain/transactions.ts:189")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"results"},"results"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"results"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ProcessResult"),"[]"),(0,a.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L193"},"api/chain/transactions.ts:193")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"resultssignatures"},"resultsSignatures"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"resultsSignatures"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array"),"[]"),(0,a.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L194"},"api/chain/transactions.ts:194")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"rollingcensusroot"},"rollingCensusRoot"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"rollingCensusRoot"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("p",null,"RollingCensusRoot merkle root of the rolling census. Set by the\nvocdoni-node when Mode.Process = true"),(0,a.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L210"},"api/chain/transactions.ts:210")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"rollingcensussize"},"rollingCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"rollingCensusSize"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"RollingCensusSize is set by the vocdoni-node when Mode.PreRegister =\ntrue and the StartBlock has been reached."),(0,a.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L215"},"api/chain/transactions.ts:215")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sourceblockheight"},"sourceBlockHeight"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"sourceBlockHeight"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"SourceBlockHeight is the block height of the origin blockchain (if any)"),(0,a.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L197"},"api/chain/transactions.ts:197")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sourcenetworkcontractaddr"},"sourceNetworkContractAddr"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"sourceNetworkContractAddr"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("p",null,"sourceNetworkContractAddr is used for EVM token based voting and it is\nthe contract address of the token that is going to define the census"),(0,a.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L225"},"api/chain/transactions.ts:225")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sourcenetworkid"},"sourceNetworkId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"sourceNetworkId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"SourceNetworkId")),(0,a.kt)("p",null,"SourceNetworkId is the identifier of the network origin (where the process have been created)"),(0,a.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L203"},"api/chain/transactions.ts:203")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"startblock"},"startBlock"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"startBlock"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"StartBlock represents the tendermint block where the process goes from scheduled to active"),(0,a.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L172"},"api/chain/transactions.ts:172")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"status"},"status"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"status"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ProcessStatus")),(0,a.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L184"},"api/chain/transactions.ts:184")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"tokendecimals"},"tokenDecimals"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"tokenDecimals"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"tokenDecimals represents the number of decimals of the token (i.e ERC20) used for voting.\nIt is normally used for processes with on-chain census"),(0,a.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L230"},"api/chain/transactions.ts:230")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"voteoptions"},"voteOptions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"voteOptions"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ProcessVoteOptions")),(0,a.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L191"},"api/chain/transactions.ts:191")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6b74149a.d9b961ea.js b/assets/js/6b74149a.d9b961ea.js deleted file mode 100644 index b9706fd8f..000000000 --- a/assets/js/6b74149a.d9b961ea.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9470],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>u});var i=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function s(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=i.createContext({}),c=function(e){var n=i.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):s(s({},n),e)),t},d=function(e){var n=c(e.components);return i.createElement(l.Provider,{value:n},e.children)},p={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},k=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,r=e.originalType,l=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),k=c(t),u=a,h=k["".concat(l,".").concat(u)]||k[u]||p[u]||r;return t?i.createElement(h,s(s({ref:n},d),{},{components:t})):i.createElement(h,s({ref:n},d))}));function u(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var r=t.length,s=new Array(r);s[0]=k;var o={};for(var l in n)hasOwnProperty.call(n,l)&&(o[l]=n[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,s[1]=o;for(var c=2;c{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>c});var i=t(87462),a=(t(67294),t(3905));const r={},s=void 0,o={unversionedId:"sdk/reference/interfaces/Process",id:"sdk/reference/interfaces/Process",title:"Process",description:"@vocdoni/sdk / Exports / Process",source:"@site/docs/sdk/reference/interfaces/Process.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/Process",permalink:"/sdk/reference/interfaces/Process",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"NewProcessTx",permalink:"/sdk/reference/interfaces/NewProcessTx"},next:{title:"Proof",permalink:"/sdk/reference/interfaces/Proof"}},l={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"blockCount",id:"blockcount",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"censusOrigin",id:"censusorigin",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"censusRoot",id:"censusroot",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"encryptionPrivateKeys",id:"encryptionprivatekeys",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"encryptionPublicKeys",id:"encryptionpublickeys",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"entityId",id:"entityid",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"envelopeType",id:"envelopetype",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"ethIndexSlot",id:"ethindexslot",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"keyIndex",id:"keyindex",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"metadata",id:"metadata",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"mode",id:"mode",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"namespace",id:"namespace",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"nullifiersRoot",id:"nullifiersroot",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"owner",id:"owner",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"paramsSignature",id:"paramssignature",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"processId",id:"processid",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"questionCount",id:"questioncount",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"questionIndex",id:"questionindex",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"results",id:"results",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"resultsSignatures",id:"resultssignatures",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"rollingCensusRoot",id:"rollingcensusroot",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"rollingCensusSize",id:"rollingcensussize",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"sourceBlockHeight",id:"sourceblockheight",level:3},{value:"Defined in",id:"defined-in-24",level:4},{value:"sourceNetworkContractAddr",id:"sourcenetworkcontractaddr",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"sourceNetworkId",id:"sourcenetworkid",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"startBlock",id:"startblock",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-28",level:4},{value:"tokenDecimals",id:"tokendecimals",level:3},{value:"Defined in",id:"defined-in-29",level:4},{value:"voteOptions",id:"voteoptions",level:3},{value:"Defined in",id:"defined-in-30",level:4}],d={toc:c};function p(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,i.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / Process"),(0,a.kt)("h1",{id:"interface-process"},"Interface: Process"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#blockcount"},"blockCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#censusorigin"},"censusOrigin")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#censusroot"},"censusRoot")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#censusuri"},"censusURI")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#encryptionprivatekeys"},"encryptionPrivateKeys")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#encryptionpublickeys"},"encryptionPublicKeys")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#entityid"},"entityId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#envelopetype"},"envelopeType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#ethindexslot"},"ethIndexSlot")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#keyindex"},"keyIndex")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#maxcensussize"},"maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#metadata"},"metadata")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#mode"},"mode")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#namespace"},"namespace")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#nullifiersroot"},"nullifiersRoot")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#owner"},"owner")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#paramssignature"},"paramsSignature")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#processid"},"processId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#questioncount"},"questionCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#questionindex"},"questionIndex")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#results"},"results")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#resultssignatures"},"resultsSignatures")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#rollingcensusroot"},"rollingCensusRoot")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#rollingcensussize"},"rollingCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#sourceblockheight"},"sourceBlockHeight")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#sourcenetworkcontractaddr"},"sourceNetworkContractAddr")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#sourcenetworkid"},"sourceNetworkId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#startblock"},"startBlock")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#status"},"status")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#tokendecimals"},"tokenDecimals")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process#voteoptions"},"voteOptions"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"blockcount"},"blockCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"blockCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"BlockCount represents the amount of tendermint blocks that the process will last"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L174"},"api/chain/transactions.ts:174")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"censusorigin"},"censusOrigin"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"censusOrigin"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusOrigin"},(0,a.kt)("inlineCode",{parentName:"a"},"CensusOrigin"))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L192"},"api/chain/transactions.ts:192")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"censusroot"},"censusRoot"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"censusRoot"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("p",null,"CensusRoot merkle root of all the census in the process"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L176"},"api/chain/transactions.ts:176")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"censusuri"},"censusURI"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"censusURI"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"CensusURI where to find the census"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L178"},"api/chain/transactions.ts:178")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"encryptionprivatekeys"},"encryptionPrivateKeys"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"encryptionPrivateKeys"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,a.kt)("p",null,"EncryptionPrivateKeys are the keys required to decrypt the votes"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L180"},"api/chain/transactions.ts:180")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"encryptionpublickeys"},"encryptionPublicKeys"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"encryptionPublicKeys"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,a.kt)("p",null,"EncryptionPublicKeys are the keys required to encrypt the votes"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L182"},"api/chain/transactions.ts:182")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"entityid"},"entityId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"entityId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("p",null,"EntityId identifies unequivocally an entity"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L170"},"api/chain/transactions.ts:170")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"envelopetype"},"envelopeType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"envelopeType"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"EnvelopeType")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L187"},"api/chain/transactions.ts:187")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ethindexslot"},"ethIndexSlot"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"ethIndexSlot"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L195"},"api/chain/transactions.ts:195")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"keyindex"},"keyIndex"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"keyIndex"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L183"},"api/chain/transactions.ts:183")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"MaxCensusSize is set by the Process creator."),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L205"},"api/chain/transactions.ts:205")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"metadata"},"metadata"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"metadata"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Metadata is the content hashed URI of the JSON meta data (See Data Origins)"),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L201"},"api/chain/transactions.ts:201")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"mode"},"mode"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"mode"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ProcessMode")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L188"},"api/chain/transactions.ts:188")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"namespace"},"namespace"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"namespace"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L186"},"api/chain/transactions.ts:186")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"nullifiersroot"},"nullifiersRoot"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"nullifiersRoot"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("p",null,"NullifiersRoot is the root of the pre-census nullifiers merkle tree.\nUsed when Mode.PreRegister = true."),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L220"},"api/chain/transactions.ts:220")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"owner"},"owner"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"owner"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("p",null,"Owner is the creator of a process (if any) otherwise is assumed the creator is the entityId"),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L199"},"api/chain/transactions.ts:199")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"paramssignature"},"paramsSignature"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"paramsSignature"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L185"},"api/chain/transactions.ts:185")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"processid"},"processId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"processId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L168"},"api/chain/transactions.ts:168")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"questioncount"},"questionCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"questionCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L190"},"api/chain/transactions.ts:190")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"questionindex"},"questionIndex"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"questionIndex"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L189"},"api/chain/transactions.ts:189")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"results"},"results"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"results"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ProcessResult"),"[]"),(0,a.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L193"},"api/chain/transactions.ts:193")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"resultssignatures"},"resultsSignatures"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"resultsSignatures"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array"),"[]"),(0,a.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L194"},"api/chain/transactions.ts:194")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"rollingcensusroot"},"rollingCensusRoot"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"rollingCensusRoot"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("p",null,"RollingCensusRoot merkle root of the rolling census. Set by the\nvocdoni-node when Mode.Process = true"),(0,a.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L210"},"api/chain/transactions.ts:210")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"rollingcensussize"},"rollingCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"rollingCensusSize"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"RollingCensusSize is set by the vocdoni-node when Mode.PreRegister =\ntrue and the StartBlock has been reached."),(0,a.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L215"},"api/chain/transactions.ts:215")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sourceblockheight"},"sourceBlockHeight"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"sourceBlockHeight"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"SourceBlockHeight is the block height of the origin blockchain (if any)"),(0,a.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L197"},"api/chain/transactions.ts:197")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sourcenetworkcontractaddr"},"sourceNetworkContractAddr"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"sourceNetworkContractAddr"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,a.kt)("p",null,"sourceNetworkContractAddr is used for EVM token based voting and it is\nthe contract address of the token that is going to define the census"),(0,a.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L225"},"api/chain/transactions.ts:225")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sourcenetworkid"},"sourceNetworkId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"sourceNetworkId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"SourceNetworkId")),(0,a.kt)("p",null,"SourceNetworkId is the identifier of the network origin (where the process have been created)"),(0,a.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L203"},"api/chain/transactions.ts:203")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"startblock"},"startBlock"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"startBlock"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"StartBlock represents the tendermint block where the process goes from scheduled to active"),(0,a.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L172"},"api/chain/transactions.ts:172")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"status"},"status"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"status"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ProcessStatus")),(0,a.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L184"},"api/chain/transactions.ts:184")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"tokendecimals"},"tokenDecimals"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"tokenDecimals"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"tokenDecimals represents the number of decimals of the token (i.e ERC20) used for voting.\nIt is normally used for processes with on-chain census"),(0,a.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L230"},"api/chain/transactions.ts:230")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"voteoptions"},"voteOptions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"voteOptions"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ProcessVoteOptions")),(0,a.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L191"},"api/chain/transactions.ts:191")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6b798853.d7ce17c1.js b/assets/js/6b798853.ebae92b1.js similarity index 54% rename from assets/js/6b798853.d7ce17c1.js rename to assets/js/6b798853.ebae92b1.js index 25e06bef0..7a440090b 100644 --- a/assets/js/6b798853.d7ce17c1.js +++ b/assets/js/6b798853.ebae92b1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8168],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>f});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function s(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,s=e.originalType,l=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),u=p(n),f=a,g=u["".concat(l,".").concat(f)]||u[f]||c[f]||s;return n?r.createElement(g,i(i({ref:t},d),{},{components:n})):r.createElement(g,i({ref:t},d))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var s=n.length,i=new Array(s);i[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,i[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>c,frontMatter:()=>s,metadata:()=>o,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const s={},i=void 0,o={unversionedId:"sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated",id:"sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated",title:"ICensus3StrategyHoldersResponsePaginated",description:"@vocdoni/sdk / Exports / ICensus3StrategyHoldersResponsePaginated",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategyHoldersResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse"},next:{title:"ICensus3StrategyImportQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse"}},l={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"holders",id:"holders",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"pagination",id:"pagination",level:3},{value:"Defined in",id:"defined-in-1",level:4}],d={toc:p};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3StrategyHoldersResponsePaginated"),(0,a.kt)("h1",{id:"interface-icensus3strategyholdersresponsepaginated"},"Interface: ICensus3StrategyHoldersResponsePaginated"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyHoldersResponse"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ICensus3StrategyHoldersResponsePaginated"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated#holders"},"holders")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated#pagination"},"pagination"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"holders"},"holders"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"holders"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("p",null,"The list of the strategy holders"),(0,a.kt)("h4",{id:"index-signature"},"Index signature"),(0,a.kt)("p",null,"\u25aa ","[key: ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse"},"ICensus3StrategyHoldersResponse"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse#holders"},"holders")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L36"},"api/census3/strategy.ts:36")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"pagination"},"pagination"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"pagination"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Census3Pagination")),(0,a.kt)("p",null,"The pagination information"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L43"},"api/census3/strategy.ts:43")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8168],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>f});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function s(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,s=e.originalType,l=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),c=p(n),f=a,g=c["".concat(l,".").concat(f)]||c[f]||u[f]||s;return n?r.createElement(g,i(i({ref:t},d),{},{components:n})):r.createElement(g,i({ref:t},d))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var s=n.length,i=new Array(s);i[0]=c;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,i[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>s,metadata:()=>o,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const s={},i=void 0,o={unversionedId:"sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated",id:"sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated",title:"ICensus3StrategyHoldersResponsePaginated",description:"@vocdoni/sdk / Exports / ICensus3StrategyHoldersResponsePaginated",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategyHoldersResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse"},next:{title:"ICensus3StrategyImportQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse"}},l={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"holders",id:"holders",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"pagination",id:"pagination",level:3},{value:"Defined in",id:"defined-in-1",level:4}],d={toc:p};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3StrategyHoldersResponsePaginated"),(0,a.kt)("h1",{id:"interface-icensus3strategyholdersresponsepaginated"},"Interface: ICensus3StrategyHoldersResponsePaginated"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"ICensus3StrategyHoldersResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyHoldersResponse"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ICensus3StrategyHoldersResponsePaginated"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3StrategyHoldersResponsePaginated#holders"},"holders")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3StrategyHoldersResponsePaginated#pagination"},"pagination"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"holders"},"holders"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"holders"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("p",null,"The list of the strategy holders"),(0,a.kt)("h4",{id:"index-signature"},"Index signature"),(0,a.kt)("p",null,"\u25aa ","[key: ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse"},"ICensus3StrategyHoldersResponse"),".",(0,a.kt)("a",{parentName:"p",href:"ICensus3StrategyHoldersResponse#holders"},"holders")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L36"},"api/census3/strategy.ts:36")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"pagination"},"pagination"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"pagination"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Census3Pagination")),(0,a.kt)("p",null,"The pagination information"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L43"},"api/census3/strategy.ts:43")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6bf5cd43.f62c8251.js b/assets/js/6bf5cd43.424c6a4f.js similarity index 61% rename from assets/js/6bf5cd43.f62c8251.js rename to assets/js/6bf5cd43.424c6a4f.js index 7d1b63395..4f0828496 100644 --- a/assets/js/6bf5cd43.f62c8251.js +++ b/assets/js/6bf5cd43.424c6a4f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6906],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=r.createContext({}),s=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=s(e.components);return r.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,c=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),f=s(n),u=i,k=f["".concat(c,".").concat(u)]||f[u]||d[u]||a;return n?r.createElement(k,o(o({ref:t},p),{},{components:n})):r.createElement(k,o({ref:t},p))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=f;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l.mdxType="string"==typeof e?e:i,o[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>s});var r=n(87462),i=(n(67294),n(3905));const a={},o=void 0,l={unversionedId:"sdk/reference/interfaces/IElectionCreateResponse",id:"sdk/reference/interfaces/IElectionCreateResponse",title:"IElectionCreateResponse",description:"@vocdoni/sdk / Exports / IElectionCreateResponse",source:"@site/docs/sdk/reference/interfaces/IElectionCreateResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionCreateResponse",permalink:"/sdk/reference/interfaces/IElectionCreateResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChoice",permalink:"/sdk/reference/interfaces/IChoice"},next:{title:"IElectionInfoResponse",permalink:"/sdk/reference/interfaces/IElectionInfoResponse"}},c={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"electionID",id:"electionid",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"metadataURL",id:"metadataurl",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"txHash",id:"txhash",level:3},{value:"Defined in",id:"defined-in-2",level:4}],p={toc:s};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IElectionCreateResponse"),(0,i.kt)("h1",{id:"interface-ielectioncreateresponse"},"Interface: IElectionCreateResponse"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionCreateResponse#electionid"},"electionID")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionCreateResponse#metadataurl"},"metadataURL")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionCreateResponse#txhash"},"txHash"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"electionid"},"electionID"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"electionID"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The election identifier"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L134"},"api/election.ts:134")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"metadataurl"},"metadataURL"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"metadataURL"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The metadata URL"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L139"},"api/election.ts:139")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"txhash"},"txHash"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"txHash"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The hash of the transaction"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L129"},"api/election.ts:129")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6906],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=r.createContext({}),s=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=s(e.components);return r.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,c=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),f=s(n),u=i,m=f["".concat(c,".").concat(u)]||f[u]||d[u]||a;return n?r.createElement(m,o(o({ref:t},p),{},{components:n})):r.createElement(m,o({ref:t},p))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=f;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l.mdxType="string"==typeof e?e:i,o[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>s});var r=n(87462),i=(n(67294),n(3905));const a={},o=void 0,l={unversionedId:"sdk/reference/interfaces/IElectionCreateResponse",id:"sdk/reference/interfaces/IElectionCreateResponse",title:"IElectionCreateResponse",description:"@vocdoni/sdk / Exports / IElectionCreateResponse",source:"@site/docs/sdk/reference/interfaces/IElectionCreateResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionCreateResponse",permalink:"/sdk/reference/interfaces/IElectionCreateResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChoice",permalink:"/sdk/reference/interfaces/IChoice"},next:{title:"IElectionInfoResponse",permalink:"/sdk/reference/interfaces/IElectionInfoResponse"}},c={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"electionID",id:"electionid",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"metadataURL",id:"metadataurl",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"txHash",id:"txhash",level:3},{value:"Defined in",id:"defined-in-2",level:4}],p={toc:s};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IElectionCreateResponse"),(0,i.kt)("h1",{id:"interface-ielectioncreateresponse"},"Interface: IElectionCreateResponse"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IElectionCreateResponse#electionid"},"electionID")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IElectionCreateResponse#metadataurl"},"metadataURL")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IElectionCreateResponse#txhash"},"txHash"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"electionid"},"electionID"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"electionID"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The election identifier"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L134"},"api/election.ts:134")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"metadataurl"},"metadataURL"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"metadataURL"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The metadata URL"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L139"},"api/election.ts:139")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"txhash"},"txHash"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"txHash"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The hash of the transaction"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L129"},"api/election.ts:129")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6d3dfbcd.096330db.js b/assets/js/6d3dfbcd.096330db.js new file mode 100644 index 000000000..02376a9c7 --- /dev/null +++ b/assets/js/6d3dfbcd.096330db.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7082],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>h});var i=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function r(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var p=i.createContext({}),s=function(e){var n=i.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):r(r({},n),e)),t},c=function(e){var n=s(e.components);return i.createElement(p.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),u=s(t),h=a,k=u["".concat(p,".").concat(h)]||u[h]||d[h]||o;return t?i.createElement(k,r(r({ref:n},c),{},{components:t})):i.createElement(k,r({ref:n},c))}));function h(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var o=t.length,r=new Array(o);r[0]=u;var l={};for(var p in n)hasOwnProperty.call(n,p)&&(l[p]=n[p]);l.originalType=e,l.mdxType="string"==typeof e?e:a,r[1]=l;for(var s=2;s{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>r,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>s});var i=t(87462),a=(t(67294),t(3905));const o={},r=void 0,l={unversionedId:"sdk/reference/interfaces/IChainGetInfoResponse",id:"sdk/reference/interfaces/IChainGetInfoResponse",title:"IChainGetInfoResponse",description:"@vocdoni/sdk / Exports / IChainGetInfoResponse",source:"@site/docs/sdk/reference/interfaces/IChainGetInfoResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainGetInfoResponse",permalink:"/sdk/reference/interfaces/IChainGetInfoResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainGetCostsResponse",permalink:"/sdk/reference/interfaces/IChainGetCostsResponse"},next:{title:"IChainOrganizationCountResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationCountResponse"}},p={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"blockTime",id:"blocktime",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"blockTimestamp",id:"blocktimestamp",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"chainId",id:"chainid",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"circuitConfigurationTag",id:"circuitconfigurationtag",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"electionCount",id:"electioncount",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"genesisTime",id:"genesistime",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"height",id:"height",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"organizationCount",id:"organizationcount",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"syncing",id:"syncing",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"transactionCount",id:"transactioncount",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"validatorCount",id:"validatorcount",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"voteCount",id:"votecount",level:3},{value:"Defined in",id:"defined-in-12",level:4}],c={toc:s};function d(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,i.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IChainGetInfoResponse"),(0,a.kt)("h1",{id:"interface-ichaingetinforesponse"},"Interface: IChainGetInfoResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetInfoResponse#blocktime"},"blockTime")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetInfoResponse#blocktimestamp"},"blockTimestamp")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetInfoResponse#chainid"},"chainId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetInfoResponse#circuitconfigurationtag"},"circuitConfigurationTag")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetInfoResponse#electioncount"},"electionCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetInfoResponse#genesistime"},"genesisTime")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetInfoResponse#height"},"height")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetInfoResponse#maxcensussize"},"maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetInfoResponse#organizationcount"},"organizationCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetInfoResponse#syncing"},"syncing")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetInfoResponse#transactioncount"},"transactionCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetInfoResponse#validatorcount"},"validatorCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainGetInfoResponse#votecount"},"voteCount"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"blocktime"},"blockTime"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"blockTime"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,a.kt)("p",null,"The different block times from the chain."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L35"},"api/chain.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"blocktimestamp"},"blockTimestamp"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"blockTimestamp"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The timestamp of the actual block."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L65"},"api/chain.ts:65")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"chainid"},"chainId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"chainId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The id of the current chain"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L30"},"api/chain.ts:30")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"circuitconfigurationtag"},"circuitConfigurationTag"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"circuitConfigurationTag"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The circuit configuration tag."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L85"},"api/chain.ts:85")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"electioncount"},"electionCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"electionCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of elections existing on the Vochain."),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L40"},"api/chain.ts:40")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"genesistime"},"genesisTime"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"genesisTime"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The time of the genesis block."),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L50"},"api/chain.ts:50")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"height"},"height"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"height"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The height or actual block of the current chain."),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L55"},"api/chain.ts:55")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The maximum size of a census."),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L90"},"api/chain.ts:90")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"organizationcount"},"organizationCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"organizationCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of organizations existing on the Vochain."),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L45"},"api/chain.ts:45")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"syncing"},"syncing"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"syncing"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"Whether the blockchain is syncing."),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L60"},"api/chain.ts:60")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"transactioncount"},"transactionCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"transactionCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of transactions."),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L70"},"api/chain.ts:70")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"validatorcount"},"validatorCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"validatorCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of validators."),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L75"},"api/chain.ts:75")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votecount"},"voteCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"voteCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of votes."),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L80"},"api/chain.ts:80")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6d3dfbcd.4bfe24d6.js b/assets/js/6d3dfbcd.4bfe24d6.js deleted file mode 100644 index ecdcd8525..000000000 --- a/assets/js/6d3dfbcd.4bfe24d6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7082],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>f});var i=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function o(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var c=i.createContext({}),s=function(e){var n=i.useContext(c),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},p=function(e){var n=s(e.components);return i.createElement(c.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,r=e.originalType,c=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),u=s(t),f=a,k=u["".concat(c,".").concat(f)]||u[f]||d[f]||r;return t?i.createElement(k,o(o({ref:n},p),{},{components:t})):i.createElement(k,o({ref:n},p))}));function f(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var r=t.length,o=new Array(r);o[0]=u;var l={};for(var c in n)hasOwnProperty.call(n,c)&&(l[c]=n[c]);l.originalType=e,l.mdxType="string"==typeof e?e:a,o[1]=l;for(var s=2;s{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>s});var i=t(87462),a=(t(67294),t(3905));const r={},o=void 0,l={unversionedId:"sdk/reference/interfaces/IChainGetInfoResponse",id:"sdk/reference/interfaces/IChainGetInfoResponse",title:"IChainGetInfoResponse",description:"@vocdoni/sdk / Exports / IChainGetInfoResponse",source:"@site/docs/sdk/reference/interfaces/IChainGetInfoResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainGetInfoResponse",permalink:"/sdk/reference/interfaces/IChainGetInfoResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainGetCostsResponse",permalink:"/sdk/reference/interfaces/IChainGetCostsResponse"},next:{title:"IChainOrganizationCountResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationCountResponse"}},c={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"blockTime",id:"blocktime",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"blockTimestamp",id:"blocktimestamp",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"chainId",id:"chainid",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"circuitConfigurationTag",id:"circuitconfigurationtag",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"electionCount",id:"electioncount",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"genesisTime",id:"genesistime",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"height",id:"height",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"organizationCount",id:"organizationcount",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"syncing",id:"syncing",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"transactionCount",id:"transactioncount",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"validatorCount",id:"validatorcount",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"voteCount",id:"votecount",level:3},{value:"Defined in",id:"defined-in-12",level:4}],p={toc:s};function d(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,i.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IChainGetInfoResponse"),(0,a.kt)("h1",{id:"interface-ichaingetinforesponse"},"Interface: IChainGetInfoResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetInfoResponse#blocktime"},"blockTime")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetInfoResponse#blocktimestamp"},"blockTimestamp")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetInfoResponse#chainid"},"chainId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetInfoResponse#circuitconfigurationtag"},"circuitConfigurationTag")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetInfoResponse#electioncount"},"electionCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetInfoResponse#genesistime"},"genesisTime")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetInfoResponse#height"},"height")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetInfoResponse#maxcensussize"},"maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetInfoResponse#organizationcount"},"organizationCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetInfoResponse#syncing"},"syncing")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetInfoResponse#transactioncount"},"transactionCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetInfoResponse#validatorcount"},"validatorCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetInfoResponse#votecount"},"voteCount"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"blocktime"},"blockTime"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"blockTime"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,a.kt)("p",null,"The different block times from the chain."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L35"},"api/chain.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"blocktimestamp"},"blockTimestamp"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"blockTimestamp"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The timestamp of the actual block."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L65"},"api/chain.ts:65")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"chainid"},"chainId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"chainId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The id of the current chain"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L30"},"api/chain.ts:30")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"circuitconfigurationtag"},"circuitConfigurationTag"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"circuitConfigurationTag"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The circuit configuration tag."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L85"},"api/chain.ts:85")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"electioncount"},"electionCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"electionCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of elections existing on the Vochain."),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L40"},"api/chain.ts:40")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"genesistime"},"genesisTime"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"genesisTime"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The time of the genesis block."),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L50"},"api/chain.ts:50")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"height"},"height"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"height"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The height or actual block of the current chain."),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L55"},"api/chain.ts:55")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The maximum size of a census."),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L90"},"api/chain.ts:90")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"organizationcount"},"organizationCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"organizationCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of organizations existing on the Vochain."),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L45"},"api/chain.ts:45")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"syncing"},"syncing"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"syncing"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"Whether the blockchain is syncing."),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L60"},"api/chain.ts:60")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"transactioncount"},"transactionCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"transactionCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of transactions."),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L70"},"api/chain.ts:70")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"validatorcount"},"validatorCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"validatorCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of validators."),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L75"},"api/chain.ts:75")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votecount"},"voteCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"voteCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of votes."),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L80"},"api/chain.ts:80")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/705711d3.abd50713.js b/assets/js/705711d3.fc7554c0.js similarity index 79% rename from assets/js/705711d3.abd50713.js rename to assets/js/705711d3.fc7554c0.js index e3dac171a..4ec693929 100644 --- a/assets/js/705711d3.abd50713.js +++ b/assets/js/705711d3.fc7554c0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8883],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>d});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function c(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var i=r.createContext({}),u=function(e){var t=r.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=u(e.components);return r.createElement(i.Provider,{value:t},e.children)},l={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,c=e.originalType,i=e.parentName,p=a(e,["components","mdxType","originalType","parentName"]),f=u(n),d=o,m=f["".concat(i,".").concat(d)]||f[d]||l[d]||c;return n?r.createElement(m,s(s({ref:t},p),{},{components:n})):r.createElement(m,s({ref:t},p))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var c=n.length,s=new Array(c);s[0]=f;var a={};for(var i in t)hasOwnProperty.call(t,i)&&(a[i]=t[i]);a.originalType=e,a.mdxType="string"==typeof e?e:o,s[1]=a;for(var u=2;u{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>l,frontMatter:()=>c,metadata:()=>a,toc:()=>u});var r=n(87462),o=(n(67294),n(3905));const c={},s=void 0,a={unversionedId:"sdk/reference/interfaces/IAccountTransfersCountResponse",id:"sdk/reference/interfaces/IAccountTransfersCountResponse",title:"IAccountTransfersCountResponse",description:"@vocdoni/sdk / Exports / IAccountTransfersCountResponse",source:"@site/docs/sdk/reference/interfaces/IAccountTransfersCountResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IAccountTransfersCountResponse",permalink:"/sdk/reference/interfaces/IAccountTransfersCountResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IAccount",permalink:"/sdk/reference/interfaces/IAccount"},next:{title:"IAccountsCountResponse",permalink:"/sdk/reference/interfaces/IAccountsCountResponse"}},i={},u=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"count",id:"count",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:u};function l(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IAccountTransfersCountResponse"),(0,o.kt)("h1",{id:"interface-iaccounttransferscountresponse"},"Interface: IAccountTransfersCountResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IAccountTransfersCountResponse#count"},"count"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"count"},"count"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"count"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"Number of account's transfers"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/account.ts#L95"},"api/account.ts:95")))}l.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8883],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>d});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function c(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var i=r.createContext({}),u=function(e){var t=r.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=u(e.components);return r.createElement(i.Provider,{value:t},e.children)},l={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,c=e.originalType,i=e.parentName,p=a(e,["components","mdxType","originalType","parentName"]),f=u(n),d=o,m=f["".concat(i,".").concat(d)]||f[d]||l[d]||c;return n?r.createElement(m,s(s({ref:t},p),{},{components:n})):r.createElement(m,s({ref:t},p))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var c=n.length,s=new Array(c);s[0]=f;var a={};for(var i in t)hasOwnProperty.call(t,i)&&(a[i]=t[i]);a.originalType=e,a.mdxType="string"==typeof e?e:o,s[1]=a;for(var u=2;u{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>l,frontMatter:()=>c,metadata:()=>a,toc:()=>u});var r=n(87462),o=(n(67294),n(3905));const c={},s=void 0,a={unversionedId:"sdk/reference/interfaces/IAccountTransfersCountResponse",id:"sdk/reference/interfaces/IAccountTransfersCountResponse",title:"IAccountTransfersCountResponse",description:"@vocdoni/sdk / Exports / IAccountTransfersCountResponse",source:"@site/docs/sdk/reference/interfaces/IAccountTransfersCountResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IAccountTransfersCountResponse",permalink:"/sdk/reference/interfaces/IAccountTransfersCountResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IAccount",permalink:"/sdk/reference/interfaces/IAccount"},next:{title:"IAccountsCountResponse",permalink:"/sdk/reference/interfaces/IAccountsCountResponse"}},i={},u=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"count",id:"count",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:u};function l(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IAccountTransfersCountResponse"),(0,o.kt)("h1",{id:"interface-iaccounttransferscountresponse"},"Interface: IAccountTransfersCountResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IAccountTransfersCountResponse#count"},"count"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"count"},"count"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"count"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"Number of account's transfers"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L95"},"api/account.ts:95")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/70e3ad0d.ce4b10c0.js b/assets/js/70e3ad0d.79a5fd82.js similarity index 52% rename from assets/js/70e3ad0d.ce4b10c0.js rename to assets/js/70e3ad0d.79a5fd82.js index 36cae2b70..a10f367a7 100644 --- a/assets/js/70e3ad0d.ce4b10c0.js +++ b/assets/js/70e3ad0d.79a5fd82.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8930],{3905:(e,n,t)=>{t.d(n,{Zo:()=>l,kt:()=>f});var r=t(67294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var p=r.createContext({}),c=function(e){var n=r.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},l=function(e){var n=c(e.components);return r.createElement(p.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},u=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,a=e.originalType,p=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),u=c(t),f=i,h=u["".concat(p,".").concat(f)]||u[f]||d[f]||a;return t?r.createElement(h,o(o({ref:n},l),{},{components:t})):r.createElement(h,o({ref:n},l))}));function f(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var a=t.length,o=new Array(a);o[0]=u;var s={};for(var p in n)hasOwnProperty.call(n,p)&&(s[p]=n[p]);s.originalType=e,s.mdxType="string"==typeof e?e:i,o[1]=s;for(var c=2;c{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var r=t(87462),i=(t(67294),t(3905));const a={},o=void 0,s={unversionedId:"sdk/reference/interfaces/IChainSubmitTxResponse",id:"sdk/reference/interfaces/IChainSubmitTxResponse",title:"IChainSubmitTxResponse",description:"@vocdoni/sdk / Exports / IChainSubmitTxResponse",source:"@site/docs/sdk/reference/interfaces/IChainSubmitTxResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainSubmitTxResponse",permalink:"/sdk/reference/interfaces/IChainSubmitTxResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainOrganizationResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationResponse"},next:{title:"IChainTxCountResponse",permalink:"/sdk/reference/interfaces/IChainTxCountResponse"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"code",id:"code",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"hash",id:"hash",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"response",id:"response",level:3},{value:"Defined in",id:"defined-in-2",level:4}],l={toc:c};function d(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},l,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IChainSubmitTxResponse"),(0,i.kt)("h1",{id:"interface-ichainsubmittxresponse"},"Interface: IChainSubmitTxResponse"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainSubmitTxResponse#code"},"code")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainSubmitTxResponse#hash"},"hash")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainSubmitTxResponse#response"},"response"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"code"},"code"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"code"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The response code"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L227"},"api/chain.ts:227")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"hash"},"hash"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"hash"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The hash of the transaction"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L217"},"api/chain.ts:217")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"response"},"response"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"response"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The response data (can vary depending on the transaction type)"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L222"},"api/chain.ts:222")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8930],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>f});var r=t(67294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var p=r.createContext({}),l=function(e){var n=r.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},c=function(e){var n=l(e.components);return r.createElement(p.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},u=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,a=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),u=l(t),f=i,h=u["".concat(p,".").concat(f)]||u[f]||d[f]||a;return t?r.createElement(h,o(o({ref:n},c),{},{components:t})):r.createElement(h,o({ref:n},c))}));function f(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var a=t.length,o=new Array(a);o[0]=u;var s={};for(var p in n)hasOwnProperty.call(n,p)&&(s[p]=n[p]);s.originalType=e,s.mdxType="string"==typeof e?e:i,o[1]=s;for(var l=2;l{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>s,toc:()=>l});var r=t(87462),i=(t(67294),t(3905));const a={},o=void 0,s={unversionedId:"sdk/reference/interfaces/IChainSubmitTxResponse",id:"sdk/reference/interfaces/IChainSubmitTxResponse",title:"IChainSubmitTxResponse",description:"@vocdoni/sdk / Exports / IChainSubmitTxResponse",source:"@site/docs/sdk/reference/interfaces/IChainSubmitTxResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainSubmitTxResponse",permalink:"/sdk/reference/interfaces/IChainSubmitTxResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainOrganizationResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationResponse"},next:{title:"IChainTxCountResponse",permalink:"/sdk/reference/interfaces/IChainTxCountResponse"}},p={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"code",id:"code",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"hash",id:"hash",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"response",id:"response",level:3},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:l};function d(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IChainSubmitTxResponse"),(0,i.kt)("h1",{id:"interface-ichainsubmittxresponse"},"Interface: IChainSubmitTxResponse"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IChainSubmitTxResponse#code"},"code")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IChainSubmitTxResponse#hash"},"hash")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IChainSubmitTxResponse#response"},"response"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"code"},"code"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"code"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The response code"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L227"},"api/chain.ts:227")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"hash"},"hash"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"hash"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The hash of the transaction"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L217"},"api/chain.ts:217")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"response"},"response"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"response"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The response data (can vary depending on the transaction type)"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L222"},"api/chain.ts:222")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/725284f7.12c4aad7.js b/assets/js/725284f7.61727e72.js similarity index 54% rename from assets/js/725284f7.12c4aad7.js rename to assets/js/725284f7.61727e72.js index 1b8a184ae..73e0c8077 100644 --- a/assets/js/725284f7.12c4aad7.js +++ b/assets/js/725284f7.61727e72.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9942],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>u});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function c(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),l=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},p=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},f={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,c=e.originalType,s=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),d=l(r),u=a,m=d["".concat(s,".").concat(u)]||d[u]||f[u]||c;return r?n.createElement(m,i(i({ref:t},p),{},{components:r})):n.createElement(m,i({ref:t},p))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var c=r.length,i=new Array(c);i[0]=d;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:a,i[1]=o;for(var l=2;l{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>f,frontMatter:()=>c,metadata:()=>o,toc:()=>l});var n=r(87462),a=(r(67294),r(3905));const c={},i=void 0,o={unversionedId:"sdk/reference/interfaces/FetchElectionsParameters",id:"sdk/reference/interfaces/FetchElectionsParameters",title:"FetchElectionsParameters",description:"@vocdoni/sdk / Exports / FetchElectionsParameters",source:"@site/docs/sdk/reference/interfaces/FetchElectionsParameters.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/FetchElectionsParameters",permalink:"/sdk/reference/interfaces/FetchElectionsParameters",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ElectionMetadata",permalink:"/sdk/reference/interfaces/ElectionMetadata"},next:{title:"IAccount",permalink:"/sdk/reference/interfaces/IAccount"}},s={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"account",id:"account",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"page",id:"page",level:3},{value:"Defined in",id:"defined-in-1",level:4}],p={toc:l};function f(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / FetchElectionsParameters"),(0,a.kt)("h1",{id:"interface-fetchelectionsparameters"},"Interface: FetchElectionsParameters"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/FetchElectionsParameters#account"},"account")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/FetchElectionsParameters#page"},"page"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"account"},"account"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"account"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L32"},"services/election.ts:32")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"page"},"page"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"page"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L33"},"services/election.ts:33")))}f.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9942],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>f});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function c(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),s=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},p=function(e){var t=s(e.components);return n.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,c=e.originalType,l=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),d=s(r),f=a,m=d["".concat(l,".").concat(f)]||d[f]||u[f]||c;return r?n.createElement(m,o(o({ref:t},p),{},{components:r})):n.createElement(m,o({ref:t},p))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var c=r.length,o=new Array(c);o[0]=d;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i.mdxType="string"==typeof e?e:a,o[1]=i;for(var s=2;s{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>c,metadata:()=>i,toc:()=>s});var n=r(87462),a=(r(67294),r(3905));const c={},o=void 0,i={unversionedId:"sdk/reference/interfaces/FetchElectionsParameters",id:"sdk/reference/interfaces/FetchElectionsParameters",title:"FetchElectionsParameters",description:"@vocdoni/sdk / Exports / FetchElectionsParameters",source:"@site/docs/sdk/reference/interfaces/FetchElectionsParameters.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/FetchElectionsParameters",permalink:"/sdk/reference/interfaces/FetchElectionsParameters",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ElectionMetadata",permalink:"/sdk/reference/interfaces/ElectionMetadata"},next:{title:"IAccount",permalink:"/sdk/reference/interfaces/IAccount"}},l={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"account",id:"account",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"page",id:"page",level:3},{value:"Defined in",id:"defined-in-1",level:4}],p={toc:s};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / FetchElectionsParameters"),(0,a.kt)("h1",{id:"interface-fetchelectionsparameters"},"Interface: FetchElectionsParameters"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"FetchElectionsParameters#account"},"account")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"FetchElectionsParameters#page"},"page"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"account"},"account"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"account"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L32"},"services/election.ts:32")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"page"},"page"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"page"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L33"},"services/election.ts:33")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/74b5ba26.734b3eb9.js b/assets/js/74b5ba26.1d9653a1.js similarity index 99% rename from assets/js/74b5ba26.734b3eb9.js rename to assets/js/74b5ba26.1d9653a1.js index f010c85ff..46af90917 100644 --- a/assets/js/74b5ba26.734b3eb9.js +++ b/assets/js/74b5ba26.1d9653a1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3773],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),c=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},p=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),d=c(n),h=i,m=d["".concat(s,".").concat(h)]||d[h]||u[h]||o;return n?r.createElement(m,a(a({ref:t},p),{},{components:n})):r.createElement(m,a({ref:t},p))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,a=new Array(o);a[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:i,a[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var r=n(87462),i=(n(67294),n(3905));const o={},a="CSP Blind Signatures",l={unversionedId:"protocol/anonymity/blind-signatures",id:"protocol/anonymity/blind-signatures",title:"CSP Blind Signatures",description:"The current approach by Vocdoni regarding determining the eligibility of a potential voter is to use a Census Merkle Tree. All voter public keys must be known in advance and aggregated together into a hash tree to compute a Merkle root. Then each voter needs to fetch their own Merkle proof to demonstrate their eligibility on a public ledger. The Merkle proof can be anonymized using a zk-SNARK so that the public ledger will verify the SNARK proof instead.",source:"@site/docs/protocol/anonymity/blind-signatures.md",sourceDirName:"protocol/anonymity",slug:"/protocol/anonymity/blind-signatures",permalink:"/protocol/anonymity/blind-signatures",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Anonymous Voting",permalink:"/protocol/anonymity/"},next:{title:"On-Chain Pseudo-Anonymity",permalink:"/protocol/anonymity/on-chain"}},s={},c=[{value:"Salted CSP keys",id:"salted-csp-keys",level:2},{value:"Flow diagram",id:"flow-diagram",level:2},{value:"Known Problems",id:"known-problems",level:2},{value:"Links",id:"links",level:2}],p={toc:c};function u(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"csp-blind-signatures"},"CSP Blind Signatures"),(0,i.kt)("p",null,"The current approach by Vocdoni regarding determining the eligibility of a potential voter is to use a Census Merkle Tree. All voter public keys must be known in advance and aggregated together into a hash tree to compute a Merkle root. Then each voter needs to fetch their own Merkle proof to demonstrate their eligibility on a public ledger. The Merkle proof can be anonymized using a zk-SNARK so that the public ledger will verify the SNARK proof instead."),(0,i.kt)("p",null,"This approach is nice since the same census Merkle Tree can be reused repeatedly and by anyone (not only the owner). It adds resiliency to the process since any third party can obtain the tree (there is no private information involved; thus, it can be published into IPFS) to help the potential voters fetch their proofs. Finally, it is reproducible since anyone with the same list of keys could build the same root hash and verify the Tree generation was correctly executed."),(0,i.kt)("p",null,"However, this approach lacks flexibility since it is a static way to create a voter list (adding or deleting a public key requires rebuilding and publishing the census again). The current Vocdoni protocol implements an ",(0,i.kt)("inlineCode",{parentName:"p"},"updateCensus")," mechanism, but this is not very convenient for use cases that require constant census modifications (each update requires an Ethereum transaction)."),(0,i.kt)("p",null,"In order to support such scenarios and bring more flexibility to the Vocdoni stack, a new approach is proposed based on Credential Service Providers (CSP). A voter will need to show a proof provided by the election CSP for proving its eligibility which is made up of the CSP's signature to the voter's public key."),(0,i.kt)("p",null,"For preserving the anonymity of the voter, the CSP server will perform a blind signature. Blind signatures were first suggested by David Chaum: a cryptographic scheme that allows for signatures over disguised (blinded) messages. The blinder (voter in our scenario) can then un-blind the signature and use it as a normal/standard one. This protocol was designed for RSA, but we will use it over EC secp256k1 (Ethereum and Vocdoni standard)."),(0,i.kt)("h2",{id:"salted-csp-keys"},"Salted CSP keys"),(0,i.kt)("p",null,"For making the CSP voter approval valid only for a specific election process (processId) and attached to a specific weight while preserving the privacy, a deterministic key derivation is used. So the CSP is only required to publish a single root public key. The specific per-election keys will be computed independently by all parties (CSP will derive its election private key and the election organizers will derive the election public key). To this end we use the following simple approach (G is the EC generator point):"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"PubKeyRoot = PrivKeyRoot * G\nPrivKey2 = PrivkeyRoot + ProcessId + Weight\nPubKey2 = PubKeyRoot + (ProcessId + Weight)*G\n")),(0,i.kt)("p",null,"So if PubKey2 becomes the election CSP public key, there is no way the CSP can share signature proofs before the processId is known and there is no way to reuse a CSP signature for a different election process."),(0,i.kt)("h2",{id:"flow-diagram"},"Flow diagram"),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://kroki.io/mermaid/svg/eNp9U01PwzAMvfMrfAOEGAJuE0zi44KQJgQSF8TBS9w2aklGkm7avyd2OzWs23pp6z6_vPfsBvptySp6Nlh6_DmBdC3RR6PMEm2ETxfJj6pPH2-j2mPjVK0qNFY-SePlbDaUp1BShKV3ikJ40UdR6QDwziV4u2iMgpo2__ByZ6glj5HA0hpWLhpbjqCJagrYxops0orROAuF8ztCEmqLVRWpeqdDMPPECN6UVQRXgGBZpyZlNAW4W_irGaQuqI3VDNnD0Z3Ty4-uJvsOmNBrYt59HhetaTSbI1BhmV6tbiglr2osadDVUCGy-q4vVtZhv0XY9UQ4_JzWD1r75FzKN5MhCCncTo5padjZQA1t4Mg7H-PUBU76sgezzwyaRb4ib4rNNg8TYIWNGQ0mYJNtxnbOe6aStuGVNnAvQH66GEym58xfzm5Ku6t4bWLVs42nx3JI95lwN8bWE4vouvcF2NpduFwH_wWFIcpKyfzPurg5gp6IcioMbNMV54dykVQxOh_6JWfmbm2ZszeUWUlzydZa9uc0AHb7k-_tH9ykZ4Y=",alt:"flow_diagram_csp"})),(0,i.kt)("h2",{id:"known-problems"},"Known Problems"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Time correlation, the CSP might know which voter is actually casting a vote.\n",(0,i.kt)("em",{parentName:"li"},"Could be solved using a delay mixnet (such as Nymtech)"))),(0,i.kt)("h2",{id:"links"},"Links"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},"H. Mala, N. Nezhadansari, ",(0,i.kt)("em",{parentName:"li"},'"New Blind Signature Schemes Based on the (Elliptic Curve) Discrete Logarithm Problem"')," ",(0,i.kt)("a",{parentName:"li",href:"https://sci-hub.st/10.1109/iccke.2013.6682844"},"https://sci-hub.st/10.1109/iccke.2013.6682844")," Implementation: ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/arnaucube/go-blindsecp256k1"},"https://github.com/arnaucube/go-blindsecp256k1")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("em",{parentName:"li"},"EC deterministic derivation key schema PoC implementation"),(0,i.kt)("a",{parentName:"li",href:"https://github.com/p4u/go-eckey-derivation/blob/master/main.go"},"https://github.com/p4u/go-eckey-derivation")),(0,i.kt)("li",{parentName:"ol"},"CSP server implementation ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/blind-csp"},"https://github.com/vocdoni/blind-csp"))))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3773],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),c=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},p=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),d=c(n),h=i,m=d["".concat(s,".").concat(h)]||d[h]||u[h]||o;return n?r.createElement(m,a(a({ref:t},p),{},{components:n})):r.createElement(m,a({ref:t},p))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,a=new Array(o);a[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:i,a[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var r=n(87462),i=(n(67294),n(3905));const o={},a="CSP Blind Signatures",l={unversionedId:"protocol/anonymity/blind-signatures",id:"protocol/anonymity/blind-signatures",title:"CSP Blind Signatures",description:"The current approach by Vocdoni regarding determining the eligibility of a potential voter is to use a Census Merkle Tree. All voter public keys must be known in advance and aggregated together into a hash tree to compute a Merkle root. Then each voter needs to fetch their own Merkle proof to demonstrate their eligibility on a public ledger. The Merkle proof can be anonymized using a zk-SNARK so that the public ledger will verify the SNARK proof instead.",source:"@site/docs/protocol/anonymity/blind-signatures.md",sourceDirName:"protocol/anonymity",slug:"/protocol/anonymity/blind-signatures",permalink:"/protocol/anonymity/blind-signatures",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Anonymous Voting",permalink:"/protocol/anonymity/"},next:{title:"On-Chain Census Anonymity",permalink:"/protocol/anonymity/on-chain"}},s={},c=[{value:"Salted CSP keys",id:"salted-csp-keys",level:2},{value:"Flow diagram",id:"flow-diagram",level:2},{value:"Known Problems",id:"known-problems",level:2},{value:"Links",id:"links",level:2}],p={toc:c};function u(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"csp-blind-signatures"},"CSP Blind Signatures"),(0,i.kt)("p",null,"The current approach by Vocdoni regarding determining the eligibility of a potential voter is to use a Census Merkle Tree. All voter public keys must be known in advance and aggregated together into a hash tree to compute a Merkle root. Then each voter needs to fetch their own Merkle proof to demonstrate their eligibility on a public ledger. The Merkle proof can be anonymized using a zk-SNARK so that the public ledger will verify the SNARK proof instead."),(0,i.kt)("p",null,"This approach is nice since the same census Merkle Tree can be reused repeatedly and by anyone (not only the owner). It adds resiliency to the process since any third party can obtain the tree (there is no private information involved; thus, it can be published into IPFS) to help the potential voters fetch their proofs. Finally, it is reproducible since anyone with the same list of keys could build the same root hash and verify the Tree generation was correctly executed."),(0,i.kt)("p",null,"However, this approach lacks flexibility since it is a static way to create a voter list (adding or deleting a public key requires rebuilding and publishing the census again). The current Vocdoni protocol implements an ",(0,i.kt)("inlineCode",{parentName:"p"},"updateCensus")," mechanism, but this is not very convenient for use cases that require constant census modifications (each update requires an Ethereum transaction)."),(0,i.kt)("p",null,"In order to support such scenarios and bring more flexibility to the Vocdoni stack, a new approach is proposed based on Credential Service Providers (CSP). A voter will need to show a proof provided by the election CSP for proving its eligibility which is made up of the CSP's signature to the voter's public key."),(0,i.kt)("p",null,"For preserving the anonymity of the voter, the CSP server will perform a blind signature. Blind signatures were first suggested by David Chaum: a cryptographic scheme that allows for signatures over disguised (blinded) messages. The blinder (voter in our scenario) can then un-blind the signature and use it as a normal/standard one. This protocol was designed for RSA, but we will use it over EC secp256k1 (Ethereum and Vocdoni standard)."),(0,i.kt)("h2",{id:"salted-csp-keys"},"Salted CSP keys"),(0,i.kt)("p",null,"For making the CSP voter approval valid only for a specific election process (processId) and attached to a specific weight while preserving the privacy, a deterministic key derivation is used. So the CSP is only required to publish a single root public key. The specific per-election keys will be computed independently by all parties (CSP will derive its election private key and the election organizers will derive the election public key). To this end we use the following simple approach (G is the EC generator point):"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"PubKeyRoot = PrivKeyRoot * G\nPrivKey2 = PrivkeyRoot + ProcessId + Weight\nPubKey2 = PubKeyRoot + (ProcessId + Weight)*G\n")),(0,i.kt)("p",null,"So if PubKey2 becomes the election CSP public key, there is no way the CSP can share signature proofs before the processId is known and there is no way to reuse a CSP signature for a different election process."),(0,i.kt)("h2",{id:"flow-diagram"},"Flow diagram"),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://kroki.io/mermaid/svg/eNp9U01PwzAMvfMrfAOEGAJuE0zi44KQJgQSF8TBS9w2aklGkm7avyd2OzWs23pp6z6_vPfsBvptySp6Nlh6_DmBdC3RR6PMEm2ETxfJj6pPH2-j2mPjVK0qNFY-SePlbDaUp1BShKV3ikJ40UdR6QDwziV4u2iMgpo2__ByZ6glj5HA0hpWLhpbjqCJagrYxops0orROAuF8ztCEmqLVRWpeqdDMPPECN6UVQRXgGBZpyZlNAW4W_irGaQuqI3VDNnD0Z3Ty4-uJvsOmNBrYt59HhetaTSbI1BhmV6tbiglr2osadDVUCGy-q4vVtZhv0XY9UQ4_JzWD1r75FzKN5MhCCncTo5padjZQA1t4Mg7H-PUBU76sgezzwyaRb4ib4rNNg8TYIWNGQ0mYJNtxnbOe6aStuGVNnAvQH66GEym58xfzm5Ku6t4bWLVs42nx3JI95lwN8bWE4vouvcF2NpduFwH_wWFIcpKyfzPurg5gp6IcioMbNMV54dykVQxOh_6JWfmbm2ZszeUWUlzydZa9uc0AHb7k-_tH9ykZ4Y=",alt:"flow_diagram_csp"})),(0,i.kt)("h2",{id:"known-problems"},"Known Problems"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Time correlation, the CSP might know which voter is actually casting a vote.\n",(0,i.kt)("em",{parentName:"li"},"Could be solved using a delay mixnet (such as Nymtech)"))),(0,i.kt)("h2",{id:"links"},"Links"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},"H. Mala, N. Nezhadansari, ",(0,i.kt)("em",{parentName:"li"},'"New Blind Signature Schemes Based on the (Elliptic Curve) Discrete Logarithm Problem"')," ",(0,i.kt)("a",{parentName:"li",href:"https://sci-hub.st/10.1109/iccke.2013.6682844"},"https://sci-hub.st/10.1109/iccke.2013.6682844")," Implementation: ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/arnaucube/go-blindsecp256k1"},"https://github.com/arnaucube/go-blindsecp256k1")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("em",{parentName:"li"},"EC deterministic derivation key schema PoC implementation"),(0,i.kt)("a",{parentName:"li",href:"https://github.com/p4u/go-eckey-derivation/blob/master/main.go"},"https://github.com/p4u/go-eckey-derivation")),(0,i.kt)("li",{parentName:"ol"},"CSP server implementation ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/blind-csp"},"https://github.com/vocdoni/blind-csp"))))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7644a8b6.f01d5d91.js b/assets/js/7644a8b6.722c39d9.js similarity index 57% rename from assets/js/7644a8b6.f01d5d91.js rename to assets/js/7644a8b6.722c39d9.js index 766cc2c1a..198e5d632 100644 --- a/assets/js/7644a8b6.f01d5d91.js +++ b/assets/js/7644a8b6.722c39d9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5421],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var a=r.createContext({}),l=function(e){var t=r.useContext(a),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=l(e.components);return r.createElement(a.Provider,{value:t},e.children)},f={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,a=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),d=l(n),u=o,m=d["".concat(a,".").concat(u)]||d[u]||f[u]||i;return n?r.createElement(m,s(s({ref:t},p),{},{components:n})):r.createElement(m,s({ref:t},p))}));function u(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,s=new Array(i);s[0]=d;var c={};for(var a in t)hasOwnProperty.call(t,a)&&(c[a]=t[a]);c.originalType=e,c.mdxType="string"==typeof e?e:o,s[1]=c;for(var l=2;l{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>f,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var r=n(87462),o=(n(67294),n(3905));const i={},s=void 0,c={unversionedId:"sdk/reference/interfaces/IElectionListResponse",id:"sdk/reference/interfaces/IElectionListResponse",title:"IElectionListResponse",description:"@vocdoni/sdk / Exports / IElectionListResponse",source:"@site/docs/sdk/reference/interfaces/IElectionListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionListResponse",permalink:"/sdk/reference/interfaces/IElectionListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionListFilter",permalink:"/sdk/reference/interfaces/IElectionListFilter"},next:{title:"IElectionMode",permalink:"/sdk/reference/interfaces/IElectionMode"}},a={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"elections",id:"elections",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:l};function f(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IElectionListResponse"),(0,o.kt)("h1",{id:"interface-ielectionlistresponse"},"Interface: IElectionListResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionListResponse#elections"},"elections"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"elections"},"elections"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"elections"),": ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionSummary"},(0,o.kt)("inlineCode",{parentName:"a"},"IElectionSummary")),"[]"),(0,o.kt)("p",null,"List of election summaries"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L359"},"api/election.ts:359")))}f.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5421],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>d});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var l=r.createContext({}),a=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=a(e.components);return r.createElement(l.Provider,{value:t},e.children)},f={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,l=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),u=a(n),d=o,m=u["".concat(l,".").concat(d)]||u[d]||f[d]||i;return n?r.createElement(m,s(s({ref:t},p),{},{components:n})):r.createElement(m,s({ref:t},p))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,s=new Array(i);s[0]=u;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c.mdxType="string"==typeof e?e:o,s[1]=c;for(var a=2;a{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>f,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var r=n(87462),o=(n(67294),n(3905));const i={},s=void 0,c={unversionedId:"sdk/reference/interfaces/IElectionListResponse",id:"sdk/reference/interfaces/IElectionListResponse",title:"IElectionListResponse",description:"@vocdoni/sdk / Exports / IElectionListResponse",source:"@site/docs/sdk/reference/interfaces/IElectionListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionListResponse",permalink:"/sdk/reference/interfaces/IElectionListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionListFilter",permalink:"/sdk/reference/interfaces/IElectionListFilter"},next:{title:"IElectionMode",permalink:"/sdk/reference/interfaces/IElectionMode"}},l={},a=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"elections",id:"elections",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:a};function f(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IElectionListResponse"),(0,o.kt)("h1",{id:"interface-ielectionlistresponse"},"Interface: IElectionListResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IElectionListResponse#elections"},"elections"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"elections"},"elections"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"elections"),": ",(0,o.kt)("a",{parentName:"p",href:"IElectionSummary"},(0,o.kt)("inlineCode",{parentName:"a"},"IElectionSummary")),"[]"),(0,o.kt)("p",null,"List of election summaries"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L359"},"api/election.ts:359")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/783013b2.088c8ae3.js b/assets/js/783013b2.088c8ae3.js deleted file mode 100644 index dd4b47db0..000000000 --- a/assets/js/783013b2.088c8ae3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7374],{3905:(e,t,n)=>{n.d(t,{Zo:()=>k,kt:()=>m});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),d=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},k=function(e){var t=d(e.components);return a.createElement(p.Provider,{value:t},e.children)},o={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,k=l(e,["components","mdxType","originalType","parentName"]),u=d(n),m=r,c=u["".concat(p,".").concat(m)]||u[m]||o[m]||i;return n?a.createElement(c,s(s({ref:t},k),{},{components:n})):a.createElement(c,s({ref:t},k))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,s=new Array(i);s[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:r,s[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>o,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var a=n(87462),r=(n(67294),n(3905));const i={},s=void 0,l={unversionedId:"sdk/reference/classes/CensusService",id:"sdk/reference/classes/CensusService",title:"CensusService",description:"@vocdoni/sdk / Exports / CensusService",source:"@site/docs/sdk/reference/classes/CensusService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/CensusService",permalink:"/sdk/reference/classes/CensusService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CensusAPI",permalink:"/sdk/reference/classes/CensusAPI"},next:{title:"ChainAPI",permalink:"/sdk/reference/classes/ChainAPI"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"auth",id:"auth",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"chunk_size",id:"chunk_size",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods-1",level:2},{value:"add",id:"add",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"addParallel",id:"addparallel",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"createCensus",id:"createcensus",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"createCensusParallel",id:"createcensusparallel",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"delete",id:"delete",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"export",id:"export",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"fetchAccountToken",id:"fetchaccounttoken",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"fetchProof",id:"fetchproof",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"import",id:"import",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"publish",id:"publish",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-15",level:4}],k={toc:d};function o(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / CensusService"),(0,r.kt)("h1",{id:"class-censusservice"},"Class: CensusService"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},(0,r.kt)("inlineCode",{parentName:"a"},"Service"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"CensusService"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"CensusServiceProperties"))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#auth"},"auth")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#chunk_size"},"chunk","_","size")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#url"},"url"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#add"},"add")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#addparallel"},"addParallel")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#create"},"create")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#createcensus"},"createCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#createcensusparallel"},"createCensusParallel")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#delete"},"delete")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#export"},"export")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#fetchaccounttoken"},"fetchAccountToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#fetchproof"},"fetchProof")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#get"},"get")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#import"},"import")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#publish"},"publish"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new CensusService"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CensusService"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusService"))),(0,r.kt)("p",null,"Instantiate the census service."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"CensusServiceParameters"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CensusService"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusService"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#constructor"},"constructor")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L73"},"services/census.ts:73")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"auth"},"auth"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"auth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CensusAuth")),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,"CensusServiceProperties.auth"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L65"},"services/census.ts:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"chunk_size"},"chunk","_","size"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"chunk","_","size"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,"CensusServiceProperties.chunk","_","size"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L66"},"services/census.ts:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"url"},"url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#url"},"url")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/service.ts#L6"},"services/service.ts:6")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"add"},"add"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"add"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participants")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L145"},"services/census.ts:145")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"addparallel"},"addParallel"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addParallel"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusAddResponse"),">","[]"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participants")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusAddResponse"),">","[]"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L169"},"services/census.ts:169")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"create"},"create"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"create"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusType"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"auth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusType")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType")))))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"auth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L137"},"services/census.ts:137")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createcensus"},"createCensus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createCensus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"census"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Publishes the given census."),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"census")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/PlainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PlainCensus"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/WeightedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"WeightedCensus"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census to be published.")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L232"},"services/census.ts:232")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createcensusparallel"},"createCensusParallel"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createCensusParallel"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"census"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Publishes the given census."),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"census")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/PlainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PlainCensus"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/WeightedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"WeightedCensus"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census to be published.")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L254"},"services/census.ts:254")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"delete"},"delete"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"delete"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Deletes the given census."),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L110"},"services/census.ts:110")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"export"},"export"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"export"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#censusimportexport"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusImportExport")),">"),(0,r.kt)("p",null,"Exports the given census identifier."),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census identifier")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#censusimportexport"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusImportExport")),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L206"},"services/census.ts:206")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchaccounttoken"},"fetchAccountToken"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchAccountToken"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Fetches the specific account token auth and sets it to the current instance."),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L275"},"services/census.ts:275")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchproof"},"fetchProof"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchProof"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#censusproof"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusProof")),">"),(0,r.kt)("p",null,"Fetches proof that an address is part of the specified census."),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Census we want to check the address against")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The address to be found")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#censusproof"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusProof")),">"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L124"},"services/census.ts:124")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"size"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"weight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"bigint")," }",">"),(0,r.kt)("p",null,"Fetches the information of a given census."),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"size"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"weight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"bigint")," }",">"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L84"},"services/census.ts:84")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"import"},"import"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"import"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusImportResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusImportResponse")),">"),(0,r.kt)("p",null,"Imports data into the given census identifier."),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census identifier")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#censusimportexport"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusImportExport"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census data")))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusImportResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusImportResponse")),">"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L219"},"services/census.ts:219")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"publish"},"publish"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"publish"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusPublishResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusPublishResponse")),">"),(0,r.kt)("p",null,"Publishes the given census identifier."),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census identifier")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusPublishResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusPublishResponse")),">"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L194"},"services/census.ts:194")))}o.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/783013b2.4391fe11.js b/assets/js/783013b2.4391fe11.js new file mode 100644 index 000000000..b7c4ba411 --- /dev/null +++ b/assets/js/783013b2.4391fe11.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7374],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>m});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),d=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},o=function(e){var t=d(e.components);return a.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),u=d(n),m=r,c=u["".concat(p,".").concat(m)]||u[m]||k[m]||i;return n?a.createElement(c,l(l({ref:t},o),{},{components:n})):a.createElement(c,l({ref:t},o))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=u;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s.mdxType="string"==typeof e?e:r,l[1]=s;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,s={unversionedId:"sdk/reference/classes/CensusService",id:"sdk/reference/classes/CensusService",title:"CensusService",description:"@vocdoni/sdk / Exports / CensusService",source:"@site/docs/sdk/reference/classes/CensusService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/CensusService",permalink:"/sdk/reference/classes/CensusService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CensusAPI",permalink:"/sdk/reference/classes/CensusAPI"},next:{title:"ChainAPI",permalink:"/sdk/reference/classes/ChainAPI"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"auth",id:"auth",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"chunk_size",id:"chunk_size",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods-1",level:2},{value:"add",id:"add",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"addParallel",id:"addparallel",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"createCensus",id:"createcensus",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"createCensusParallel",id:"createcensusparallel",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"delete",id:"delete",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"export",id:"export",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"fetchAccountToken",id:"fetchaccounttoken",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"fetchProof",id:"fetchproof",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"import",id:"import",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"publish",id:"publish",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-15",level:4}],o={toc:d};function k(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / CensusService"),(0,r.kt)("h1",{id:"class-censusservice"},"Class: CensusService"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"Service"},(0,r.kt)("inlineCode",{parentName:"a"},"Service"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"CensusService"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"CensusServiceProperties"))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusService#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusService#auth"},"auth")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService#chunk_size"},"chunk","_","size")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusService#url"},"url"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusService#add"},"add")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusService#addparallel"},"addParallel")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusService#create"},"create")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusService#createcensus"},"createCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusService#createcensusparallel"},"createCensusParallel")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusService#delete"},"delete")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusService#export"},"export")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusService#fetchaccounttoken"},"fetchAccountToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusService#fetchproof"},"fetchProof")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusService#get"},"get")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusService#import"},"import")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusService#publish"},"publish"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new CensusService"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,r.kt)("a",{parentName:"p",href:"CensusService"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusService"))),(0,r.kt)("p",null,"Instantiate the census service."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"CensusServiceParameters"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"CensusService"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusService"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,r.kt)("a",{parentName:"p",href:"Service#constructor"},"constructor")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L73"},"services/census.ts:73")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"auth"},"auth"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"auth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CensusAuth")),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,"CensusServiceProperties.auth"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L65"},"services/census.ts:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"chunk_size"},"chunk","_","size"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"chunk","_","size"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,"CensusServiceProperties.chunk","_","size"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L66"},"services/census.ts:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"url"},"url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,r.kt)("a",{parentName:"p",href:"Service#url"},"url")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/service.ts#L6"},"services/service.ts:6")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"add"},"add"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"add"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participants")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L145"},"services/census.ts:145")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"addparallel"},"addParallel"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addParallel"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusAddResponse"),">","[]"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participants")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensusAddResponse"),">","[]"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L169"},"services/census.ts:169")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"create"},"create"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"create"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusType"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"auth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusType")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType")))))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"auth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L137"},"services/census.ts:137")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createcensus"},"createCensus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createCensus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"census"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Publishes the given census."),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"census")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/PlainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PlainCensus"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"WeightedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"WeightedCensus"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census to be published.")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L232"},"services/census.ts:232")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createcensusparallel"},"createCensusParallel"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createCensusParallel"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"census"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Publishes the given census."),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"census")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/PlainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PlainCensus"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"WeightedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"WeightedCensus"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census to be published.")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L254"},"services/census.ts:254")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"delete"},"delete"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"delete"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Deletes the given census."),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L110"},"services/census.ts:110")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"export"},"export"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"export"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#censusimportexport"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusImportExport")),">"),(0,r.kt)("p",null,"Exports the given census identifier."),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census identifier")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#censusimportexport"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusImportExport")),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L206"},"services/census.ts:206")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchaccounttoken"},"fetchAccountToken"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchAccountToken"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Fetches the specific account token auth and sets it to the current instance."),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L275"},"services/census.ts:275")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchproof"},"fetchProof"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchProof"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#censusproof"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusProof")),">"),(0,r.kt)("p",null,"Fetches proof that an address is part of the specified census."),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Census we want to check the address against")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The address to be found")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#censusproof"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusProof")),">"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L124"},"services/census.ts:124")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"size"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"weight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"bigint")," }",">"),(0,r.kt)("p",null,"Fetches the information of a given census."),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"size"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"weight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"bigint")," }",">"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L84"},"services/census.ts:84")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"import"},"import"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"import"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusImportResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusImportResponse")),">"),(0,r.kt)("p",null,"Imports data into the given census identifier."),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census identifier")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../modules#censusimportexport"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusImportExport"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census data")))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusImportResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusImportResponse")),">"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L219"},"services/census.ts:219")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"publish"},"publish"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"publish"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusPublishResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusPublishResponse")),">"),(0,r.kt)("p",null,"Publishes the given census identifier."),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census identifier")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusPublishResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusPublishResponse")),">"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L194"},"services/census.ts:194")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/787465aa.9d830896.js b/assets/js/787465aa.9d830896.js deleted file mode 100644 index 4537b2da7..000000000 --- a/assets/js/787465aa.9d830896.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7673],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>c});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),o=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=o(e.components);return a.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),m=o(n),c=r,u=m["".concat(p,".").concat(c)]||m[c]||k[c]||i;return n?a.createElement(u,l(l({ref:t},s),{},{components:n})):a.createElement(u,l({ref:t},s))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,d={unversionedId:"sdk/reference/classes/AccountAPI",id:"sdk/reference/classes/AccountAPI",title:"AccountAPI",description:"@vocdoni/sdk / Exports / AccountAPI",source:"@site/docs/sdk/reference/classes/AccountAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/AccountAPI",permalink:"/sdk/reference/classes/AccountAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Account",permalink:"/sdk/reference/classes/Account"},next:{title:"AccountService",permalink:"/sdk/reference/classes/AccountService"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"count",id:"count",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"electionsList",id:"electionslist",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"info",id:"info",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"list",id:"list",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"metadata",id:"metadata",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"setInfo",id:"setinfo",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"transfersCount",id:"transferscount",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"transfersList",id:"transferslist",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4}],s={toc:o};function k(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / AccountAPI"),(0,r.kt)("h1",{id:"class-accountapi"},"Class: AccountAPI"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"API")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"AccountAPI"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountAPI#constructor"},"constructor"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountAPI#count"},"count")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountAPI#electionslist"},"electionsList")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountAPI#info"},"info")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountAPI#isapierror"},"isApiError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountAPI#isundefinederror"},"isUndefinedError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountAPI#list"},"list")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountAPI#metadata"},"metadata")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountAPI#setinfo"},"setInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountAPI#transferscount"},"transfersCount")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountAPI#transferslist"},"transfersList"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new AccountAPI"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/AccountAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountAPI"))),(0,r.kt)("p",null,"Cannot be constructed."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/AccountAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountAPI"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"API.constructor"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/account.ts#L109"},"api/account.ts:109")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"count"},"count"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"count"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IAccountsCountResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IAccountsCountResponse")),">"),(0,r.kt)("p",null,"Returns the number of accounts"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IAccountsCountResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IAccountsCountResponse")),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/account.ts#L133"},"api/account.ts:133")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electionslist"},"electionsList"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"electionsList"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"accountId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionListResponse")),">"),(0,r.kt)("p",null,"Returns paginated list of elections for a specific account"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"accountId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"accountId to get elections")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The page number")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/account.ts#L220"},"api/account.ts:220")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"info"},"info"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"info"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"accountId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IAccountInfoResponse"),">"),(0,r.kt)("p",null,"Fetches an Account information"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"accountId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The account we want the info from")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IAccountInfoResponse"),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/account.ts#L147"},"api/account.ts:147")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isapierror"},"isApiError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"API.isApiError"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L21"},"api/api.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"API.isUndefinedError"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L64"},"api/api.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"list"},"list"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"list"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IAccountsListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IAccountsListResponse")),">"),(0,r.kt)("p",null,"Returns paginated list of accounts"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The page number")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IAccountsListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IAccountsListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/account.ts#L120"},"api/account.ts:120")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"metadata"},"metadata"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"metadata"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"accountId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/AccountMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountMetadata")),">"),(0,r.kt)("p",null,"Fetches the account metadata"),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"accountId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The account we want the info from")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/AccountMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountMetadata")),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/account.ts#L161"},"api/account.ts:161")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setinfo"},"setInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"metadata"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IAccountSetInfoResponse"),">"),(0,r.kt)("p",null,"Sets Account information"),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The set information info raw payload to be submitted to the chain")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"metadata")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The base64 encoded metadata JSON object")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IAccountSetInfoResponse"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/account.ts#L176"},"api/account.ts:176")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"transferscount"},"transfersCount"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"transfersCount"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"accountId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IAccountTransfersCountResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IAccountTransfersCountResponse")),">"),(0,r.kt)("p",null,"Returns the account's transfers count"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"accountId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"accountId to get the transfers count")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IAccountTransfersCountResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IAccountTransfersCountResponse")),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/account.ts#L205"},"api/account.ts:205")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"transferslist"},"transfersList"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"transfersList"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"accountId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IAccountTransfersResponse"),">"),(0,r.kt)("p",null,"Returns paginated list of transfers for a specific account"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"accountId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"accountId to get transfers")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The page number")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IAccountTransfersResponse"),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/account.ts#L191"},"api/account.ts:191")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/787465aa.ded125f1.js b/assets/js/787465aa.ded125f1.js new file mode 100644 index 000000000..36b7c770f --- /dev/null +++ b/assets/js/787465aa.ded125f1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7673],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),d=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=d(e.components);return a.createElement(o.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),m=d(n),u=r,c=m["".concat(o,".").concat(u)]||m[u]||k[u]||i;return n?a.createElement(c,l(l({ref:t},s),{},{components:n})):a.createElement(c,l({ref:t},s))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p.mdxType="string"==typeof e?e:r,l[1]=p;for(var d=2;d{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,p={unversionedId:"sdk/reference/classes/AccountAPI",id:"sdk/reference/classes/AccountAPI",title:"AccountAPI",description:"@vocdoni/sdk / Exports / AccountAPI",source:"@site/docs/sdk/reference/classes/AccountAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/AccountAPI",permalink:"/sdk/reference/classes/AccountAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Account",permalink:"/sdk/reference/classes/Account"},next:{title:"AccountService",permalink:"/sdk/reference/classes/AccountService"}},o={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"count",id:"count",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"electionsList",id:"electionslist",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"info",id:"info",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"list",id:"list",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"metadata",id:"metadata",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"setInfo",id:"setinfo",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"transfersCount",id:"transferscount",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"transfersList",id:"transferslist",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4}],s={toc:d};function k(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / AccountAPI"),(0,r.kt)("h1",{id:"class-accountapi"},"Class: AccountAPI"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"API")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"AccountAPI"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountAPI#constructor"},"constructor"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountAPI#count"},"count")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountAPI#electionslist"},"electionsList")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountAPI#info"},"info")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountAPI#isapierror"},"isApiError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountAPI#isundefinederror"},"isUndefinedError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountAPI#list"},"list")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountAPI#metadata"},"metadata")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountAPI#setinfo"},"setInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountAPI#transferscount"},"transfersCount")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountAPI#transferslist"},"transfersList"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new AccountAPI"),"(): ",(0,r.kt)("a",{parentName:"p",href:"AccountAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountAPI"))),(0,r.kt)("p",null,"Cannot be constructed."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"AccountAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountAPI"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"API.constructor"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L109"},"api/account.ts:109")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"count"},"count"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"count"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IAccountsCountResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IAccountsCountResponse")),">"),(0,r.kt)("p",null,"Returns the number of accounts"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IAccountsCountResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IAccountsCountResponse")),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L133"},"api/account.ts:133")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electionslist"},"electionsList"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"electionsList"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"accountId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IElectionListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionListResponse")),">"),(0,r.kt)("p",null,"Returns paginated list of elections for a specific account"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"accountId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"accountId to get elections")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The page number")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IElectionListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L220"},"api/account.ts:220")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"info"},"info"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"info"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"accountId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IAccountInfoResponse"),">"),(0,r.kt)("p",null,"Fetches an Account information"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"accountId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The account we want the info from")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IAccountInfoResponse"),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L147"},"api/account.ts:147")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isapierror"},"isApiError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"API.isApiError"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L21"},"api/api.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"API.isUndefinedError"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L64"},"api/api.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"list"},"list"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"list"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IAccountsListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IAccountsListResponse")),">"),(0,r.kt)("p",null,"Returns paginated list of accounts"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The page number")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IAccountsListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IAccountsListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L120"},"api/account.ts:120")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"metadata"},"metadata"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"metadata"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"accountId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/AccountMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountMetadata")),">"),(0,r.kt)("p",null,"Fetches the account metadata"),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"accountId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The account we want the info from")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/AccountMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountMetadata")),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L161"},"api/account.ts:161")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setinfo"},"setInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"metadata"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IAccountSetInfoResponse"),">"),(0,r.kt)("p",null,"Sets Account information"),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The set information info raw payload to be submitted to the chain")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"metadata")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The base64 encoded metadata JSON object")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IAccountSetInfoResponse"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L176"},"api/account.ts:176")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"transferscount"},"transfersCount"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"transfersCount"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"accountId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IAccountTransfersCountResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IAccountTransfersCountResponse")),">"),(0,r.kt)("p",null,"Returns the account's transfers count"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"accountId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"accountId to get the transfers count")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IAccountTransfersCountResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IAccountTransfersCountResponse")),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L205"},"api/account.ts:205")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"transferslist"},"transfersList"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"transfersList"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"accountId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IAccountTransfersResponse"),">"),(0,r.kt)("p",null,"Returns paginated list of transfers for a specific account"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"accountId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"accountId to get transfers")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The page number")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IAccountTransfersResponse"),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L191"},"api/account.ts:191")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/78bbaf06.e45630f7.js b/assets/js/78bbaf06.e45630f7.js new file mode 100644 index 000000000..969eaa849 --- /dev/null +++ b/assets/js/78bbaf06.e45630f7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5995],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>h});var o=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function a(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=o.createContext({}),p=function(e){var t=o.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},c=function(e){var t=p(e.components);return o.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},u=o.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),u=p(n),h=r,f=u["".concat(s,".").concat(h)]||u[h]||d[h]||i;return n?o.createElement(f,a(a({ref:t},c),{},{components:n})):o.createElement(f,a({ref:t},c))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,a=new Array(i);a[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:r,a[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var o=n(87462),r=(n(67294),n(3905));const i={},a="Voting Types",l={unversionedId:"sdk/integration-details/voting-types/voting-types",id:"sdk/integration-details/voting-types/voting-types",title:"Voting Types",description:"In this section, we will provide a brief overview of the different types of voting supported by the Vocdoni protocol and",source:"@site/docs/sdk/integration-details/voting-types/voting-types.md",sourceDirName:"sdk/integration-details/voting-types",slug:"/sdk/integration-details/voting-types/",permalink:"/sdk/integration-details/voting-types/",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Vocdoni Tokens",permalink:"/sdk/integration-details/vocdoni-tokens"},next:{title:"Single Choice Voting",permalink:"/sdk/integration-details/voting-types/single-choice"}},s={},p=[{value:"Election types",id:"election-types",level:2},{value:"Results interpretation",id:"results-interpretation",level:2}],c={toc:p};function d(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,o.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"voting-types"},"Voting Types"),(0,r.kt)("p",null,"In this section, we will provide a brief overview of the different types of voting supported by the Vocdoni protocol and\nhow it operates."),(0,r.kt)("h2",{id:"election-types"},"Election types"),(0,r.kt)("p",null,"The ",(0,r.kt)("a",{parentName:"p",href:"/protocol/ballot-protocol"},"Vocdoni Ballot protocol")," in its current implementation accommodates multiple ",(0,r.kt)("strong",{parentName:"p"},"elections types"),":"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"voting-types/single-choice"},"Single choice"),", each voter is typically allowed to cast only one vote for their preferred option. This\nvoting system is the only one that ",(0,r.kt)("strong",{parentName:"li"},"supports multiple questions"),". "),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"voting-types/ranked"},"Ranked voting"),", also known as preferential voting, is an electoral system where voters rank candidates in order of preference"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"voting-types/approval"},"Approval voting"),", or multiple choice, here the voters are allowed to indicate their support for multiple\ncandidates or options."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"voting-types/weighted"},"Weighted voting"),", each voter is assigned a specific weight or value that reflects their relative influence or\nimportance in the decision-making process."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"voting-types/quadratic"},"Quadratic voting"),", voters can cast multiple votes for issues they prioritize, but the cost of casting\nadditional votes on the same issue rises exponentially.")),(0,r.kt)("p",null,"The configuration of these election types happens at the time of election creation using the SDK. Refer to the respective\ndocumentation for the parameter requirements for each election type."),(0,r.kt)("p",null,"A comprehensive explanation of the parameters used in the ballot protocol can be found ",(0,r.kt)("a",{parentName:"p",href:"/protocol/ballot-protocol"},"here"),"."),(0,r.kt)("h2",{id:"results-interpretation"},"Results interpretation"),(0,r.kt)("p",null,"The results are stored on the Vochain as a bi-dimensional array. Essentially, the ballot protocol is a system that\ntransforms a unidimensional array (a vote, e.g., ",(0,r.kt)("inlineCode",{parentName:"p"},"[1,4]"),") into a bi-dimensional array of results (e.g., ",(0,r.kt)("inlineCode",{parentName:"p"},"[[2,5]]"),")."),(0,r.kt)("p",null,"The interpretation of results is done on the user side, which receives the results from the SDK. The SDK provides\nmetadata about the election to facilitate understanding of the results. More details on interpreting results can be found ",(0,r.kt)("a",{parentName:"p",href:"/protocol/ballot-protocol#vocdoni-results-interpretation"},"here"),"."),(0,r.kt)("p",null,"Here's a simple example to demonstrate how the result array can be interpreted in different ways, depending on the\nelection type:"),(0,r.kt)("p",null,"Consider a question where 2 candidates are ranked by preference, which is an example of ",(0,r.kt)("inlineCode",{parentName:"p"},"ranked voting"),". The results\narray might look like this:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"[ \n [0, 0, 10], \n [0, 10, 0], \n [10, 0, 0] \n]\n")),(0,r.kt)("p",null,"In this scenario:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"10 voters select the first candidate as third option"),(0,r.kt)("li",{parentName:"ul"},"10 voters select the second candidate as second option"),(0,r.kt)("li",{parentName:"ul"},"10 voters select the third candidate as first option")),(0,r.kt)("p",null,'Now, let\'s examine another election type that can produce the same results array. For a question like "choose your 3\nfavorite colors out of 2", which is an example of ',(0,r.kt)("inlineCode",{parentName:"p"},"approval voting"),", the results array may look like that:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"[ \n [10, 0], \n [0, 10], \n [0, 10] \n]\n")),(0,r.kt)("p",null,"On this case, the results interpretation may vary:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"10 users give 0 points to first option"),(0,r.kt)("li",{parentName:"ul"},"10 users give 1 point to second and third options")),(0,r.kt)("p",null,"The examples above represent two methods for interpreting the results array. Additional examples are available for\ndifferent voting type result interpretations."),(0,r.kt)("admonition",{title:"Weighted results are calculated on the indexer",type:"note"},(0,r.kt)("p",{parentName:"admonition"},"In a weighted election, the Vochain stores the envelope without calculating the weight of each voter. However, when\nretrieving the results using the SDK, you will see the weights applied. The application of these weights is performed\nby the vocdoni-node indexer, which calculates the weights for you."),(0,r.kt)("p",{parentName:"admonition"},"The weights of each vote are stored in the envelope, which is saved on the Vochain.")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7acd0d27.0575f54a.js b/assets/js/7acd0d27.0575f54a.js deleted file mode 100644 index 32a682999..000000000 --- a/assets/js/7acd0d27.0575f54a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[522],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>k});var i=t(67294);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function s(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function a(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var o=i.createContext({}),d=function(e){var n=i.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},c=function(e){var n=d(e.components);return i.createElement(o.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},p=i.forwardRef((function(e,n){var t=e.components,r=e.mdxType,s=e.originalType,o=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),p=d(t),k=r,f=p["".concat(o,".").concat(k)]||p[k]||u[k]||s;return t?i.createElement(f,a(a({ref:n},c),{},{components:t})):i.createElement(f,a({ref:n},c))}));function k(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var s=t.length,a=new Array(s);a[0]=p;var l={};for(var o in n)hasOwnProperty.call(n,o)&&(l[o]=n[o]);l.originalType=e,l.mdxType="string"==typeof e?e:r,a[1]=l;for(var d=2;d{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var i=t(87462),r=(t(67294),t(3905));const s={},a=void 0,l={unversionedId:"sdk/reference/interfaces/CircuitInputs",id:"sdk/reference/interfaces/CircuitInputs",title:"CircuitInputs",description:"@vocdoni/sdk / Exports / CircuitInputs",source:"@site/docs/sdk/reference/interfaces/CircuitInputs.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/CircuitInputs",permalink:"/sdk/reference/interfaces/CircuitInputs",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"AdminTx",permalink:"/sdk/reference/interfaces/AdminTx"},next:{title:"CollectFaucetTx",permalink:"/sdk/reference/interfaces/CollectFaucetTx"}},o={},d=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"address",id:"address",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"availableWeight",id:"availableweight",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"censusRoot",id:"censusroot",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"censusSiblings",id:"censussiblings",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"electionId",id:"electionid",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"nullifier",id:"nullifier",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"password",id:"password",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"signature",id:"signature",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"sikRoot",id:"sikroot",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"sikSiblings",id:"siksiblings",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"voteHash",id:"votehash",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"voteWeight",id:"voteweight",level:3},{value:"Defined in",id:"defined-in-11",level:4}],c={toc:d};function u(e){let{components:n,...t}=e;return(0,r.kt)("wrapper",(0,i.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / CircuitInputs"),(0,r.kt)("h1",{id:"interface-circuitinputs"},"Interface: CircuitInputs"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CircuitInputs#address"},"address")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CircuitInputs#availableweight"},"availableWeight")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CircuitInputs#censusroot"},"censusRoot")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CircuitInputs#censussiblings"},"censusSiblings")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CircuitInputs#electionid"},"electionId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CircuitInputs#nullifier"},"nullifier")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CircuitInputs#password"},"password")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CircuitInputs#signature"},"signature")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CircuitInputs#sikroot"},"sikRoot")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CircuitInputs#siksiblings"},"sikSiblings")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CircuitInputs#votehash"},"voteHash")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CircuitInputs#voteweight"},"voteWeight"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"address"},"address"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"address"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L43"},"services/anonymous.ts:43")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"availableweight"},"availableWeight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"availableWeight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L38"},"services/anonymous.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censusroot"},"censusRoot"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"censusRoot"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L41"},"services/anonymous.ts:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censussiblings"},"censusSiblings"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"censusSiblings"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L48"},"services/anonymous.ts:48")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electionid"},"electionId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"electionId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L36"},"services/anonymous.ts:36")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"nullifier"},"nullifier"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"nullifier"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L37"},"services/anonymous.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"password"},"password"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"password"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L44"},"services/anonymous.ts:44")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"signature"},"signature"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"signature"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L45"},"services/anonymous.ts:45")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sikroot"},"sikRoot"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"sikRoot"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L40"},"services/anonymous.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"siksiblings"},"sikSiblings"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"sikSiblings"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L47"},"services/anonymous.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"votehash"},"voteHash"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"voteHash"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L39"},"services/anonymous.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"voteweight"},"voteWeight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"voteWeight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L46"},"services/anonymous.ts:46")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7acd0d27.9ba2adda.js b/assets/js/7acd0d27.9ba2adda.js new file mode 100644 index 000000000..e62197eac --- /dev/null +++ b/assets/js/7acd0d27.9ba2adda.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[522],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>k});var i=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function s(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function a(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=i.createContext({}),d=function(e){var t=i.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},u=function(e){var t=d(e.components);return i.createElement(o.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},c=i.forwardRef((function(e,t){var n=e.components,r=e.mdxType,s=e.originalType,o=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),c=d(n),k=r,f=c["".concat(o,".").concat(k)]||c[k]||p[k]||s;return n?i.createElement(f,a(a({ref:t},u),{},{components:n})):i.createElement(f,a({ref:t},u))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var s=n.length,a=new Array(s);a[0]=c;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l.mdxType="string"==typeof e?e:r,a[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>a,default:()=>p,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var i=n(87462),r=(n(67294),n(3905));const s={},a=void 0,l={unversionedId:"sdk/reference/interfaces/CircuitInputs",id:"sdk/reference/interfaces/CircuitInputs",title:"CircuitInputs",description:"@vocdoni/sdk / Exports / CircuitInputs",source:"@site/docs/sdk/reference/interfaces/CircuitInputs.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/CircuitInputs",permalink:"/sdk/reference/interfaces/CircuitInputs",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"AdminTx",permalink:"/sdk/reference/interfaces/AdminTx"},next:{title:"CollectFaucetTx",permalink:"/sdk/reference/interfaces/CollectFaucetTx"}},o={},d=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"address",id:"address",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"availableWeight",id:"availableweight",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"censusRoot",id:"censusroot",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"censusSiblings",id:"censussiblings",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"electionId",id:"electionid",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"nullifier",id:"nullifier",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"password",id:"password",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"signature",id:"signature",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"sikRoot",id:"sikroot",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"sikSiblings",id:"siksiblings",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"voteHash",id:"votehash",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"voteWeight",id:"voteweight",level:3},{value:"Defined in",id:"defined-in-11",level:4}],u={toc:d};function p(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,i.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / CircuitInputs"),(0,r.kt)("h1",{id:"interface-circuitinputs"},"Interface: CircuitInputs"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CircuitInputs#address"},"address")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CircuitInputs#availableweight"},"availableWeight")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CircuitInputs#censusroot"},"censusRoot")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CircuitInputs#censussiblings"},"censusSiblings")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CircuitInputs#electionid"},"electionId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CircuitInputs#nullifier"},"nullifier")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CircuitInputs#password"},"password")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CircuitInputs#signature"},"signature")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CircuitInputs#sikroot"},"sikRoot")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CircuitInputs#siksiblings"},"sikSiblings")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CircuitInputs#votehash"},"voteHash")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CircuitInputs#voteweight"},"voteWeight"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"address"},"address"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"address"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L43"},"services/anonymous.ts:43")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"availableweight"},"availableWeight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"availableWeight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L38"},"services/anonymous.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censusroot"},"censusRoot"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"censusRoot"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L41"},"services/anonymous.ts:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censussiblings"},"censusSiblings"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"censusSiblings"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L48"},"services/anonymous.ts:48")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electionid"},"electionId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"electionId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L36"},"services/anonymous.ts:36")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"nullifier"},"nullifier"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"nullifier"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L37"},"services/anonymous.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"password"},"password"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"password"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L44"},"services/anonymous.ts:44")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"signature"},"signature"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"signature"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L45"},"services/anonymous.ts:45")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sikroot"},"sikRoot"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"sikRoot"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L40"},"services/anonymous.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"siksiblings"},"sikSiblings"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"sikSiblings"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L47"},"services/anonymous.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"votehash"},"voteHash"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"voteHash"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L39"},"services/anonymous.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"voteweight"},"voteWeight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"voteWeight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L46"},"services/anonymous.ts:46")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7c0d6738.5067fba9.js b/assets/js/7c0d6738.5067fba9.js deleted file mode 100644 index 5d5d83adc..000000000 --- a/assets/js/7c0d6738.5067fba9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1573],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>u});var n=a(67294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},o=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),m=d(a),u=r,N=m["".concat(p,".").concat(u)]||m[u]||k[u]||i;return a?n.createElement(N,l(l({ref:t},o),{},{components:a})):n.createElement(N,l({ref:t},o))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=m;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s.mdxType="string"==typeof e?e:r,l[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var n=a(87462),r=(a(67294),a(3905));const i={},l=void 0,s={unversionedId:"sdk/reference/classes/Census3StrategyAPI",id:"sdk/reference/classes/Census3StrategyAPI",title:"Census3StrategyAPI",description:"@vocdoni/sdk / Exports / Census3StrategyAPI",source:"@site/docs/sdk/reference/classes/Census3StrategyAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Census3StrategyAPI",permalink:"/sdk/reference/classes/Census3StrategyAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Census3ServiceAPI",permalink:"/sdk/reference/classes/Census3ServiceAPI"},next:{title:"Census3TokenAPI",permalink:"/sdk/reference/classes/Census3TokenAPI"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"estimation",id:"estimation",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"estimationQueue",id:"estimationqueue",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"holders",id:"holders",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"import",id:"import",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"importQueue",id:"importqueue",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"list",id:"list",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"listByToken",id:"listbytoken",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"operators",id:"operators",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"serializePagination",id:"serializepagination",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"strategy",id:"strategy",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"validatePredicate",id:"validatepredicate",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-14",level:4}],o={toc:d};function k(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / Census3StrategyAPI"),(0,r.kt)("h1",{id:"class-census3strategyapi"},"Class: Census3StrategyAPI"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"Census3API")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Census3StrategyAPI"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3StrategyAPI#constructor"},"constructor"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3StrategyAPI#create"},"create")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3StrategyAPI#estimation"},"estimation")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3StrategyAPI#estimationqueue"},"estimationQueue")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3StrategyAPI#holders"},"holders")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3StrategyAPI#import"},"import")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3StrategyAPI#importqueue"},"importQueue")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3StrategyAPI#isapierror"},"isApiError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3StrategyAPI#isundefinederror"},"isUndefinedError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3StrategyAPI#list"},"list")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3StrategyAPI#listbytoken"},"listByToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3StrategyAPI#operators"},"operators")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3StrategyAPI#serializepagination"},"serializePagination")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3StrategyAPI#strategy"},"strategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3StrategyAPI#validatepredicate"},"validatePredicate"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new Census3StrategyAPI"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census3StrategyAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3StrategyAPI"))),(0,r.kt)("p",null,"Cannot be constructed."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census3StrategyAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3StrategyAPI"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"Census3API.constructor"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L254"},"api/census3/strategy.ts:254")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"create"},"create"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"create"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"alias"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"predicate"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"tokens"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategyCreateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyCreateResponse")),">"),(0,r.kt)("p",null,"Creates a new strategy based on the given token strategies and predicate."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"alias")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The alias of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"predicate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The predicate of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokens")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The token list for the strategy")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategyCreateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyCreateResponse")),">"),(0,r.kt)("p",null,"The identifier of the created strategy"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L412"},"api/census3/strategy.ts:412")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"estimation"},"estimation"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"estimation"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensus3QueueResponse"),">"),(0,r.kt)("p",null,"Returns the estimation of size and time (in milliseconds) to create the census generated for the provided strategy"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the estimation should be done for anonymous census")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensus3QueueResponse"),">"),(0,r.kt)("p",null,"The queue identifier"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L342"},"api/census3/strategy.ts:342")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"estimationqueue"},"estimationQueue"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"estimationQueue"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"strategyId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"queueId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyEstimationQueueResponse")),">"),(0,r.kt)("p",null,"Returns the information of the strategy estimation queue"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"strategyId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"queueId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the strategy estimation queue")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyEstimationQueueResponse")),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L359"},"api/census3/strategy.ts:359")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"holders"},"holders"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"holders"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pagination?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyHoldersResponsePaginated")),">"),(0,r.kt)("p",null,"Fetches list of holders by strategy"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pagination?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Census3Pagination")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Pagination options")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyHoldersResponsePaginated")),">"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L282"},"api/census3/strategy.ts:282")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"import"},"import"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"import"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"cid"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensus3QueueResponse"),">"),(0,r.kt)("p",null,"Imports a strategy from IPFS from the given cid."),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"cid")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The cid of the IPFS where the strategy is stored")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensus3QueueResponse"),">"),(0,r.kt)("p",null,"The queue identifier"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L396"},"api/census3/strategy.ts:396")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"importqueue"},"importQueue"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"importQueue"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"queueId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyImportQueueResponse")),">"),(0,r.kt)("p",null,"Returns the information of the strategy import queue"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"queueId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the strategy import queue")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyImportQueueResponse")),">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L380"},"api/census3/strategy.ts:380")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isapierror"},"isApiError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"Census3API.isApiError"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/api.ts#L101"},"api/census3/api.ts:101")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"Census3API.isUndefinedError"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L64"},"api/api.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"list"},"list"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"list"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pagination?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesListResponsePaginated")),">"),(0,r.kt)("p",null,"Fetches list of strategies"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pagination?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Census3Pagination")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Pagination options")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesListResponsePaginated")),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L265"},"api/census3/strategy.ts:265")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"listbytoken"},"listByToken"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"listByToken"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"tokenId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategiesListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesListResponse")),">"),(0,r.kt)("p",null,"Fetches list of strategies based on given token"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokenId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chain identifier of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategiesListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L304"},"api/census3/strategy.ts:304")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"operators"},"operators"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"operators"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesOperatorsResponse")),">"),(0,r.kt)("p",null,"Returns the list of supported operators to build strategy predicates."),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesOperatorsResponse")),">"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L444"},"api/census3/strategy.ts:444")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"serializepagination"},"serializePagination"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"serializePagination"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"pagination?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pagination?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Census3Pagination"))))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,"Census3API.serializePagination"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/api.ts#L92"},"api/census3/api.ts:92")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"strategy"},"strategy"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"strategy"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),">"),(0,r.kt)("p",null,"Returns the information of the strategy"),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the strategy")))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),">"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L327"},"api/census3/strategy.ts:327")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"validatepredicate"},"validatePredicate"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"validatePredicate"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"predicate"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3ValidatePredicateResponse")),">"),(0,r.kt)("p",null,"Validates a predicate."),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"predicate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The predicate of the strategy")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3ValidatePredicateResponse")),">"),(0,r.kt)("p",null,"Parsed version of the predicate"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L431"},"api/census3/strategy.ts:431")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7c0d6738.83678e9b.js b/assets/js/7c0d6738.83678e9b.js new file mode 100644 index 000000000..37e429239 --- /dev/null +++ b/assets/js/7c0d6738.83678e9b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1573],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>u});var n=a(67294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),d=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},o=function(e){var t=d(e.components);return n.createElement(s.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,o=p(e,["components","mdxType","originalType","parentName"]),k=d(a),u=r,N=k["".concat(s,".").concat(u)]||k[u]||m[u]||i;return a?n.createElement(N,l(l({ref:t},o),{},{components:a})):n.createElement(N,l({ref:t},o))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=k;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p.mdxType="string"==typeof e?e:r,l[1]=p;for(var d=2;d{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var n=a(87462),r=(a(67294),a(3905));const i={},l=void 0,p={unversionedId:"sdk/reference/classes/Census3StrategyAPI",id:"sdk/reference/classes/Census3StrategyAPI",title:"Census3StrategyAPI",description:"@vocdoni/sdk / Exports / Census3StrategyAPI",source:"@site/docs/sdk/reference/classes/Census3StrategyAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Census3StrategyAPI",permalink:"/sdk/reference/classes/Census3StrategyAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Census3ServiceAPI",permalink:"/sdk/reference/classes/Census3ServiceAPI"},next:{title:"Census3TokenAPI",permalink:"/sdk/reference/classes/Census3TokenAPI"}},s={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"estimation",id:"estimation",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"estimationQueue",id:"estimationqueue",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"holders",id:"holders",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"import",id:"import",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"importQueue",id:"importqueue",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"list",id:"list",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"listByToken",id:"listbytoken",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"operators",id:"operators",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"serializePagination",id:"serializepagination",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"strategy",id:"strategy",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"validatePredicate",id:"validatepredicate",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-14",level:4}],o={toc:d};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / Census3StrategyAPI"),(0,r.kt)("h1",{id:"class-census3strategyapi"},"Class: Census3StrategyAPI"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"Census3API")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Census3StrategyAPI"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3StrategyAPI#constructor"},"constructor"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3StrategyAPI#create"},"create")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3StrategyAPI#estimation"},"estimation")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3StrategyAPI#estimationqueue"},"estimationQueue")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3StrategyAPI#holders"},"holders")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3StrategyAPI#import"},"import")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3StrategyAPI#importqueue"},"importQueue")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3StrategyAPI#isapierror"},"isApiError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3StrategyAPI#isundefinederror"},"isUndefinedError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3StrategyAPI#list"},"list")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3StrategyAPI#listbytoken"},"listByToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3StrategyAPI#operators"},"operators")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3StrategyAPI#serializepagination"},"serializePagination")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3StrategyAPI#strategy"},"strategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3StrategyAPI#validatepredicate"},"validatePredicate"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new Census3StrategyAPI"),"(): ",(0,r.kt)("a",{parentName:"p",href:"Census3StrategyAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3StrategyAPI"))),(0,r.kt)("p",null,"Cannot be constructed."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"Census3StrategyAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3StrategyAPI"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"Census3API.constructor"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L254"},"api/census3/strategy.ts:254")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"create"},"create"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"create"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"alias"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"predicate"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"tokens"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3StrategyCreateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyCreateResponse")),">"),(0,r.kt)("p",null,"Creates a new strategy based on the given token strategies and predicate."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"alias")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The alias of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"predicate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The predicate of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokens")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The token list for the strategy")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3StrategyCreateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyCreateResponse")),">"),(0,r.kt)("p",null,"The identifier of the created strategy"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L412"},"api/census3/strategy.ts:412")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"estimation"},"estimation"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"estimation"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensus3QueueResponse"),">"),(0,r.kt)("p",null,"Returns the estimation of size and time (in milliseconds) to create the census generated for the provided strategy"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the estimation should be done for anonymous census")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensus3QueueResponse"),">"),(0,r.kt)("p",null,"The queue identifier"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L342"},"api/census3/strategy.ts:342")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"estimationqueue"},"estimationQueue"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"estimationQueue"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"strategyId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"queueId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3StrategyEstimationQueueResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyEstimationQueueResponse")),">"),(0,r.kt)("p",null,"Returns the information of the strategy estimation queue"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"strategyId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"queueId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the strategy estimation queue")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3StrategyEstimationQueueResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyEstimationQueueResponse")),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L359"},"api/census3/strategy.ts:359")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"holders"},"holders"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"holders"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pagination?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3StrategyHoldersResponsePaginated"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyHoldersResponsePaginated")),">"),(0,r.kt)("p",null,"Fetches list of holders by strategy"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pagination?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Census3Pagination")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Pagination options")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3StrategyHoldersResponsePaginated"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyHoldersResponsePaginated")),">"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L282"},"api/census3/strategy.ts:282")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"import"},"import"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"import"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"cid"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensus3QueueResponse"),">"),(0,r.kt)("p",null,"Imports a strategy from IPFS from the given cid."),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"cid")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The cid of the IPFS where the strategy is stored")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensus3QueueResponse"),">"),(0,r.kt)("p",null,"The queue identifier"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L396"},"api/census3/strategy.ts:396")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"importqueue"},"importQueue"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"importQueue"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"queueId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3StrategyImportQueueResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyImportQueueResponse")),">"),(0,r.kt)("p",null,"Returns the information of the strategy import queue"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"queueId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the strategy import queue")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3StrategyImportQueueResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategyImportQueueResponse")),">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L380"},"api/census3/strategy.ts:380")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isapierror"},"isApiError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"Census3API.isApiError"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/api.ts#L101"},"api/census3/api.ts:101")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"Census3API.isUndefinedError"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L64"},"api/api.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"list"},"list"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"list"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pagination?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3StrategiesListResponsePaginated"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesListResponsePaginated")),">"),(0,r.kt)("p",null,"Fetches list of strategies"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pagination?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Census3Pagination")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Pagination options")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3StrategiesListResponsePaginated"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesListResponsePaginated")),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L265"},"api/census3/strategy.ts:265")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"listbytoken"},"listByToken"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"listByToken"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"tokenId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3StrategiesListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesListResponse")),">"),(0,r.kt)("p",null,"Fetches list of strategies based on given token"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokenId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chain identifier of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3StrategiesListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L304"},"api/census3/strategy.ts:304")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"operators"},"operators"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"operators"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3StrategiesOperatorsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesOperatorsResponse")),">"),(0,r.kt)("p",null,"Returns the list of supported operators to build strategy predicates."),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3StrategiesOperatorsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesOperatorsResponse")),">"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L444"},"api/census3/strategy.ts:444")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"serializepagination"},"serializePagination"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"serializePagination"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"pagination?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pagination?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Census3Pagination"))))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,"Census3API.serializePagination"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/api.ts#L92"},"api/census3/api.ts:92")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"strategy"},"strategy"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"strategy"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),">"),(0,r.kt)("p",null,"Returns the information of the strategy"),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the strategy")))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),">"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L327"},"api/census3/strategy.ts:327")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"validatepredicate"},"validatePredicate"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"validatePredicate"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"predicate"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3ValidatePredicateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3ValidatePredicateResponse")),">"),(0,r.kt)("p",null,"Validates a predicate."),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"predicate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The predicate of the strategy")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3ValidatePredicateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3ValidatePredicateResponse")),">"),(0,r.kt)("p",null,"Parsed version of the predicate"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L431"},"api/census3/strategy.ts:431")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/835897f5.2560cb82.js b/assets/js/835897f5.2560cb82.js new file mode 100644 index 000000000..26d432247 --- /dev/null +++ b/assets/js/835897f5.2560cb82.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3227],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>h});var o=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function r(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=o.createContext({}),p=function(e){var t=o.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},c=function(e){var t=p(e.components);return o.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},u=o.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),u=p(n),h=i,m=u["".concat(s,".").concat(h)]||u[h]||d[h]||a;return n?o.createElement(m,r(r({ref:t},c),{},{components:n})):o.createElement(m,r({ref:t},c))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,r=new Array(a);r[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:i,r[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>r,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>p});var o=n(87462),i=(n(67294),n(3905));const a={sidebar_position:3,slug:"ranked"},r="Ranked Voting",l={unversionedId:"sdk/integration-details/voting-types/ranked",id:"sdk/integration-details/voting-types/ranked",title:"Ranked Voting",description:"Ranked voting, also known as preferential voting or ranked-choice voting (RCV), is an electoral system where voters rank",source:"@site/docs/sdk/integration-details/voting-types/ranked.md",sourceDirName:"sdk/integration-details/voting-types",slug:"/sdk/integration-details/voting-types/ranked",permalink:"/sdk/integration-details/voting-types/ranked",draft:!1,tags:[],version:"current",sidebarPosition:3,frontMatter:{sidebar_position:3,slug:"ranked"},sidebar:"defaultSidebar",previous:{title:"Single Choice Voting",permalink:"/sdk/integration-details/voting-types/single-choice"},next:{title:"Approval Voting (Multiple Choice)",permalink:"/sdk/integration-details/voting-types/approval"}},s={},p=[{value:"Setting up the election",id:"setting-up-the-election",level:2},{value:"Casting a vote",id:"casting-a-vote",level:2},{value:"Results interpretation",id:"results-interpretation",level:2}],c={toc:p};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,o.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"ranked-voting"},"Ranked Voting"),(0,i.kt)("p",null,"Ranked voting, also known as preferential voting or ranked-choice voting (RCV), is an electoral system where voters rank\ncandidates in order of preference on the ballot. This system allows voters to express not only their first-choice\ncandidate but also their second, third, and subsequent choices. In the counting process, candidates with the fewest\nvotes are eliminated, and their supporters' votes are redistributed to the remaining candidates based on the next-ranked\nchoices. This process continues until one candidate receives a majority of the votes, ensuring that the winner has the\nbroadest support among the electorate."),(0,i.kt)("p",null,"Ranked voting aims to provide a more inclusive and representative outcome, mitigate vote splitting and strategic voting,\nand encourage candidates to appeal to a wider range of voters."),(0,i.kt)("p",null,"For example: Sort your 5 favorite blockchains: Bitcoin, Ethereum, Monero, Zcash, Polkadot."),(0,i.kt)("p",null,"See:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/examples/typescript/src/ranked.ts"},"Complete example")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/protocol/ballot-protocol#linear-weighted-choice"},"Ballot protocol implementation"))),(0,i.kt)("h2",{id:"setting-up-the-election"},"Setting up the election"),(0,i.kt)("p",null,"The configuration of the vote type for the election should be set as follows:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"const election_opts: IVoteType = {\n uniqueChoices: true, \n costFromWeight: false,\n maxCount: 5, // Represents the number of choices for the given question.\n maxValue: 4, // Maximum value for a single choice. If voters can rate options on a scale of 0 to 3, then `MAX_VALUE` should be set to `4`.\n maxTotalCost: 0,\n}\n")),(0,i.kt)("p",null,'This configuration could, for example, allow voters to rank their top 5 preferred blockchains: "Bitcoin:0, Ethereum:1, Monero:2, Zcash:3, Polkadot:4"'),(0,i.kt)("admonition",{title:"Multiple questions not supported",type:"danger"},(0,i.kt)("p",{parentName:"admonition"},(0,i.kt)("strong",{parentName:"p"},"This election type not support multiple questions"),": the current Vocdoni implementation restricts this kind of elections to a single question. To create an election with multiple questions check ",(0,i.kt)("a",{parentName:"p",href:"/protocol/ballot-protocol#multiquestion"},"multi question election"))),(0,i.kt)("h2",{id:"casting-a-vote"},"Casting a vote"),(0,i.kt)("p",null,"A vote can be cast using the method below:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"client.submitVote(new Vote([2, 3, 0, 1, 4]));\n")),(0,i.kt)("p",null,"Each entry in the array corresponds to a choice in the election, and the value assigned to each entry represents the\nvoter's rating for that choice. The length of this array should match the total number of choices in the election\n(",(0,i.kt)("inlineCode",{parentName:"p"},"maxCount"),"), and the value assigned to each entry should not exceed ",(0,i.kt)("inlineCode",{parentName:"p"},"maxValue"),"."),(0,i.kt)("p",null,"With the vote array ",(0,i.kt)("inlineCode",{parentName:"p"},"[2, 3, 0, 1, 4]"),", it means:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"1")," is ranked as the ",(0,i.kt)("inlineCode",{parentName:"li"},"3nd")," option"),(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"2")," is ranked as the ",(0,i.kt)("inlineCode",{parentName:"li"},"4rd")," option"),(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"3")," is ranked as the ",(0,i.kt)("inlineCode",{parentName:"li"},"1st")," option"),(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"4")," is ranked as the ",(0,i.kt)("inlineCode",{parentName:"li"},"2nd")," option"),(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"5")," is ranked as the ",(0,i.kt)("inlineCode",{parentName:"li"},"5th")," option")),(0,i.kt)("h2",{id:"results-interpretation"},"Results interpretation"),(0,i.kt)("p",null,"Consider a scenario where 10 voters cast identical votes, i.e., ",(0,i.kt)("inlineCode",{parentName:"p"},"[2, 3, 0, 1, 4]"),"."),(0,i.kt)("p",null,"The election results would be represented as a two-dimensional array:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre"}," [\n [ '0', '0', '10', '0', '0' ],\n [ '0', '0', '0', '10', '0' ],\n [ '10', '0', '0', '0', '0' ],\n [ '0', '10', '0', '0', '0' ],\n [ '0', '0', '0', '0', '10' ]\n ]\n")),(0,i.kt)("p",null,'Each position in the outer array corresponds to the available choices, as in the previous example: "Bitcoin:0,\nEthereum:1, Monero:2, Zcash:3, Polkadot:4".'),(0,i.kt)("p",null,"Every position within the inner arrays indicates how many voters selected the corresponding choice for a specific\nranking:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"0")," (Bitcoin) was selected as the ",(0,i.kt)("inlineCode",{parentName:"li"},"2nd")," option by all 10 voters"),(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"1")," (Ethereum) was selected as the ",(0,i.kt)("inlineCode",{parentName:"li"},"3rd")," option by all 10 voters"),(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"2")," (Monero) was selected as the ",(0,i.kt)("inlineCode",{parentName:"li"},"1st")," option by all 10 voters"),(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"3")," (Zcash) was selected as the ",(0,i.kt)("inlineCode",{parentName:"li"},"2nd")," option by all 10 voters"),(0,i.kt)("li",{parentName:"ul"},"Choice ",(0,i.kt)("inlineCode",{parentName:"li"},"4")," (Polkadot) was selected as the ",(0,i.kt)("inlineCode",{parentName:"li"},"5th")," option by all 10 voters")),(0,i.kt)("p",null,"Remember, this interpretation assumes that all voters have used the same voting pattern."))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/87d0da39.5b85a01a.js b/assets/js/87d0da39.5b85a01a.js deleted file mode 100644 index a4e2b65fd..000000000 --- a/assets/js/87d0da39.5b85a01a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1719],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>c});var n=a(67294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),s=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},o=function(e){var t=s(e.components);return n.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),m=s(a),c=r,u=m["".concat(p,".").concat(c)]||m[c]||k[c]||i;return a?n.createElement(u,l(l({ref:t},o),{},{components:a})):n.createElement(u,l({ref:t},o))}));function c(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=m;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var s=2;s{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>d,toc:()=>s});var n=a(87462),r=(a(67294),a(3905));const i={},l=void 0,d={unversionedId:"sdk/reference/modules",id:"sdk/reference/modules",title:"modules",description:"@vocdoni/sdk / Exports",source:"@site/docs/sdk/reference/modules.md",sourceDirName:"sdk/reference",slug:"/sdk/reference/modules",permalink:"/sdk/reference/modules",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"VoteEnvelope",permalink:"/sdk/reference/interfaces/VoteEnvelope"},next:{title:"SDK Tutorial",permalink:"/sdk/tutorial"}},p={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Classes",id:"classes",level:3},{value:"Interfaces",id:"interfaces",level:3},{value:"Type Aliases",id:"type-aliases",level:3},{value:"Variables",id:"variables",level:3},{value:"Functions",id:"functions",level:3},{value:"Type Aliases",id:"type-aliases-1",level:2},{value:"AccountData",id:"accountdata",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"AllElectionStatus",id:"allelectionstatus",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ArchivedAccountData",id:"archivedaccountdata",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Census3Census",id:"census3census",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Census3CreateStrategyToken",id:"census3createstrategytoken",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Census3Strategy",id:"census3strategy",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Census3StrategyToken",id:"census3strategytoken",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Census3SummaryToken",id:"census3summarytoken",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"Census3Token",id:"census3token",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"CensusImportExport",id:"censusimportexport",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"CensusProof",id:"censusproof",level:3},{value:"Type declaration",id:"type-declaration-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"ChainCircuits",id:"chaincircuits",level:3},{value:"Type declaration",id:"type-declaration-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"ChainCosts",id:"chaincosts",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"ChainData",id:"chaindata",level:3},{value:"Type declaration",id:"type-declaration-7",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"ChainTx",id:"chaintx",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"ClientOptions",id:"clientoptions",level:3},{value:"Type declaration",id:"type-declaration-8",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"CspCensusProof",id:"cspcensusproof",level:3},{value:"Type declaration",id:"type-declaration-9",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"ElectionCreatedInformation",id:"electioncreatedinformation",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"ElectionCreationStepValue",id:"electioncreationstepvalue",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"ElectionIdOption",id:"electionidoption",level:3},{value:"Type declaration",id:"type-declaration-10",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"ElectionKeys",id:"electionkeys",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"ElectionMeta",id:"electionmeta",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"ElectionResultsType",id:"electionresultstype",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"FaucetOptions",id:"faucetoptions",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"FaucetPackage",id:"faucetpackage",level:3},{value:"Type declaration",id:"type-declaration-11",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"HasAlreadyVotedOptions",id:"hasalreadyvotedoptions",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"IAccountSummary",id:"iaccountsummary",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"IBudgetElectionParameters",id:"ibudgetelectionparameters",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"IsAbleToVoteOptions",id:"isabletovoteoptions",level:3},{value:"Defined in",id:"defined-in-28",level:4},{value:"IsInCensusOptions",id:"isincensusoptions",level:3},{value:"Defined in",id:"defined-in-29",level:4},{value:"ParsedPredicate",id:"parsedpredicate",level:3},{value:"Defined in",id:"defined-in-30",level:4},{value:"SendTokensOptions",id:"sendtokensoptions",level:3},{value:"Defined in",id:"defined-in-31",level:4},{value:"Strategy",id:"strategy",level:3},{value:"Defined in",id:"defined-in-32",level:4},{value:"StrategyHolder",id:"strategyholder",level:3},{value:"Type declaration",id:"type-declaration-12",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"StrategyHolders",id:"strategyholders",level:3},{value:"Type declaration",id:"type-declaration-13",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"StrategyToken",id:"strategytoken",level:3},{value:"Defined in",id:"defined-in-35",level:4},{value:"SupportedChain",id:"supportedchain",level:3},{value:"Defined in",id:"defined-in-36",level:4},{value:"SupportedOperator",id:"supportedoperator",level:3},{value:"Defined in",id:"defined-in-37",level:4},{value:"Token",id:"token",level:3},{value:"Defined in",id:"defined-in-38",level:4},{value:"TokenSummary",id:"tokensummary",level:3},{value:"Defined in",id:"defined-in-39",level:4},{value:"TxWaitOptions",id:"txwaitoptions",level:3},{value:"Type declaration",id:"type-declaration-14",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"VoteIdOption",id:"voteidoption",level:3},{value:"Type declaration",id:"type-declaration-15",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"VoteInfo",id:"voteinfo",level:3},{value:"Defined in",id:"defined-in-42",level:4},{value:"VoteStepValue",id:"votestepvalue",level:3},{value:"Defined in",id:"defined-in-43",level:4},{value:"VoteSubmit",id:"votesubmit",level:3},{value:"Defined in",id:"defined-in-44",level:4},{value:"VotesLeftCountOptions",id:"votesleftcountoptions",level:3},{value:"Defined in",id:"defined-in-45",level:4},{value:"WalletOption",id:"walletoption",level:3},{value:"Type declaration",id:"type-declaration-16",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"ZkProof",id:"zkproof",level:3},{value:"Type declaration",id:"type-declaration-17",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"Variables",id:"variables-1",level:2},{value:"AccountMetadataTemplate",id:"accountmetadatatemplate",level:3},{value:"Defined in",id:"defined-in-48",level:4},{value:"ElectionMetadataTemplate",id:"electionmetadatatemplate",level:3},{value:"Defined in",id:"defined-in-49",level:4},{value:"Functions",id:"functions-1",level:2},{value:"areEqualHexStrings",id:"areequalhexstrings",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"checkValidAccountMetadata",id:"checkvalidaccountmetadata",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"checkValidElectionMetadata",id:"checkvalidelectionmetadata",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"delay",id:"delay",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"dotobject",id:"dotobject",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"ensure0x",id:"ensure0x",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"formatUnits",id:"formatunits",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"getBytes",id:"getbytes",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"getHex",id:"gethex",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"strip0x",id:"strip0x",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-59",level:4}],o={toc:s};function k(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / Exports"),(0,r.kt)("h1",{id:"vocdonisdk"},"@vocdoni/sdk"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"enumerations"},"Enumerations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusOrigin"},"CensusOrigin")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusType"},"CensusType")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusTypeEnum"},"CensusTypeEnum")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CspProofType"},"CspProofType")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionCreationSteps"},"ElectionCreationSteps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionResultsTypeNames"},"ElectionResultsTypeNames")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionStatus"},"ElectionStatus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionStatusReady"},"ElectionStatusReady")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/EnvOptions"},"EnvOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TransactionType"},"TransactionType")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/TxType"},"TxType")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/VoteSteps"},"VoteSteps"))),(0,r.kt)("h3",{id:"classes"},"Classes"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Account"},"Account")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountAPI"},"AccountAPI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AccountService"},"AccountService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousService"},"AnonymousService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousVote"},"AnonymousVote")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ApprovalElection"},"ApprovalElection")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection"},"ArchivedElection")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection"},"BudgetElection")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census"},"Census")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3CensusAPI"},"Census3CensusAPI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3ServiceAPI"},"Census3ServiceAPI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3StrategyAPI"},"Census3StrategyAPI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3TokenAPI"},"Census3TokenAPI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusAPI"},"CensusAPI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CensusService"},"CensusService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI"},"ChainAPI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainService"},"ChainService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspCensus"},"CspCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspService"},"CspService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspVote"},"CspVote")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Election"},"Election")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionAPI"},"ElectionAPI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ElectionService"},"ElectionService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FaucetAPI"},"FaucetAPI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FaucetService"},"FaucetService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FileAPI"},"FileAPI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/FileService"},"FileService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/InvalidElection"},"InvalidElection")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/MultiChoiceElection"},"MultiChoiceElection")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus"},"PlainCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedCensus"},"PublishedCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Service"},"Service")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/TokenCensus"},"TokenCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client"},"VocdoniCensus3Client")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient"},"VocdoniSDKClient")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Vote"},"Vote")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VoteAPI"},"VoteAPI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VoteService"},"VoteService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WalletAPI"},"WalletAPI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus"},"WeightedCensus"))),(0,r.kt)("h3",{id:"interfaces"},"Interfaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AccountMetadata"},"AccountMetadata")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AdminTx"},"AdminTx")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CircuitInputs"},"CircuitInputs")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/CollectFaucetTx"},"CollectFaucetTx")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ElectionMetadata"},"ElectionMetadata")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/FetchElectionsParameters"},"FetchElectionsParameters")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IAccount"},"IAccount")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IAccountTransfersCountResponse"},"IAccountTransfersCountResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IAccountsCountResponse"},"IAccountsCountResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IAccountsListResponse"},"IAccountsListResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IApprovalElectionParameters"},"IApprovalElectionParameters")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBlockTransactionsResponse"},"IBlockTransactionsResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget"},"IBudgetElectionParametersWithBudget")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight"},"IBudgetElectionParametersWithCensusWeight")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus"},"ICensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3CensusListResponse"},"ICensus3CensusListResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3CensusQueueResponse"},"ICensus3CensusQueueResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3CensusResponse"},"ICensus3CensusResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3ServiceInfoResponse"},"ICensus3ServiceInfoResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategiesListResponse"},"ICensus3StrategiesListResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated"},"ICensus3StrategiesListResponsePaginated")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategiesOperator"},"ICensus3StrategiesOperator")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse"},"ICensus3StrategiesOperatorsResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyCreateResponse"},"ICensus3StrategyCreateResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse"},"ICensus3StrategyEstimationQueueResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse"},"ICensus3StrategyHoldersResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated"},"ICensus3StrategyHoldersResponsePaginated")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse"},"ICensus3StrategyImportQueueResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyToken"},"ICensus3StrategyToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3SupportedChain"},"ICensus3SupportedChain")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3TokenHolderResponse"},"ICensus3TokenHolderResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3TokenListResponse"},"ICensus3TokenListResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated"},"ICensus3TokenListResponsePaginated")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3TokenTypesResponse"},"ICensus3TokenTypesResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3ValidatePredicateChild"},"ICensus3ValidatePredicateChild")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse"},"ICensus3ValidatePredicateResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3ValidatePredicateToken"},"ICensus3ValidatePredicateToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusExportResponse"},"ICensusExportResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusImportResponse"},"ICensusImportResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusParticipant"},"ICensusParticipant")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusProofResponse"},"ICensusProofResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusPublishResponse"},"ICensusPublishResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainBlockInfoResponse"},"IChainBlockInfoResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetCircuitResponse"},"IChainGetCircuitResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetCostsResponse"},"IChainGetCostsResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainGetInfoResponse"},"IChainGetInfoResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainOrganizationCountResponse"},"IChainOrganizationCountResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainOrganizationListResponse"},"IChainOrganizationListResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainOrganizationResponse"},"IChainOrganizationResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainSubmitTxResponse"},"IChainSubmitTxResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainTxCountResponse"},"IChainTxCountResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainTxListResponse"},"IChainTxListResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainTxReference"},"IChainTxReference")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainValidator"},"IChainValidator")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainValidatorsListResponse"},"IChainValidatorsListResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChoice"},"IChoice")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionCreateResponse"},"IElectionCreateResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse"},"IElectionInfoResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionKeysResponse"},"IElectionKeysResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionListFilter"},"IElectionListFilter")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionListResponse"},"IElectionListResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionMode"},"IElectionMode")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionNextIdResponse"},"IElectionNextIdResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionSummary"},"IElectionSummary")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionType"},"IElectionType")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionVote"},"IElectionVote")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionVoteListResponse"},"IElectionVoteListResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IEncryptionKey"},"IEncryptionKey")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IInvalidElectionParameters"},"IInvalidElectionParameters")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters"},"IMultiChoiceElectionParameters")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters"},"IPublishedElectionParameters")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IQuestion"},"IQuestion")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ITallyMode"},"ITallyMode")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteInfoResponse"},"IVoteInfoResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteMode"},"IVoteMode")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteSubmitResponse"},"IVoteSubmitResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteType"},"IVoteType")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/MintTokensTx"},"MintTokensTx")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/NewProcessTx"},"NewProcessTx")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Process"},"Process")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Proof"},"Proof")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/RegisterKeyTx"},"RegisterKeyTx")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SendTokensTx"},"SendTokensTx")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ServiceProperties"},"ServiceProperties")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetAccountTx"},"SetAccountTx")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetProcessTx"},"SetProcessTx")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetTransactionCostsTx"},"SetTransactionCostsTx")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Tx"},"Tx")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/VoteEnvelope"},"VoteEnvelope"))),(0,r.kt)("h3",{id:"type-aliases"},"Type Aliases"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#accountdata"},"AccountData")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#allelectionstatus"},"AllElectionStatus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#archivedaccountdata"},"ArchivedAccountData")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#census3census"},"Census3Census")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#census3createstrategytoken"},"Census3CreateStrategyToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#census3strategy"},"Census3Strategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#census3strategytoken"},"Census3StrategyToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#census3summarytoken"},"Census3SummaryToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#census3token"},"Census3Token")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#censusimportexport"},"CensusImportExport")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#censusproof"},"CensusProof")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#chaincircuits"},"ChainCircuits")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#chaincosts"},"ChainCosts")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#chaindata"},"ChainData")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#chaintx"},"ChainTx")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#clientoptions"},"ClientOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#cspcensusproof"},"CspCensusProof")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#electioncreatedinformation"},"ElectionCreatedInformation")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#electioncreationstepvalue"},"ElectionCreationStepValue")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#electionidoption"},"ElectionIdOption")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#electionkeys"},"ElectionKeys")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#electionmeta"},"ElectionMeta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#electionresultstype"},"ElectionResultsType")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#faucetoptions"},"FaucetOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#faucetpackage"},"FaucetPackage")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#hasalreadyvotedoptions"},"HasAlreadyVotedOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#iaccountsummary"},"IAccountSummary")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#ibudgetelectionparameters"},"IBudgetElectionParameters")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#isabletovoteoptions"},"IsAbleToVoteOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#isincensusoptions"},"IsInCensusOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#parsedpredicate"},"ParsedPredicate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#sendtokensoptions"},"SendTokensOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#strategy"},"Strategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#strategyholder"},"StrategyHolder")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#strategyholders"},"StrategyHolders")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#strategytoken"},"StrategyToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#supportedchain"},"SupportedChain")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#supportedoperator"},"SupportedOperator")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#token"},"Token")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#tokensummary"},"TokenSummary")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#txwaitoptions"},"TxWaitOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#voteidoption"},"VoteIdOption")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#voteinfo"},"VoteInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#votestepvalue"},"VoteStepValue")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#votesubmit"},"VoteSubmit")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#votesleftcountoptions"},"VotesLeftCountOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#walletoption"},"WalletOption")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#zkproof"},"ZkProof"))),(0,r.kt)("h3",{id:"variables"},"Variables"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#accountmetadatatemplate"},"AccountMetadataTemplate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#electionmetadatatemplate"},"ElectionMetadataTemplate"))),(0,r.kt)("h3",{id:"functions"},"Functions"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#areequalhexstrings"},"areEqualHexStrings")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#checkvalidaccountmetadata"},"checkValidAccountMetadata")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#checkvalidelectionmetadata"},"checkValidElectionMetadata")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#delay"},"delay")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#dotobject"},"dotobject")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#ensure0x"},"ensure0x")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#formatunits"},"formatUnits")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#getbytes"},"getBytes")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#gethex"},"getHex")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/modules#strip0x"},"strip0x"))),(0,r.kt)("h2",{id:"type-aliases-1"},"Type Aliases"),(0,r.kt)("h3",{id:"accountdata"},"AccountData"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"AccountData"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"account")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Account"},(0,r.kt)("inlineCode",{parentName:"a"},"Account")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"balance")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionIndex")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"infoURL?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nonce")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sik?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/account.ts#L25"},"services/account.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"allelectionstatus"},"AllElectionStatus"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"AllElectionStatus"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatusReady"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionStatusReady"))),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L24"},"types/election/published.ts:24")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"archivedaccountdata"},"ArchivedAccountData"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ArchivedAccountData"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Pick"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountData")),", ",(0,r.kt)("inlineCode",{parentName:"p"},'"address"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"account"'),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/account.ts#L35"},"services/account.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"census3census"},"Census3Census"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Census3Census"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse"))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L30"},"census3.ts:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"census3createstrategytoken"},"Census3CreateStrategyToken"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Census3CreateStrategyToken"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Omit"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3strategytoken"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3StrategyToken")),", ",(0,r.kt)("inlineCode",{parentName:"p"},'"chainAddress"'),">"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L100"},"api/census3/strategy.ts:100")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"census3strategy"},"Census3Strategy"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Census3Strategy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ID")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The strategy identifier")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"alias")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The strategy alias")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"predicate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The strategy predicate")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokens")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{"," ",(0,r.kt)("inlineCode",{parentName:"td"},"[key: string]"),": ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#census3strategytoken"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3StrategyToken")),"; }"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of tokens")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"uri")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The URI of the strategy")))),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L46"},"api/census3/strategy.ts:46")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"census3strategytoken"},"Census3StrategyToken"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Census3StrategyToken"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ID")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id (address) of the token.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainAddress")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chain address of the token.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainID")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chain id of the token.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalID?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The external identifier of the token.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"minBalance?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The minimum balance for the strategy.")))),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L73"},"api/census3/strategy.ts:73")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"census3summarytoken"},"Census3SummaryToken"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Census3SummaryToken"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Omit"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3token"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Token")),", ",(0,r.kt)("inlineCode",{parentName:"p"},'"status"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"size"'),">"," & ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"synced"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/token.ts#L12"},"api/census3/token.ts:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"census3token"},"Census3Token"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Census3Token"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ID")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id (address) of the token.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainAddress")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chain address of the token.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainID")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chain id of the token.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"decimals")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The decimals of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"defaultStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The default strategy assigned.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalID?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The external identifier of the token.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"iconURI?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The icon URI of the token.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The name of the token.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"size")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The size (token holders) of the token.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"startBlock")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The creation block.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"status")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{"," ",(0,r.kt)("inlineCode",{parentName:"td"},"atBlock"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"progress"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"synced"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," }"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census3 status of the token.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"status.atBlock")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"At which number of block the token is synced")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"status.progress")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The progress percentage of the sync")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"status.synced")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the token is already synced or not.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"symbol")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The symbol of the token.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The tags of the token.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"totalSupply")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The total supply of the token.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"type")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The type of the token.")))),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/token.ts#L14"},"api/census3/token.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censusimportexport"},"CensusImportExport"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CensusImportExport"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"maxLevels")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"rootHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"type")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L42"},"services/census.ts:42")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censusproof"},"CensusProof"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CensusProof"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-5"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"proof")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"root")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"siblings?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"type")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"weight")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L26"},"services/census.ts:26")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"chaincircuits"},"ChainCircuits"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ChainCircuits"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-6"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"vKeyData")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Uint8Array"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"vKeyHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"vKeyURI")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wasmData")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Uint8Array"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wasmHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wasmURI")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"zKeyData")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Uint8Array"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"zKeyHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"zKeyURI")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L51"},"services/anonymous.ts:51")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"chaincosts"},"ChainCosts"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ChainCosts"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainGetCostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCostsResponse"))),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/chain.ts#L14"},"services/chain.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"chaindata"},"ChainData"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ChainData"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-7"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockTime")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockTimestamp")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"height")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"maxCensusSize")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/chain.ts#L29"},"services/chain.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"chaintx"},"ChainTx"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ChainTx"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainTxReference"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainTxReference"))),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/chain.ts#L15"},"services/chain.ts:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"clientoptions"},"ClientOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ClientOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Optional VocdoniSDKClient arguments"),(0,r.kt)("h4",{id:"type-declaration-8"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"api_url?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"env")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/enums/EnvOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"EnvOptions")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"faucet?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#faucetoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FaucetOptions")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tx_wait?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"TxWaitOptions"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wallet?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Signer"))))),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L85"},"client.ts:85")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"cspcensusproof"},"CspCensusProof"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CspCensusProof"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-9"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"proof_type?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CspProofType"},(0,r.kt)("inlineCode",{parentName:"a"},"CspProofType")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signature")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"type?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"weight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/census.ts#L56"},"services/census.ts:56")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electioncreatedinformation"},"ElectionCreatedInformation"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ElectionCreatedInformation"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionCreateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionCreateResponse"))),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L37"},"services/election.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electioncreationstepvalue"},"ElectionCreationStepValue"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ElectionCreationStepValue"),": ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionCreationSteps#get_chain_data"},(0,r.kt)("inlineCode",{parentName:"a"},"GET_CHAIN_DATA"))," } ","|"," ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionCreationSteps#census_created"},(0,r.kt)("inlineCode",{parentName:"a"},"CENSUS_CREATED"))," } ","|"," ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionCreationSteps#get_account_data"},(0,r.kt)("inlineCode",{parentName:"a"},"GET_ACCOUNT_DATA"))," } ","|"," ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionCreationSteps#get_data_pin"},(0,r.kt)("inlineCode",{parentName:"a"},"GET_DATA_PIN"))," } ","|"," ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionCreationSteps#generate_tx"},(0,r.kt)("inlineCode",{parentName:"a"},"GENERATE_TX"))," } ","|"," ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionCreationSteps#sign_tx"},(0,r.kt)("inlineCode",{parentName:"a"},"SIGN_TX"))," } ","|"," ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionCreationSteps#creating"},(0,r.kt)("inlineCode",{parentName:"a"},"CREATING"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"txHash"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," } ","|"," ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionCreationSteps#done"},(0,r.kt)("inlineCode",{parentName:"a"},"DONE"))," }"),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L50"},"services/election.ts:50")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electionidoption"},"ElectionIdOption"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ElectionIdOption"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-10"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/client/account.ts#L5"},"types/client/account.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electionkeys"},"ElectionKeys"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ElectionKeys"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionKeysResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionKeysResponse"))),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L36"},"services/election.ts:36")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electionmeta"},"ElectionMeta"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ElectionMeta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"AnyJson")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JsonArray")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JsonMap")),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L101"},"types/election/election.ts:101")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electionresultstype"},"ElectionResultsType"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ElectionResultsType"),": ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionResultsTypeNames#single_choice_multiquestion"},(0,r.kt)("inlineCode",{parentName:"a"},"SINGLE_CHOICE_MULTIQUESTION"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"properties"),": {} } ","|"," ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionResultsTypeNames#multiple_choice"},(0,r.kt)("inlineCode",{parentName:"a"},"MULTIPLE_CHOICE"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"properties"),": ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"abstainValues"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"canAbstain"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"repeatChoice"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } } ","|"," ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionResultsTypeNames#budget"},(0,r.kt)("inlineCode",{parentName:"a"},"BUDGET"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"properties"),": ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"forceFullBudget"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"maxBudget"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"minStep"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"useCensusWeightAsBudget"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } } ","|"," ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionResultsTypeNames#approval"},(0,r.kt)("inlineCode",{parentName:"a"},"APPROVAL"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"properties"),": ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"acceptValue"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"rejectValue"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," } }"),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L44"},"types/metadata/election.ts:44")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"faucetoptions"},"FaucetOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"FaucetOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"FaucetServiceParameters")),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/faucet.ts#L28"},"services/faucet.ts:28")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"faucetpackage"},"FaucetPackage"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"FaucetPackage"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-11"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signature")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/faucet.ts#L23"},"services/faucet.ts:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasalreadyvotedoptions"},"HasAlreadyVotedOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HasAlreadyVotedOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#walletoption"},(0,r.kt)("inlineCode",{parentName:"a"},"WalletOption"))," & ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#electionidoption"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionIdOption"))," & ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#voteidoption"},(0,r.kt)("inlineCode",{parentName:"a"},"VoteIdOption")),">"),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/client/account.ts#L10"},"types/client/account.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"iaccountsummary"},"IAccountSummary"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"IAccountSummary"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Pick"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IAccountInfoResponse"),", ",(0,r.kt)("inlineCode",{parentName:"p"},'"address"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"balance"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"nonce"'),">"),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/account.ts#L17"},"api/account.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ibudgetelectionparameters"},"IBudgetElectionParameters"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"IBudgetElectionParameters"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight"},(0,r.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParametersWithCensusWeight"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget"},(0,r.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParametersWithBudget"))),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L21"},"types/election/budget.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isabletovoteoptions"},"IsAbleToVoteOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"IsAbleToVoteOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#walletoption"},(0,r.kt)("inlineCode",{parentName:"a"},"WalletOption"))," & ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#electionidoption"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionIdOption"))," & ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#voteidoption"},(0,r.kt)("inlineCode",{parentName:"a"},"VoteIdOption")),">"),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/client/account.ts#L12"},"types/client/account.ts:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isincensusoptions"},"IsInCensusOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"IsInCensusOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#walletoption"},(0,r.kt)("inlineCode",{parentName:"a"},"WalletOption"))," & ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#electionidoption"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionIdOption")),">"),(0,r.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/client/account.ts#L9"},"types/client/account.ts:9")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parsedpredicate"},"ParsedPredicate"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ParsedPredicate"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3ValidatePredicateResponse"))),(0,r.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L33"},"census3.ts:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendtokensoptions"},"SendTokensOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SendTokensOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#walletoption"},(0,r.kt)("inlineCode",{parentName:"a"},"WalletOption")),">"," & ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"amount"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"to"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }"),(0,r.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/client/account.ts#L8"},"types/client/account.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"strategy"},"Strategy"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Strategy"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy"))),(0,r.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L26"},"census3.ts:26")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"strategyholder"},"StrategyHolder"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"StrategyHolder"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-12"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"holder")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"weight")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,r.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L27"},"census3.ts:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"strategyholders"},"StrategyHolders"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"StrategyHolders"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-13"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"holders")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#strategyholder"},(0,r.kt)("inlineCode",{parentName:"a"},"StrategyHolder")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pagination")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Census3Pagination"))))),(0,r.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L28"},"census3.ts:28")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"strategytoken"},"StrategyToken"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"StrategyToken"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3createstrategytoken"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3CreateStrategyToken"))),(0,r.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L29"},"census3.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"supportedchain"},"SupportedChain"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SupportedChain"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3SupportedChain"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3SupportedChain"))),(0,r.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L31"},"census3.ts:31")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"supportedoperator"},"SupportedOperator"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SupportedOperator"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategiesOperator"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesOperator"))),(0,r.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L32"},"census3.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"token"},"Token"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Token"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Omit"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3token"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Token")),", ",(0,r.kt)("inlineCode",{parentName:"p"},'"tags"'),">"," & ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"tags"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] }"),(0,r.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L24"},"census3.ts:24")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tokensummary"},"TokenSummary"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"TokenSummary"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Omit"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3summarytoken"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3SummaryToken")),", ",(0,r.kt)("inlineCode",{parentName:"p"},'"tags"'),">"," & ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"tags"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] }"),(0,r.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L25"},"census3.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"txwaitoptions"},"TxWaitOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"TxWaitOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Specify custom retry times and attempts when waiting for a transaction."),(0,r.kt)("h4",{id:"type-declaration-14"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"attempts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"retryTime")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/chain.ts#L24"},"services/chain.ts:24")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"voteidoption"},"VoteIdOption"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"VoteIdOption"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-15"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"voteId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/client/account.ts#L6"},"types/client/account.ts:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"voteinfo"},"VoteInfo"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"VoteInfo"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IVoteInfoResponse"))),(0,r.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/vote.ts#L15"},"services/vote.ts:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"votestepvalue"},"VoteStepValue"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"VoteStepValue"),": ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/VoteSteps#get_election"},(0,r.kt)("inlineCode",{parentName:"a"},"GET_ELECTION"))," } ","|"," ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/VoteSteps#get_proof"},(0,r.kt)("inlineCode",{parentName:"a"},"GET_PROOF"))," } ","|"," ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/VoteSteps#get_signature"},(0,r.kt)("inlineCode",{parentName:"a"},"GET_SIGNATURE"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"signature"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," } ","|"," ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/VoteSteps#calc_zk_proof"},(0,r.kt)("inlineCode",{parentName:"a"},"CALC_ZK_PROOF"))," } ","|"," ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/VoteSteps#generate_tx"},(0,r.kt)("inlineCode",{parentName:"a"},"GENERATE_TX"))," } ","|"," ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/VoteSteps#sign_tx"},(0,r.kt)("inlineCode",{parentName:"a"},"SIGN_TX"))," } ","|"," ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/VoteSteps#done"},(0,r.kt)("inlineCode",{parentName:"a"},"DONE"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"voteId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }"),(0,r.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/vote.ts#L28"},"services/vote.ts:28")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"votesubmit"},"VoteSubmit"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"VoteSubmit"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteSubmitResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IVoteSubmitResponse"))),(0,r.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/vote.ts#L16"},"services/vote.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"votesleftcountoptions"},"VotesLeftCountOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"VotesLeftCountOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#walletoption"},(0,r.kt)("inlineCode",{parentName:"a"},"WalletOption"))," & ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#electionidoption"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionIdOption"))," & ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#voteidoption"},(0,r.kt)("inlineCode",{parentName:"a"},"VoteIdOption")),">"),(0,r.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/client/account.ts#L11"},"types/client/account.ts:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"walletoption"},"WalletOption"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"WalletOption"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-16"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wallet")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Signer"))))),(0,r.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/client/account.ts#L4"},"types/client/account.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"zkproof"},"ZkProof"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ZkProof"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-17"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"proof")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{"," ",(0,r.kt)("inlineCode",{parentName:"td"},"curve"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"pi_a"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"td"},"pi_b"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[][]"," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"pi_c"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"td"},"protocol"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"proof.curve")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"proof.pi_a")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"proof.pi_b")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[][]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"proof.pi_c")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"proof.protocol")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"publicSignals")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")))),(0,r.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/anonymous.ts#L23"},"services/anonymous.ts:23")),(0,r.kt)("h2",{id:"variables-1"},"Variables"),(0,r.kt)("h3",{id:"accountmetadatatemplate"},"AccountMetadataTemplate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"AccountMetadataTemplate"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/AccountMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountMetadata"))),(0,r.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/account.ts#L67"},"types/metadata/account.ts:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electionmetadatatemplate"},"ElectionMetadataTemplate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"ElectionMetadataTemplate"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ElectionMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,r.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L140"},"types/metadata/election.ts:140")),(0,r.kt)("h2",{id:"functions-1"},"Functions"),(0,r.kt)("h3",{id:"areequalhexstrings"},"areEqualHexStrings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"areEqualHexStrings"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"hex1?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hex2?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Compares two hex strings checking if they're the same. It ensures both\nhave hex prefix and are lowercase."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hex1?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hex2?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/util/common.ts#L36"},"util/common.ts:36")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"checkvalidaccountmetadata"},"checkValidAccountMetadata"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkValidAccountMetadata"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"accountMetadata"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/AccountMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountMetadata"))),(0,r.kt)("p",null,"Asserts that the given metadata is valid.\nThrows an exception if it is not."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"accountMetadata")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/AccountMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountMetadata")))))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/AccountMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountMetadata"))),(0,r.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/account.ts#L8"},"types/metadata/account.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"checkvalidelectionmetadata"},"checkValidElectionMetadata"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkValidElectionMetadata"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionMetadata"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ElectionMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,r.kt)("p",null,"Asserts that the given metadata is valid.\nThrows an exception if it is not."),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionMetadata")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ElectionMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionMetadata")))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ElectionMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,r.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L8"},"types/metadata/election.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"delay"},"delay"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"delay"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"ms"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ms")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/util/common.ts#L6"},"util/common.ts:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"dotobject"},"dotobject"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dotobject"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"obj"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dot"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Dot notation to object conversion. Takes any object as first argument and uses the string dot notation from the\nsecond argument (i.e. 'a.child.node') to access that given object value."),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"obj")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Object to be accessed by dot notation")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dot")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Dot notation string to extract object data")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Return the object data"),(0,r.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/util/common.ts#L61"},"util/common.ts:61")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ensure0x"},"ensure0x"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ensure0x"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/util/common.ts#L12"},"util/common.ts:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"formatunits"},"formatUnits"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"formatUnits"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"decimals?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns a string representation of value formatted with decimals digits"),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"BigNumberish")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The value in native BigInt")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"decimals")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"18")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The number of decimals")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The formatted string"),(0,r.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/util/common.ts#L49"},"util/common.ts:49")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getbytes"},"getBytes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getBytes"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"count"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"count")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/util/common.ts#L16"},"util/common.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gethex"},"getHex"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getHex"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,'Generates a random seed and returns a 32 byte keccak256 hash of it (starting with "0x")'),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/util/common.ts#L23"},"util/common.ts:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"strip0x"},"strip0x"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"strip0x"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/util/common.ts#L8"},"util/common.ts:8")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/87d0da39.d78eacb8.js b/assets/js/87d0da39.d78eacb8.js new file mode 100644 index 000000000..986e18831 --- /dev/null +++ b/assets/js/87d0da39.d78eacb8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1719],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>u});var n=a(67294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},s=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,d=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),m=o(a),u=i,N=m["".concat(d,".").concat(u)]||m[u]||k[u]||r;return a?n.createElement(N,l(l({ref:t},s),{},{components:a})):n.createElement(N,l({ref:t},s))}));function u(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,l=new Array(r);l[0]=m;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:i,l[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>k,frontMatter:()=>r,metadata:()=>p,toc:()=>o});var n=a(87462),i=(a(67294),a(3905));const r={},l=void 0,p={unversionedId:"sdk/reference/modules",id:"sdk/reference/modules",title:"modules",description:"@vocdoni/sdk / Exports",source:"@site/docs/sdk/reference/modules.md",sourceDirName:"sdk/reference",slug:"/sdk/reference/modules",permalink:"/sdk/reference/modules",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"VoteEnvelope",permalink:"/sdk/reference/interfaces/VoteEnvelope"},next:{title:"Changelog",permalink:"/sdk/reference/changelog"}},d={},o=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Classes",id:"classes",level:3},{value:"Interfaces",id:"interfaces",level:3},{value:"Type Aliases",id:"type-aliases",level:3},{value:"Variables",id:"variables",level:3},{value:"Functions",id:"functions",level:3},{value:"Type Aliases",id:"type-aliases-1",level:2},{value:"AccountData",id:"accountdata",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"AllElectionStatus",id:"allelectionstatus",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ArchivedAccountData",id:"archivedaccountdata",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Census3Census",id:"census3census",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Census3CreateStrategyToken",id:"census3createstrategytoken",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Census3Strategy",id:"census3strategy",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Census3StrategyToken",id:"census3strategytoken",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Census3SummaryToken",id:"census3summarytoken",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"Census3Token",id:"census3token",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"CensusImportExport",id:"censusimportexport",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"CensusProof",id:"censusproof",level:3},{value:"Type declaration",id:"type-declaration-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"ChainCircuits",id:"chaincircuits",level:3},{value:"Type declaration",id:"type-declaration-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"ChainCosts",id:"chaincosts",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"ChainData",id:"chaindata",level:3},{value:"Type declaration",id:"type-declaration-7",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"ChainTx",id:"chaintx",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"ClientOptions",id:"clientoptions",level:3},{value:"Type declaration",id:"type-declaration-8",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"CspCensusProof",id:"cspcensusproof",level:3},{value:"Type declaration",id:"type-declaration-9",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"ElectionCreatedInformation",id:"electioncreatedinformation",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"ElectionCreationStepValue",id:"electioncreationstepvalue",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"ElectionIdOption",id:"electionidoption",level:3},{value:"Type declaration",id:"type-declaration-10",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"ElectionKeys",id:"electionkeys",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"ElectionMeta",id:"electionmeta",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"ElectionResultsType",id:"electionresultstype",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"FaucetOptions",id:"faucetoptions",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"FaucetPackage",id:"faucetpackage",level:3},{value:"Type declaration",id:"type-declaration-11",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"HasAlreadyVotedOptions",id:"hasalreadyvotedoptions",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"IAccountSummary",id:"iaccountsummary",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"IBudgetElectionParameters",id:"ibudgetelectionparameters",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"IsAbleToVoteOptions",id:"isabletovoteoptions",level:3},{value:"Defined in",id:"defined-in-28",level:4},{value:"IsInCensusOptions",id:"isincensusoptions",level:3},{value:"Defined in",id:"defined-in-29",level:4},{value:"ParsedPredicate",id:"parsedpredicate",level:3},{value:"Defined in",id:"defined-in-30",level:4},{value:"SendTokensOptions",id:"sendtokensoptions",level:3},{value:"Defined in",id:"defined-in-31",level:4},{value:"Strategy",id:"strategy",level:3},{value:"Defined in",id:"defined-in-32",level:4},{value:"StrategyHolder",id:"strategyholder",level:3},{value:"Type declaration",id:"type-declaration-12",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"StrategyHolders",id:"strategyholders",level:3},{value:"Type declaration",id:"type-declaration-13",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"StrategyToken",id:"strategytoken",level:3},{value:"Defined in",id:"defined-in-35",level:4},{value:"SupportedChain",id:"supportedchain",level:3},{value:"Defined in",id:"defined-in-36",level:4},{value:"SupportedOperator",id:"supportedoperator",level:3},{value:"Defined in",id:"defined-in-37",level:4},{value:"Token",id:"token",level:3},{value:"Defined in",id:"defined-in-38",level:4},{value:"TokenSummary",id:"tokensummary",level:3},{value:"Defined in",id:"defined-in-39",level:4},{value:"TxWaitOptions",id:"txwaitoptions",level:3},{value:"Type declaration",id:"type-declaration-14",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"VoteIdOption",id:"voteidoption",level:3},{value:"Type declaration",id:"type-declaration-15",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"VoteInfo",id:"voteinfo",level:3},{value:"Defined in",id:"defined-in-42",level:4},{value:"VoteStepValue",id:"votestepvalue",level:3},{value:"Defined in",id:"defined-in-43",level:4},{value:"VoteSubmit",id:"votesubmit",level:3},{value:"Defined in",id:"defined-in-44",level:4},{value:"VotesLeftCountOptions",id:"votesleftcountoptions",level:3},{value:"Defined in",id:"defined-in-45",level:4},{value:"WalletOption",id:"walletoption",level:3},{value:"Type declaration",id:"type-declaration-16",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"ZkProof",id:"zkproof",level:3},{value:"Type declaration",id:"type-declaration-17",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"Variables",id:"variables-1",level:2},{value:"AccountMetadataTemplate",id:"accountmetadatatemplate",level:3},{value:"Defined in",id:"defined-in-48",level:4},{value:"ElectionMetadataTemplate",id:"electionmetadatatemplate",level:3},{value:"Defined in",id:"defined-in-49",level:4},{value:"Functions",id:"functions-1",level:2},{value:"areEqualHexStrings",id:"areequalhexstrings",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"checkValidAccountMetadata",id:"checkvalidaccountmetadata",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"checkValidElectionMetadata",id:"checkvalidelectionmetadata",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"delay",id:"delay",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"dotobject",id:"dotobject",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"ensure0x",id:"ensure0x",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"formatUnits",id:"formatunits",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"getBytes",id:"getbytes",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"getHex",id:"gethex",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"strip0x",id:"strip0x",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-59",level:4}],s={toc:o};function k(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / Exports"),(0,i.kt)("h1",{id:"vocdonisdk"},"@vocdoni/sdk"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"enumerations"},"Enumerations"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"enums/CensusOrigin"},"CensusOrigin")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"enums/CensusType"},"CensusType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"enums/CensusTypeEnum"},"CensusTypeEnum")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"enums/CspProofType"},"CspProofType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"enums/ElectionCreationSteps"},"ElectionCreationSteps")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"enums/ElectionResultsTypeNames"},"ElectionResultsTypeNames")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"enums/ElectionStatus"},"ElectionStatus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"enums/ElectionStatusReady"},"ElectionStatusReady")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"enums/EnvOptions"},"EnvOptions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"enums/TransactionType"},"TransactionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"enums/TxType"},"TxType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"enums/VoteSteps"},"VoteSteps"))),(0,i.kt)("h3",{id:"classes"},"Classes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/Account"},"Account")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/AccountAPI"},"AccountAPI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/AccountService"},"AccountService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/AnonymousService"},"AnonymousService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/AnonymousVote"},"AnonymousVote")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/ApprovalElection"},"ApprovalElection")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/ArchivedElection"},"ArchivedElection")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/BudgetElection"},"BudgetElection")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/Census"},"Census")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/Census3CensusAPI"},"Census3CensusAPI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/Census3ServiceAPI"},"Census3ServiceAPI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/Census3StrategyAPI"},"Census3StrategyAPI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/Census3TokenAPI"},"Census3TokenAPI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/CensusAPI"},"CensusAPI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/CensusService"},"CensusService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/ChainAPI"},"ChainAPI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/ChainService"},"ChainService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/CspCensus"},"CspCensus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/CspService"},"CspService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/CspVote"},"CspVote")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/Election"},"Election")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/ElectionAPI"},"ElectionAPI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/ElectionService"},"ElectionService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/FaucetAPI"},"FaucetAPI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/FaucetService"},"FaucetService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/FileAPI"},"FileAPI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/FileService"},"FileService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/InvalidElection"},"InvalidElection")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/MultiChoiceElection"},"MultiChoiceElection")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/OffchainCensus"},"OffchainCensus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/PlainCensus"},"PlainCensus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/PublishedCensus"},"PublishedCensus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/PublishedElection"},"PublishedElection")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/Service"},"Service")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/TokenCensus"},"TokenCensus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/UnpublishedElection"},"UnpublishedElection")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/VocdoniCensus3Client"},"VocdoniCensus3Client")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/VocdoniSDKClient"},"VocdoniSDKClient")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/Vote"},"Vote")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/VoteAPI"},"VoteAPI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/VoteService"},"VoteService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/WalletAPI"},"WalletAPI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"classes/WeightedCensus"},"WeightedCensus"))),(0,i.kt)("h3",{id:"interfaces"},"Interfaces"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/AccountMetadata"},"AccountMetadata")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/AdminTx"},"AdminTx")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/CircuitInputs"},"CircuitInputs")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/CollectFaucetTx"},"CollectFaucetTx")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ElectionMetadata"},"ElectionMetadata")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/FetchElectionsParameters"},"FetchElectionsParameters")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IAccount"},"IAccount")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IAccountTransfersCountResponse"},"IAccountTransfersCountResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IAccountsCountResponse"},"IAccountsCountResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IAccountsListResponse"},"IAccountsListResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IApprovalElectionParameters"},"IApprovalElectionParameters")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IBlockTransactionsResponse"},"IBlockTransactionsResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IBudgetElectionParametersWithBudget"},"IBudgetElectionParametersWithBudget")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IBudgetElectionParametersWithCensusWeight"},"IBudgetElectionParametersWithCensusWeight")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus"},"ICensus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3CensusListResponse"},"ICensus3CensusListResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3CensusQueueResponse"},"ICensus3CensusQueueResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3CensusResponse"},"ICensus3CensusResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3ServiceInfoResponse"},"ICensus3ServiceInfoResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3StrategiesListResponse"},"ICensus3StrategiesListResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3StrategiesListResponsePaginated"},"ICensus3StrategiesListResponsePaginated")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3StrategiesOperator"},"ICensus3StrategiesOperator")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3StrategiesOperatorsResponse"},"ICensus3StrategiesOperatorsResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3StrategyCreateResponse"},"ICensus3StrategyCreateResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3StrategyEstimationQueueResponse"},"ICensus3StrategyEstimationQueueResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3StrategyHoldersResponse"},"ICensus3StrategyHoldersResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3StrategyHoldersResponsePaginated"},"ICensus3StrategyHoldersResponsePaginated")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3StrategyImportQueueResponse"},"ICensus3StrategyImportQueueResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3StrategyToken"},"ICensus3StrategyToken")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3SupportedChain"},"ICensus3SupportedChain")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3TokenHolderResponse"},"ICensus3TokenHolderResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3TokenListResponse"},"ICensus3TokenListResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3TokenListResponsePaginated"},"ICensus3TokenListResponsePaginated")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3TokenTypesResponse"},"ICensus3TokenTypesResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3ValidatePredicateChild"},"ICensus3ValidatePredicateChild")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3ValidatePredicateResponse"},"ICensus3ValidatePredicateResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensus3ValidatePredicateToken"},"ICensus3ValidatePredicateToken")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensusExportResponse"},"ICensusExportResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensusImportResponse"},"ICensusImportResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensusParticipant"},"ICensusParticipant")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensusProofResponse"},"ICensusProofResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ICensusPublishResponse"},"ICensusPublishResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IChainBlockInfoResponse"},"IChainBlockInfoResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IChainGetCircuitResponse"},"IChainGetCircuitResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IChainGetCostsResponse"},"IChainGetCostsResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IChainGetInfoResponse"},"IChainGetInfoResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IChainOrganizationCountResponse"},"IChainOrganizationCountResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IChainOrganizationListResponse"},"IChainOrganizationListResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IChainOrganizationResponse"},"IChainOrganizationResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IChainSubmitTxResponse"},"IChainSubmitTxResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IChainTxCountResponse"},"IChainTxCountResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IChainTxListResponse"},"IChainTxListResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IChainTxReference"},"IChainTxReference")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IChainValidator"},"IChainValidator")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IChainValidatorsListResponse"},"IChainValidatorsListResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IChoice"},"IChoice")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IElectionCreateResponse"},"IElectionCreateResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IElectionInfoResponse"},"IElectionInfoResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IElectionKeysResponse"},"IElectionKeysResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IElectionListFilter"},"IElectionListFilter")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IElectionListResponse"},"IElectionListResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IElectionMode"},"IElectionMode")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IElectionNextIdResponse"},"IElectionNextIdResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IElectionParameters"},"IElectionParameters")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IElectionSummary"},"IElectionSummary")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IElectionType"},"IElectionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IElectionVote"},"IElectionVote")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IElectionVoteListResponse"},"IElectionVoteListResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IEncryptionKey"},"IEncryptionKey")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IInvalidElectionParameters"},"IInvalidElectionParameters")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IMultiChoiceElectionParameters"},"IMultiChoiceElectionParameters")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IPublishedElectionParameters"},"IPublishedElectionParameters")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IQuestion"},"IQuestion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ITallyMode"},"ITallyMode")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IVoteInfoResponse"},"IVoteInfoResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IVoteMode"},"IVoteMode")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IVoteSubmitResponse"},"IVoteSubmitResponse")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/IVoteType"},"IVoteType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/MintTokensTx"},"MintTokensTx")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/NewProcessTx"},"NewProcessTx")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/Process"},"Process")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/Proof"},"Proof")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/RegisterKeyTx"},"RegisterKeyTx")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/SendTokensTx"},"SendTokensTx")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/ServiceProperties"},"ServiceProperties")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/SetAccountTx"},"SetAccountTx")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/SetProcessTx"},"SetProcessTx")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/SetTransactionCostsTx"},"SetTransactionCostsTx")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/Tx"},"Tx")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"interfaces/VoteEnvelope"},"VoteEnvelope"))),(0,i.kt)("h3",{id:"type-aliases"},"Type Aliases"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#accountdata"},"AccountData")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#allelectionstatus"},"AllElectionStatus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#archivedaccountdata"},"ArchivedAccountData")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#census3census"},"Census3Census")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#census3createstrategytoken"},"Census3CreateStrategyToken")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#census3strategy"},"Census3Strategy")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#census3strategytoken"},"Census3StrategyToken")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#census3summarytoken"},"Census3SummaryToken")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#census3token"},"Census3Token")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#censusimportexport"},"CensusImportExport")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#censusproof"},"CensusProof")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#chaincircuits"},"ChainCircuits")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#chaincosts"},"ChainCosts")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#chaindata"},"ChainData")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#chaintx"},"ChainTx")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#clientoptions"},"ClientOptions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#cspcensusproof"},"CspCensusProof")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#electioncreatedinformation"},"ElectionCreatedInformation")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#electioncreationstepvalue"},"ElectionCreationStepValue")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#electionidoption"},"ElectionIdOption")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#electionkeys"},"ElectionKeys")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#electionmeta"},"ElectionMeta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#electionresultstype"},"ElectionResultsType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#faucetoptions"},"FaucetOptions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#faucetpackage"},"FaucetPackage")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#hasalreadyvotedoptions"},"HasAlreadyVotedOptions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#iaccountsummary"},"IAccountSummary")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#ibudgetelectionparameters"},"IBudgetElectionParameters")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#isabletovoteoptions"},"IsAbleToVoteOptions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#isincensusoptions"},"IsInCensusOptions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#parsedpredicate"},"ParsedPredicate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#sendtokensoptions"},"SendTokensOptions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#strategy"},"Strategy")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#strategyholder"},"StrategyHolder")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#strategyholders"},"StrategyHolders")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#strategytoken"},"StrategyToken")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#supportedchain"},"SupportedChain")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#supportedoperator"},"SupportedOperator")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#token"},"Token")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#tokensummary"},"TokenSummary")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#txwaitoptions"},"TxWaitOptions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#voteidoption"},"VoteIdOption")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#voteinfo"},"VoteInfo")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#votestepvalue"},"VoteStepValue")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#votesubmit"},"VoteSubmit")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#votesleftcountoptions"},"VotesLeftCountOptions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#walletoption"},"WalletOption")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#zkproof"},"ZkProof"))),(0,i.kt)("h3",{id:"variables"},"Variables"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#accountmetadatatemplate"},"AccountMetadataTemplate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#electionmetadatatemplate"},"ElectionMetadataTemplate"))),(0,i.kt)("h3",{id:"functions"},"Functions"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#areequalhexstrings"},"areEqualHexStrings")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#checkvalidaccountmetadata"},"checkValidAccountMetadata")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#checkvalidelectionmetadata"},"checkValidElectionMetadata")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#delay"},"delay")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#dotobject"},"dotobject")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#ensure0x"},"ensure0x")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#formatunits"},"formatUnits")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#getbytes"},"getBytes")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#gethex"},"getHex")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"modules#strip0x"},"strip0x"))),(0,i.kt)("h2",{id:"type-aliases-1"},"Type Aliases"),(0,i.kt)("h3",{id:"accountdata"},"AccountData"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"AccountData"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"account")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"classes/Account"},(0,i.kt)("inlineCode",{parentName:"a"},"Account")))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"address")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"balance")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionIndex")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"infoURL?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"nonce")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"sik?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/account.ts#L25"},"services/account.ts:25")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"allelectionstatus"},"AllElectionStatus"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"AllElectionStatus"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"enums/ElectionStatusReady"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionStatusReady"))),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L24"},"types/election/published.ts:24")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"archivedaccountdata"},"ArchivedAccountData"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ArchivedAccountData"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Pick"),"\\<",(0,i.kt)("a",{parentName:"p",href:"modules#accountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountData")),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"address"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"account"'),">"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/account.ts#L35"},"services/account.ts:35")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"census3census"},"Census3Census"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"Census3Census"),": ",(0,i.kt)("a",{parentName:"p",href:"interfaces/ICensus3CensusResponse"},(0,i.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse"))),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L30"},"census3.ts:30")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"census3createstrategytoken"},"Census3CreateStrategyToken"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"Census3CreateStrategyToken"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Omit"),"\\<",(0,i.kt)("a",{parentName:"p",href:"modules#census3strategytoken"},(0,i.kt)("inlineCode",{parentName:"a"},"Census3StrategyToken")),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"chainAddress"'),">"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L100"},"api/census3/strategy.ts:100")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"census3strategy"},"Census3Strategy"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"Census3Strategy"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ID")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The strategy identifier")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"alias")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The strategy alias")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"predicate")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The strategy predicate")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"tokens")),(0,i.kt)("td",{parentName:"tr",align:"left"},"{"," ",(0,i.kt)("inlineCode",{parentName:"td"},"[key: string]"),": ",(0,i.kt)("a",{parentName:"td",href:"modules#census3strategytoken"},(0,i.kt)("inlineCode",{parentName:"a"},"Census3StrategyToken")),"; }"),(0,i.kt)("td",{parentName:"tr",align:"left"},"The list of tokens")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"uri")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The URI of the strategy")))),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L46"},"api/census3/strategy.ts:46")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"census3strategytoken"},"Census3StrategyToken"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"Census3StrategyToken"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ID")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The id (address) of the token.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"chainAddress")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The chain address of the token.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"chainID")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The chain id of the token.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"externalID?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The external identifier of the token.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"minBalance?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The minimum balance for the strategy.")))),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L73"},"api/census3/strategy.ts:73")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"census3summarytoken"},"Census3SummaryToken"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"Census3SummaryToken"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Omit"),"\\<",(0,i.kt)("a",{parentName:"p",href:"modules#census3token"},(0,i.kt)("inlineCode",{parentName:"a"},"Census3Token")),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"status"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"size"'),">"," & ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"synced"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," }"),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/token.ts#L12"},"api/census3/token.ts:12")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"census3token"},"Census3Token"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"Census3Token"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ID")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The id (address) of the token.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"chainAddress")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The chain address of the token.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"chainID")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The chain id of the token.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"decimals")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The decimals of the token")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"defaultStrategy")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The default strategy assigned.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"externalID?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The external identifier of the token.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"iconURI?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The icon URI of the token.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"name")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The name of the token.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"size")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The size (token holders) of the token.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"startBlock")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The creation block.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"status")),(0,i.kt)("td",{parentName:"tr",align:"left"},"{"," ",(0,i.kt)("inlineCode",{parentName:"td"},"atBlock"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"progress"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"synced"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"boolean")," }"),(0,i.kt)("td",{parentName:"tr",align:"left"},"The census3 status of the token.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"status.atBlock")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"At which number of block the token is synced")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"status.progress")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The progress percentage of the sync")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"status.synced")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean")),(0,i.kt)("td",{parentName:"tr",align:"left"},"If the token is already synced or not.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"symbol")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The symbol of the token.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"tags?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The tags of the token.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"totalSupply")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The total supply of the token.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"type")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The type of the token.")))),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/token.ts#L14"},"api/census3/token.ts:14")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"censusimportexport"},"CensusImportExport"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"CensusImportExport"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"data")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"maxLevels")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"rootHash")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"type")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L42"},"services/census.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"censusproof"},"CensusProof"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"CensusProof"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-5"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"proof")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"root")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"siblings?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"type")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"enums/CensusType"},(0,i.kt)("inlineCode",{parentName:"a"},"CensusType")))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"weight")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L26"},"services/census.ts:26")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"chaincircuits"},"ChainCircuits"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ChainCircuits"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-6"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"vKeyData")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Uint8Array"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"vKeyHash")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"vKeyURI")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wasmData")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Uint8Array"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wasmHash")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wasmURI")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"zKeyData")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Uint8Array"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"zKeyHash")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"zKeyURI")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L51"},"services/anonymous.ts:51")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"chaincosts"},"ChainCosts"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ChainCosts"),": ",(0,i.kt)("a",{parentName:"p",href:"interfaces/IChainGetCostsResponse"},(0,i.kt)("inlineCode",{parentName:"a"},"IChainGetCostsResponse"))),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/chain.ts#L14"},"services/chain.ts:14")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"chaindata"},"ChainData"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ChainData"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-7"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"blockTime")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"blockTimestamp")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"chainId")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"height")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"maxCensusSize")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/chain.ts#L29"},"services/chain.ts:29")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"chaintx"},"ChainTx"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ChainTx"),": ",(0,i.kt)("a",{parentName:"p",href:"interfaces/IChainTxReference"},(0,i.kt)("inlineCode",{parentName:"a"},"IChainTxReference"))),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/chain.ts#L15"},"services/chain.ts:15")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"clientoptions"},"ClientOptions"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ClientOptions"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("p",null,"Optional VocdoniSDKClient arguments"),(0,i.kt)("h4",{id:"type-declaration-8"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"api_url?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionId?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"env")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"enums/EnvOptions"},(0,i.kt)("inlineCode",{parentName:"a"},"EnvOptions")))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"faucet?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,i.kt)("a",{parentName:"td",href:"modules#faucetoptions"},(0,i.kt)("inlineCode",{parentName:"a"},"FaucetOptions")),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"tx_wait?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TxWaitOptions"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wallet?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"Signer"))))),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L85"},"client.ts:85")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"cspcensusproof"},"CspCensusProof"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"CspCensusProof"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-9"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"address")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"proof_type?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"enums/CspProofType"},(0,i.kt)("inlineCode",{parentName:"a"},"CspProofType")))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"signature")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"type?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"weight?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/census.ts#L56"},"services/census.ts:56")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electioncreatedinformation"},"ElectionCreatedInformation"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ElectionCreatedInformation"),": ",(0,i.kt)("a",{parentName:"p",href:"interfaces/IElectionCreateResponse"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionCreateResponse"))),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L37"},"services/election.ts:37")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electioncreationstepvalue"},"ElectionCreationStepValue"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ElectionCreationStepValue"),": ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionCreationSteps#get_chain_data"},(0,i.kt)("inlineCode",{parentName:"a"},"GET_CHAIN_DATA"))," } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionCreationSteps#census_created"},(0,i.kt)("inlineCode",{parentName:"a"},"CENSUS_CREATED"))," } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionCreationSteps#get_account_data"},(0,i.kt)("inlineCode",{parentName:"a"},"GET_ACCOUNT_DATA"))," } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionCreationSteps#get_data_pin"},(0,i.kt)("inlineCode",{parentName:"a"},"GET_DATA_PIN"))," } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionCreationSteps#generate_tx"},(0,i.kt)("inlineCode",{parentName:"a"},"GENERATE_TX"))," } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionCreationSteps#sign_tx"},(0,i.kt)("inlineCode",{parentName:"a"},"SIGN_TX"))," } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionCreationSteps#creating"},(0,i.kt)("inlineCode",{parentName:"a"},"CREATING"))," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"txHash"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"electionId"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,i.kt)("a",{parentName:"p",href:"enums/ElectionCreationSteps#done"},(0,i.kt)("inlineCode",{parentName:"a"},"DONE"))," }"),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L50"},"services/election.ts:50")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electionidoption"},"ElectionIdOption"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ElectionIdOption"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-10"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionId")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/client/account.ts#L5"},"types/client/account.ts:5")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electionkeys"},"ElectionKeys"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ElectionKeys"),": ",(0,i.kt)("a",{parentName:"p",href:"interfaces/IElectionKeysResponse"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionKeysResponse"))),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L36"},"services/election.ts:36")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electionmeta"},"ElectionMeta"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ElectionMeta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"AnyJson")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"JsonArray")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"JsonMap")),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L101"},"types/election/election.ts:101")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electionresultstype"},"ElectionResultsType"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ElectionResultsType"),": ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionResultsTypeNames#single_choice_multiquestion"},(0,i.kt)("inlineCode",{parentName:"a"},"SINGLE_CHOICE_MULTIQUESTION"))," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"properties"),": {} } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionResultsTypeNames#multiple_choice"},(0,i.kt)("inlineCode",{parentName:"a"},"MULTIPLE_CHOICE"))," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"properties"),": ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"abstainValues"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,i.kt)("inlineCode",{parentName:"p"},"canAbstain"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"repeatChoice"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," } } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionResultsTypeNames#budget"},(0,i.kt)("inlineCode",{parentName:"a"},"BUDGET"))," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"properties"),": ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"forceFullBudget"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"maxBudget"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"minStep"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"useCensusWeightAsBudget"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," } } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,i.kt)("a",{parentName:"p",href:"enums/ElectionResultsTypeNames#approval"},(0,i.kt)("inlineCode",{parentName:"a"},"APPROVAL"))," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"properties"),": ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"acceptValue"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"rejectValue"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," } }"),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L44"},"types/metadata/election.ts:44")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"faucetoptions"},"FaucetOptions"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"FaucetOptions"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"FaucetServiceParameters")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/faucet.ts#L28"},"services/faucet.ts:28")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"faucetpackage"},"FaucetPackage"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"FaucetPackage"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-11"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"payload")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"signature")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/faucet.ts#L23"},"services/faucet.ts:23")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"hasalreadyvotedoptions"},"HasAlreadyVotedOptions"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"HasAlreadyVotedOptions"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Partial"),"\\<",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules#walletoption"},(0,i.kt)("inlineCode",{parentName:"a"},"WalletOption"))," & ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules#electionidoption"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionIdOption"))," & ",(0,i.kt)("a",{parentName:"p",href:"modules#voteidoption"},(0,i.kt)("inlineCode",{parentName:"a"},"VoteIdOption")),">"),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/client/account.ts#L10"},"types/client/account.ts:10")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"iaccountsummary"},"IAccountSummary"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"IAccountSummary"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Pick"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"IAccountInfoResponse"),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"address"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"balance"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"nonce"'),">"),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L17"},"api/account.ts:17")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ibudgetelectionparameters"},"IBudgetElectionParameters"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"IBudgetElectionParameters"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight"},(0,i.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParametersWithCensusWeight"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"interfaces/IBudgetElectionParametersWithBudget"},(0,i.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParametersWithBudget"))),(0,i.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L21"},"types/election/budget.ts:21")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"isabletovoteoptions"},"IsAbleToVoteOptions"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"IsAbleToVoteOptions"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Partial"),"\\<",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules#walletoption"},(0,i.kt)("inlineCode",{parentName:"a"},"WalletOption"))," & ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules#electionidoption"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionIdOption"))," & ",(0,i.kt)("a",{parentName:"p",href:"modules#voteidoption"},(0,i.kt)("inlineCode",{parentName:"a"},"VoteIdOption")),">"),(0,i.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/client/account.ts#L12"},"types/client/account.ts:12")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"isincensusoptions"},"IsInCensusOptions"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"IsInCensusOptions"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Partial"),"\\<",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules#walletoption"},(0,i.kt)("inlineCode",{parentName:"a"},"WalletOption"))," & ",(0,i.kt)("a",{parentName:"p",href:"modules#electionidoption"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionIdOption")),">"),(0,i.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/client/account.ts#L9"},"types/client/account.ts:9")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"parsedpredicate"},"ParsedPredicate"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ParsedPredicate"),": ",(0,i.kt)("a",{parentName:"p",href:"interfaces/ICensus3ValidatePredicateResponse"},(0,i.kt)("inlineCode",{parentName:"a"},"ICensus3ValidatePredicateResponse"))),(0,i.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L33"},"census3.ts:33")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sendtokensoptions"},"SendTokensOptions"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"SendTokensOptions"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Partial"),"\\<",(0,i.kt)("a",{parentName:"p",href:"modules#walletoption"},(0,i.kt)("inlineCode",{parentName:"a"},"WalletOption")),">"," & ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"amount"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"to"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," }"),(0,i.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/client/account.ts#L8"},"types/client/account.ts:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"strategy"},"Strategy"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"Strategy"),": ",(0,i.kt)("a",{parentName:"p",href:"modules#census3strategy"},(0,i.kt)("inlineCode",{parentName:"a"},"Census3Strategy"))),(0,i.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L26"},"census3.ts:26")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"strategyholder"},"StrategyHolder"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"StrategyHolder"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-12"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"holder")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"weight")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,i.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L27"},"census3.ts:27")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"strategyholders"},"StrategyHolders"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"StrategyHolders"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-13"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"holders")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"modules#strategyholder"},(0,i.kt)("inlineCode",{parentName:"a"},"StrategyHolder")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"pagination")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Census3Pagination"))))),(0,i.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L28"},"census3.ts:28")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"strategytoken"},"StrategyToken"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"StrategyToken"),": ",(0,i.kt)("a",{parentName:"p",href:"modules#census3createstrategytoken"},(0,i.kt)("inlineCode",{parentName:"a"},"Census3CreateStrategyToken"))),(0,i.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L29"},"census3.ts:29")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"supportedchain"},"SupportedChain"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"SupportedChain"),": ",(0,i.kt)("a",{parentName:"p",href:"interfaces/ICensus3SupportedChain"},(0,i.kt)("inlineCode",{parentName:"a"},"ICensus3SupportedChain"))),(0,i.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L31"},"census3.ts:31")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"supportedoperator"},"SupportedOperator"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"SupportedOperator"),": ",(0,i.kt)("a",{parentName:"p",href:"interfaces/ICensus3StrategiesOperator"},(0,i.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesOperator"))),(0,i.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L32"},"census3.ts:32")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"token"},"Token"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"Token"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Omit"),"\\<",(0,i.kt)("a",{parentName:"p",href:"modules#census3token"},(0,i.kt)("inlineCode",{parentName:"a"},"Census3Token")),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"tags"'),">"," & ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"tags"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[] }"),(0,i.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L24"},"census3.ts:24")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tokensummary"},"TokenSummary"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"TokenSummary"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Omit"),"\\<",(0,i.kt)("a",{parentName:"p",href:"modules#census3summarytoken"},(0,i.kt)("inlineCode",{parentName:"a"},"Census3SummaryToken")),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"tags"'),">"," & ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"tags"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[] }"),(0,i.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L25"},"census3.ts:25")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"txwaitoptions"},"TxWaitOptions"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"TxWaitOptions"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("p",null,"Specify custom retry times and attempts when waiting for a transaction."),(0,i.kt)("h4",{id:"type-declaration-14"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"attempts")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"retryTime")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/chain.ts#L24"},"services/chain.ts:24")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"voteidoption"},"VoteIdOption"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"VoteIdOption"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-15"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"voteId")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/client/account.ts#L6"},"types/client/account.ts:6")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"voteinfo"},"VoteInfo"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"VoteInfo"),": ",(0,i.kt)("a",{parentName:"p",href:"interfaces/IVoteInfoResponse"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteInfoResponse"))),(0,i.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/vote.ts#L15"},"services/vote.ts:15")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votestepvalue"},"VoteStepValue"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"VoteStepValue"),": ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"electionId"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/VoteSteps#get_election"},(0,i.kt)("inlineCode",{parentName:"a"},"GET_ELECTION"))," } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/VoteSteps#get_proof"},(0,i.kt)("inlineCode",{parentName:"a"},"GET_PROOF"))," } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/VoteSteps#get_signature"},(0,i.kt)("inlineCode",{parentName:"a"},"GET_SIGNATURE"))," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"signature"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/VoteSteps#calc_zk_proof"},(0,i.kt)("inlineCode",{parentName:"a"},"CALC_ZK_PROOF"))," } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/VoteSteps#generate_tx"},(0,i.kt)("inlineCode",{parentName:"a"},"GENERATE_TX"))," } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/VoteSteps#sign_tx"},(0,i.kt)("inlineCode",{parentName:"a"},"SIGN_TX"))," } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,i.kt)("a",{parentName:"p",href:"enums/VoteSteps#done"},(0,i.kt)("inlineCode",{parentName:"a"},"DONE"))," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"voteId"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," }"),(0,i.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/vote.ts#L28"},"services/vote.ts:28")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votesubmit"},"VoteSubmit"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"VoteSubmit"),": ",(0,i.kt)("a",{parentName:"p",href:"interfaces/IVoteSubmitResponse"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteSubmitResponse"))),(0,i.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/vote.ts#L16"},"services/vote.ts:16")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votesleftcountoptions"},"VotesLeftCountOptions"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"VotesLeftCountOptions"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Partial"),"\\<",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules#walletoption"},(0,i.kt)("inlineCode",{parentName:"a"},"WalletOption"))," & ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules#electionidoption"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionIdOption"))," & ",(0,i.kt)("a",{parentName:"p",href:"modules#voteidoption"},(0,i.kt)("inlineCode",{parentName:"a"},"VoteIdOption")),">"),(0,i.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/client/account.ts#L11"},"types/client/account.ts:11")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"walletoption"},"WalletOption"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"WalletOption"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-16"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wallet")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"Signer"))))),(0,i.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/client/account.ts#L4"},"types/client/account.ts:4")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"zkproof"},"ZkProof"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ZkProof"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-17"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"proof")),(0,i.kt)("td",{parentName:"tr",align:"left"},"{"," ",(0,i.kt)("inlineCode",{parentName:"td"},"curve"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"pi_a"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string"),"[] ; ",(0,i.kt)("inlineCode",{parentName:"td"},"pi_b"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string"),"[][]"," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"pi_c"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string"),"[] ; ",(0,i.kt)("inlineCode",{parentName:"td"},"protocol"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"proof.curve")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"proof.pi_a")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"proof.pi_b")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"),"[][]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"proof.pi_c")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"proof.protocol")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"publicSignals")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"),"[]")))),(0,i.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/anonymous.ts#L23"},"services/anonymous.ts:23")),(0,i.kt)("h2",{id:"variables-1"},"Variables"),(0,i.kt)("h3",{id:"accountmetadatatemplate"},"AccountMetadataTemplate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"AccountMetadataTemplate"),": ",(0,i.kt)("a",{parentName:"p",href:"interfaces/AccountMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountMetadata"))),(0,i.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/account.ts#L67"},"types/metadata/account.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electionmetadatatemplate"},"ElectionMetadataTemplate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"ElectionMetadataTemplate"),": ",(0,i.kt)("a",{parentName:"p",href:"interfaces/ElectionMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,i.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L140"},"types/metadata/election.ts:140")),(0,i.kt)("h2",{id:"functions-1"},"Functions"),(0,i.kt)("h3",{id:"areequalhexstrings"},"areEqualHexStrings"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"areEqualHexStrings"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"hex1?"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"hex2?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Compares two hex strings checking if they're the same. It ensures both\nhave hex prefix and are lowercase."),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"hex1?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"hex2?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/util/common.ts#L36"},"util/common.ts:36")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"checkvalidaccountmetadata"},"checkValidAccountMetadata"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"checkValidAccountMetadata"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"accountMetadata"),"): ",(0,i.kt)("a",{parentName:"p",href:"interfaces/AccountMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountMetadata"))),(0,i.kt)("p",null,"Asserts that the given metadata is valid.\nThrows an exception if it is not."),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"accountMetadata")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"interfaces/AccountMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountMetadata")))))),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"interfaces/AccountMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountMetadata"))),(0,i.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/account.ts#L8"},"types/metadata/account.ts:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"checkvalidelectionmetadata"},"checkValidElectionMetadata"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"checkValidElectionMetadata"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionMetadata"),"): ",(0,i.kt)("a",{parentName:"p",href:"interfaces/ElectionMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,i.kt)("p",null,"Asserts that the given metadata is valid.\nThrows an exception if it is not."),(0,i.kt)("h4",{id:"parameters-2"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionMetadata")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"interfaces/ElectionMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionMetadata")))))),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"interfaces/ElectionMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,i.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L8"},"types/metadata/election.ts:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"delay"},"delay"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"delay"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"ms"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("h4",{id:"parameters-3"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ms")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/util/common.ts#L6"},"util/common.ts:6")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"dotobject"},"dotobject"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"dotobject"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"obj"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"dot"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("p",null,"Dot notation to object conversion. Takes any object as first argument and uses the string dot notation from the\nsecond argument (i.e. 'a.child.node') to access that given object value."),(0,i.kt)("h4",{id:"parameters-4"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"obj")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any")),(0,i.kt)("td",{parentName:"tr",align:"left"},"Object to be accessed by dot notation")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"dot")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"Dot notation string to extract object data")))),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("p",null,"Return the object data"),(0,i.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/util/common.ts#L61"},"util/common.ts:61")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ensure0x"},"ensure0x"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"ensure0x"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-5"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/util/common.ts#L12"},"util/common.ts:12")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"formatunits"},"formatUnits"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"formatUnits"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"decimals?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Returns a string representation of value formatted with decimals digits"),(0,i.kt)("h4",{id:"parameters-6"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"BigNumberish")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"undefined")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The value in native BigInt")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"decimals")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"18")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The number of decimals")))),(0,i.kt)("h4",{id:"returns-6"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The formatted string"),(0,i.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/util/common.ts#L49"},"util/common.ts:49")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getbytes"},"getBytes"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"getBytes"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"count"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,i.kt)("h4",{id:"parameters-7"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"count")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-7"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,i.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/util/common.ts#L16"},"util/common.ts:16")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"gethex"},"getHex"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"getHex"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,'Generates a random seed and returns a 32 byte keccak256 hash of it (starting with "0x")'),(0,i.kt)("h4",{id:"returns-8"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/util/common.ts#L23"},"util/common.ts:23")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"strip0x"},"strip0x"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"strip0x"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-8"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-9"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/util/common.ts#L8"},"util/common.ts:8")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8a92166d.93f44f23.js b/assets/js/8a92166d.a038b97f.js similarity index 87% rename from assets/js/8a92166d.93f44f23.js rename to assets/js/8a92166d.a038b97f.js index f74ed68dd..6c29c7327 100644 --- a/assets/js/8a92166d.93f44f23.js +++ b/assets/js/8a92166d.a038b97f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6689],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},s=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,l=e.parentName,s=c(e,["components","mdxType","originalType","parentName"]),f=p(n),u=i,y=f["".concat(l,".").concat(u)]||f[u]||d[u]||o;return n?r.createElement(y,a(a({ref:t},s),{},{components:n})):r.createElement(y,a({ref:t},s))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,a=new Array(o);a[0]=f;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c.mdxType="string"==typeof e?e:i,a[1]=c;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>p});var r=n(87462),i=(n(67294),n(3905));const o={},a=void 0,c={unversionedId:"sdk/reference/interfaces/IEncryptionKey",id:"sdk/reference/interfaces/IEncryptionKey",title:"IEncryptionKey",description:"@vocdoni/sdk / Exports / IEncryptionKey",source:"@site/docs/sdk/reference/interfaces/IEncryptionKey.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IEncryptionKey",permalink:"/sdk/reference/interfaces/IEncryptionKey",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionVoteListResponse",permalink:"/sdk/reference/interfaces/IElectionVoteListResponse"},next:{title:"IInvalidElectionParameters",permalink:"/sdk/reference/interfaces/IInvalidElectionParameters"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"index",id:"index",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"key",id:"key",level:3},{value:"Defined in",id:"defined-in-1",level:4}],s={toc:p};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IEncryptionKey"),(0,i.kt)("h1",{id:"interface-iencryptionkey"},"Interface: IEncryptionKey"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IEncryptionKey#index"},"index")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IEncryptionKey#key"},"key"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"index"},"index"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"index"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The index of the encryption key"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L257"},"api/election.ts:257")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"key"},"key"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"key"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The encryption key"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L262"},"api/election.ts:262")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6689],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},s=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,l=e.parentName,s=c(e,["components","mdxType","originalType","parentName"]),f=p(n),u=i,y=f["".concat(l,".").concat(u)]||f[u]||d[u]||o;return n?r.createElement(y,a(a({ref:t},s),{},{components:n})):r.createElement(y,a({ref:t},s))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,a=new Array(o);a[0]=f;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c.mdxType="string"==typeof e?e:i,a[1]=c;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>p});var r=n(87462),i=(n(67294),n(3905));const o={},a=void 0,c={unversionedId:"sdk/reference/interfaces/IEncryptionKey",id:"sdk/reference/interfaces/IEncryptionKey",title:"IEncryptionKey",description:"@vocdoni/sdk / Exports / IEncryptionKey",source:"@site/docs/sdk/reference/interfaces/IEncryptionKey.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IEncryptionKey",permalink:"/sdk/reference/interfaces/IEncryptionKey",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionVoteListResponse",permalink:"/sdk/reference/interfaces/IElectionVoteListResponse"},next:{title:"IInvalidElectionParameters",permalink:"/sdk/reference/interfaces/IInvalidElectionParameters"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"index",id:"index",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"key",id:"key",level:3},{value:"Defined in",id:"defined-in-1",level:4}],s={toc:p};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IEncryptionKey"),(0,i.kt)("h1",{id:"interface-iencryptionkey"},"Interface: IEncryptionKey"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IEncryptionKey#index"},"index")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IEncryptionKey#key"},"key"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"index"},"index"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"index"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The index of the encryption key"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L257"},"api/election.ts:257")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"key"},"key"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"key"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The encryption key"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L262"},"api/election.ts:262")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8b196d05.2331f865.js b/assets/js/8b196d05.2331f865.js deleted file mode 100644 index bbce97976..000000000 --- a/assets/js/8b196d05.2331f865.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1806],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>f});var s=t(67294);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);n&&(s=s.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,s)}return t}function a(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(s=0;s=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var l=s.createContext({}),u=function(e){var n=s.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},c=function(e){var n=u(e.components);return s.createElement(l.Provider,{value:n},e.children)},p={inlineCode:"code",wrapper:function(e){var n=e.children;return s.createElement(s.Fragment,{},n)}},d=s.forwardRef((function(e,n){var t=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=u(t),f=r,k=d["".concat(l,".").concat(f)]||d[f]||p[f]||i;return t?s.createElement(k,a(a({ref:n},c),{},{components:t})):s.createElement(k,a({ref:n},c))}));function f(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var i=t.length,a=new Array(i);a[0]=d;var o={};for(var l in n)hasOwnProperty.call(n,l)&&(o[l]=n[l]);o.originalType=e,o.mdxType="string"==typeof e?e:r,a[1]=o;for(var u=2;u{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>u});var s=t(87462),r=(t(67294),t(3905));const i={},a=void 0,o={unversionedId:"sdk/reference/interfaces/ICensus3CensusResponse",id:"sdk/reference/interfaces/ICensus3CensusResponse",title:"ICensus3CensusResponse",description:"@vocdoni/sdk / Exports / ICensus3CensusResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3CensusResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3CensusResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3CensusQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusQueueResponse"},next:{title:"ICensus3ServiceInfoResponse",permalink:"/sdk/reference/interfaces/ICensus3ServiceInfoResponse"}},l={},u=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"ID",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"accuracy",id:"accuracy",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"anonymous",id:"anonymous",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"merkleRoot",id:"merkleroot",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"size",id:"size",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"strategyID",id:"strategyid",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"uri",id:"uri",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"weight",id:"weight",level:3},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:u};function p(e){let{components:n,...t}=e;return(0,r.kt)("wrapper",(0,s.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3CensusResponse"),(0,r.kt)("h1",{id:"interface-icensus3censusresponse"},"Interface: ICensus3CensusResponse"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3CensusResponse#id"},"ID")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3CensusResponse#accuracy"},"accuracy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3CensusResponse#anonymous"},"anonymous")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3CensusResponse#merkleroot"},"merkleRoot")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3CensusResponse#size"},"size")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3CensusResponse#strategyid"},"strategyID")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3CensusResponse#uri"},"uri")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3CensusResponse#weight"},"weight"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"id"},"ID"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ID"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The identifier of the census"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L22"},"api/census3/census.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"accuracy"},"accuracy"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"accuracy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The accuracy for an anonymous census"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L57"},"api/census3/census.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"anonymous"},"anonymous"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"anonymous"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"If the census is anonymous or not"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L52"},"api/census3/census.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"merkleroot"},"merkleRoot"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"merkleRoot"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The root of the census"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L32"},"api/census3/census.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"size"},"size"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"size"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The size of the census (number of token holders)"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L42"},"api/census3/census.ts:42")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"strategyid"},"strategyID"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"strategyID"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The identifier of the strategy of the built census"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L27"},"api/census3/census.ts:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"uri"},"uri"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"uri"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The URI of the census"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L37"},"api/census3/census.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"weight"},"weight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"weight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The weight of the census (weight of all token holders)"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L47"},"api/census3/census.ts:47")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8b196d05.5e1dfbac.js b/assets/js/8b196d05.5e1dfbac.js new file mode 100644 index 000000000..a6f555ffd --- /dev/null +++ b/assets/js/8b196d05.5e1dfbac.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1806],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>f});var s=t(67294);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);n&&(s=s.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,s)}return t}function a(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(s=0;s=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var l=s.createContext({}),u=function(e){var n=s.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},p=function(e){var n=u(e.components);return s.createElement(l.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return s.createElement(s.Fragment,{},n)}},d=s.forwardRef((function(e,n){var t=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),d=u(t),f=r,k=d["".concat(l,".").concat(f)]||d[f]||c[f]||i;return t?s.createElement(k,a(a({ref:n},p),{},{components:t})):s.createElement(k,a({ref:n},p))}));function f(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var i=t.length,a=new Array(i);a[0]=d;var o={};for(var l in n)hasOwnProperty.call(n,l)&&(o[l]=n[l]);o.originalType=e,o.mdxType="string"==typeof e?e:r,a[1]=o;for(var u=2;u{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>u});var s=t(87462),r=(t(67294),t(3905));const i={},a=void 0,o={unversionedId:"sdk/reference/interfaces/ICensus3CensusResponse",id:"sdk/reference/interfaces/ICensus3CensusResponse",title:"ICensus3CensusResponse",description:"@vocdoni/sdk / Exports / ICensus3CensusResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3CensusResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3CensusResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3CensusQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusQueueResponse"},next:{title:"ICensus3ServiceInfoResponse",permalink:"/sdk/reference/interfaces/ICensus3ServiceInfoResponse"}},l={},u=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"ID",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"accuracy",id:"accuracy",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"anonymous",id:"anonymous",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"merkleRoot",id:"merkleroot",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"size",id:"size",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"strategyID",id:"strategyid",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"uri",id:"uri",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"weight",id:"weight",level:3},{value:"Defined in",id:"defined-in-7",level:4}],p={toc:u};function c(e){let{components:n,...t}=e;return(0,r.kt)("wrapper",(0,s.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3CensusResponse"),(0,r.kt)("h1",{id:"interface-icensus3censusresponse"},"Interface: ICensus3CensusResponse"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ICensus3CensusResponse#id"},"ID")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ICensus3CensusResponse#accuracy"},"accuracy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ICensus3CensusResponse#anonymous"},"anonymous")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ICensus3CensusResponse#merkleroot"},"merkleRoot")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ICensus3CensusResponse#size"},"size")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ICensus3CensusResponse#strategyid"},"strategyID")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ICensus3CensusResponse#uri"},"uri")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ICensus3CensusResponse#weight"},"weight"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"id"},"ID"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ID"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The identifier of the census"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L22"},"api/census3/census.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"accuracy"},"accuracy"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"accuracy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The accuracy for an anonymous census"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L57"},"api/census3/census.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"anonymous"},"anonymous"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"anonymous"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"If the census is anonymous or not"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L52"},"api/census3/census.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"merkleroot"},"merkleRoot"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"merkleRoot"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The root of the census"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L32"},"api/census3/census.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"size"},"size"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"size"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The size of the census (number of token holders)"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L42"},"api/census3/census.ts:42")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"strategyid"},"strategyID"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"strategyID"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The identifier of the strategy of the built census"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L27"},"api/census3/census.ts:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"uri"},"uri"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"uri"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The URI of the census"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L37"},"api/census3/census.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"weight"},"weight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"weight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The weight of the census (weight of all token holders)"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L47"},"api/census3/census.ts:47")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8ec8cf1f.c3f3c12a.js b/assets/js/8ec8cf1f.d9af2318.js similarity index 93% rename from assets/js/8ec8cf1f.c3f3c12a.js rename to assets/js/8ec8cf1f.d9af2318.js index 6dd3a3d1e..673956f0c 100644 --- a/assets/js/8ec8cf1f.c3f3c12a.js +++ b/assets/js/8ec8cf1f.d9af2318.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8399],{3905:(e,r,t)=>{t.d(r,{Zo:()=>u,kt:()=>m});var n=t(67294);function o(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function s(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function a(e){for(var r=1;r=0||(o[t]=e[t]);return o}(e,r);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var p=n.createContext({}),i=function(e){var r=n.useContext(p),t=r;return e&&(t="function"==typeof e?e(r):a(a({},r),e)),t},u=function(e){var r=i(e.components);return n.createElement(p.Provider,{value:r},e.children)},f={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},l=n.forwardRef((function(e,r){var t=e.components,o=e.mdxType,s=e.originalType,p=e.parentName,u=c(e,["components","mdxType","originalType","parentName"]),l=i(t),m=o,d=l["".concat(p,".").concat(m)]||l[m]||f[m]||s;return t?n.createElement(d,a(a({ref:r},u),{},{components:t})):n.createElement(d,a({ref:r},u))}));function m(e,r){var t=arguments,o=r&&r.mdxType;if("string"==typeof e||o){var s=t.length,a=new Array(s);a[0]=l;var c={};for(var p in r)hasOwnProperty.call(r,p)&&(c[p]=r[p]);c.originalType=e,c.mdxType="string"==typeof e?e:o,a[1]=c;for(var i=2;i{t.r(r),t.d(r,{assets:()=>p,contentTitle:()=>a,default:()=>f,frontMatter:()=>s,metadata:()=>c,toc:()=>i});var n=t(87462),o=(t(67294),t(3905));const s={},a=void 0,c={unversionedId:"sdk/reference/interfaces/ICensusImportResponse",id:"sdk/reference/interfaces/ICensusImportResponse",title:"ICensusImportResponse",description:"@vocdoni/sdk / Exports / ICensusImportResponse",source:"@site/docs/sdk/reference/interfaces/ICensusImportResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensusImportResponse",permalink:"/sdk/reference/interfaces/ICensusImportResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensusExportResponse",permalink:"/sdk/reference/interfaces/ICensusExportResponse"},next:{title:"ICensusParticipant",permalink:"/sdk/reference/interfaces/ICensusParticipant"}},p={},i=[],u={toc:i};function f(e){let{components:r,...t}=e;return(0,o.kt)("wrapper",(0,n.Z)({},u,t,{components:r,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensusImportResponse"),(0,o.kt)("h1",{id:"interface-icensusimportresponse"},"Interface: ICensusImportResponse"))}f.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8399],{3905:(e,r,t)=>{t.d(r,{Zo:()=>u,kt:()=>m});var n=t(67294);function o(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function s(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function a(e){for(var r=1;r=0||(o[t]=e[t]);return o}(e,r);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var p=n.createContext({}),i=function(e){var r=n.useContext(p),t=r;return e&&(t="function"==typeof e?e(r):a(a({},r),e)),t},u=function(e){var r=i(e.components);return n.createElement(p.Provider,{value:r},e.children)},f={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},l=n.forwardRef((function(e,r){var t=e.components,o=e.mdxType,s=e.originalType,p=e.parentName,u=c(e,["components","mdxType","originalType","parentName"]),l=i(t),m=o,d=l["".concat(p,".").concat(m)]||l[m]||f[m]||s;return t?n.createElement(d,a(a({ref:r},u),{},{components:t})):n.createElement(d,a({ref:r},u))}));function m(e,r){var t=arguments,o=r&&r.mdxType;if("string"==typeof e||o){var s=t.length,a=new Array(s);a[0]=l;var c={};for(var p in r)hasOwnProperty.call(r,p)&&(c[p]=r[p]);c.originalType=e,c.mdxType="string"==typeof e?e:o,a[1]=c;for(var i=2;i{t.r(r),t.d(r,{assets:()=>p,contentTitle:()=>a,default:()=>f,frontMatter:()=>s,metadata:()=>c,toc:()=>i});var n=t(87462),o=(t(67294),t(3905));const s={},a=void 0,c={unversionedId:"sdk/reference/interfaces/ICensusImportResponse",id:"sdk/reference/interfaces/ICensusImportResponse",title:"ICensusImportResponse",description:"@vocdoni/sdk / Exports / ICensusImportResponse",source:"@site/docs/sdk/reference/interfaces/ICensusImportResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensusImportResponse",permalink:"/sdk/reference/interfaces/ICensusImportResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensusExportResponse",permalink:"/sdk/reference/interfaces/ICensusExportResponse"},next:{title:"ICensusParticipant",permalink:"/sdk/reference/interfaces/ICensusParticipant"}},p={},i=[],u={toc:i};function f(e){let{components:r,...t}=e;return(0,o.kt)("wrapper",(0,n.Z)({},u,t,{components:r,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensusImportResponse"),(0,o.kt)("h1",{id:"interface-icensusimportresponse"},"Interface: ICensusImportResponse"))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8ed7db60.16b12d78.js b/assets/js/8ed7db60.16b12d78.js deleted file mode 100644 index 091435e53..000000000 --- a/assets/js/8ed7db60.16b12d78.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2931],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>u});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),p=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},l=function(e){var t=p(e.components);return n.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),f=p(r),u=a,k=f["".concat(c,".").concat(u)]||f[u]||d[u]||o;return r?n.createElement(k,i(i({ref:t},l),{},{components:r})):n.createElement(k,i({ref:t},l))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=f;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s.mdxType="string"==typeof e?e:a,i[1]=s;for(var p=2;p{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var n=r(87462),a=(r(67294),r(3905));const o={},i=void 0,s={unversionedId:"sdk/reference/interfaces/NewProcessTx",id:"sdk/reference/interfaces/NewProcessTx",title:"NewProcessTx",description:"@vocdoni/sdk / Exports / NewProcessTx",source:"@site/docs/sdk/reference/interfaces/NewProcessTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/NewProcessTx",permalink:"/sdk/reference/interfaces/NewProcessTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"MintTokensTx",permalink:"/sdk/reference/interfaces/MintTokensTx"},next:{title:"Process",permalink:"/sdk/reference/interfaces/Process"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"process",id:"process",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"txtype",id:"txtype",level:3},{value:"Defined in",id:"defined-in-2",level:4}],l={toc:p};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / NewProcessTx"),(0,a.kt)("h1",{id:"interface-newprocesstx"},"Interface: NewProcessTx"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/NewProcessTx#nonce"},"nonce")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/NewProcessTx#process"},"process")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/NewProcessTx#txtype"},"txtype"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"nonce"},"nonce"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"nonce"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L85"},"api/chain/transactions.ts:85")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"process"},"process"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"process"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/Process"},(0,a.kt)("inlineCode",{parentName:"a"},"Process"))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L86"},"api/chain/transactions.ts:86")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"txtype"},"txtype"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"txtype"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/TxType"},(0,a.kt)("inlineCode",{parentName:"a"},"TxType"))),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L84"},"api/chain/transactions.ts:84")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8ed7db60.73b6812e.js b/assets/js/8ed7db60.73b6812e.js new file mode 100644 index 000000000..f6f609c25 --- /dev/null +++ b/assets/js/8ed7db60.73b6812e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2931],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>u});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var c=r.createContext({}),p=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},l=function(e){var t=p(e.components);return r.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),f=p(n),u=o,k=f["".concat(c,".").concat(u)]||f[u]||d[u]||a;return n?r.createElement(k,i(i({ref:t},l),{},{components:n})):r.createElement(k,i({ref:t},l))}));function u(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,i=new Array(a);i[0]=f;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s.mdxType="string"==typeof e?e:o,i[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>a,metadata:()=>s,toc:()=>p});var r=n(87462),o=(n(67294),n(3905));const a={},i=void 0,s={unversionedId:"sdk/reference/interfaces/NewProcessTx",id:"sdk/reference/interfaces/NewProcessTx",title:"NewProcessTx",description:"@vocdoni/sdk / Exports / NewProcessTx",source:"@site/docs/sdk/reference/interfaces/NewProcessTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/NewProcessTx",permalink:"/sdk/reference/interfaces/NewProcessTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"MintTokensTx",permalink:"/sdk/reference/interfaces/MintTokensTx"},next:{title:"Process",permalink:"/sdk/reference/interfaces/Process"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"process",id:"process",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"txtype",id:"txtype",level:3},{value:"Defined in",id:"defined-in-2",level:4}],l={toc:p};function d(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / NewProcessTx"),(0,o.kt)("h1",{id:"interface-newprocesstx"},"Interface: NewProcessTx"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"NewProcessTx#nonce"},"nonce")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"NewProcessTx#process"},"process")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"NewProcessTx#txtype"},"txtype"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"nonce"},"nonce"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"nonce"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L85"},"api/chain/transactions.ts:85")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"process"},"process"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"process"),": ",(0,o.kt)("a",{parentName:"p",href:"Process"},(0,o.kt)("inlineCode",{parentName:"a"},"Process"))),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L86"},"api/chain/transactions.ts:86")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"txtype"},"txtype"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"txtype"),": ",(0,o.kt)("a",{parentName:"p",href:"../enums/TxType"},(0,o.kt)("inlineCode",{parentName:"a"},"TxType"))),(0,o.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L84"},"api/chain/transactions.ts:84")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9029ef47.0b33d0bc.js b/assets/js/9029ef47.0b33d0bc.js deleted file mode 100644 index b80c0f465..000000000 --- a/assets/js/9029ef47.0b33d0bc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1126],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=r.createContext({}),l=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=l(e.components);return r.createElement(c.Provider,{value:t},e.children)},f={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,c=e.parentName,p=a(e,["components","mdxType","originalType","parentName"]),d=l(n),u=i,y=d["".concat(c,".").concat(u)]||d[u]||f[u]||o;return n?r.createElement(y,s(s({ref:t},p),{},{components:n})):r.createElement(y,s({ref:t},p))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,s=new Array(o);s[0]=d;var a={};for(var c in t)hasOwnProperty.call(t,c)&&(a[c]=t[c]);a.originalType=e,a.mdxType="string"==typeof e?e:i,s[1]=a;for(var l=2;l{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>f,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var r=n(87462),i=(n(67294),n(3905));const o={},s=void 0,a={unversionedId:"sdk/reference/interfaces/IElectionKeysResponse",id:"sdk/reference/interfaces/IElectionKeysResponse",title:"IElectionKeysResponse",description:"@vocdoni/sdk / Exports / IElectionKeysResponse",source:"@site/docs/sdk/reference/interfaces/IElectionKeysResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionKeysResponse",permalink:"/sdk/reference/interfaces/IElectionKeysResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionInfoResponse",permalink:"/sdk/reference/interfaces/IElectionInfoResponse"},next:{title:"IElectionListFilter",permalink:"/sdk/reference/interfaces/IElectionListFilter"}},c={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"privateKeys",id:"privatekeys",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"publicKeys",id:"publickeys",level:3},{value:"Defined in",id:"defined-in-1",level:4}],p={toc:l};function f(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IElectionKeysResponse"),(0,i.kt)("h1",{id:"interface-ielectionkeysresponse"},"Interface: IElectionKeysResponse"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionKeysResponse#privatekeys"},"privateKeys")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionKeysResponse#publickeys"},"publicKeys"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"privatekeys"},"privateKeys"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"privateKeys"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IEncryptionKey"},(0,i.kt)("inlineCode",{parentName:"a"},"IEncryptionKey")),"[]"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L267"},"api/election.ts:267")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"publickeys"},"publicKeys"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"publicKeys"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IEncryptionKey"},(0,i.kt)("inlineCode",{parentName:"a"},"IEncryptionKey")),"[]"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L266"},"api/election.ts:266")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9029ef47.13410411.js b/assets/js/9029ef47.13410411.js new file mode 100644 index 000000000..fb3353da6 --- /dev/null +++ b/assets/js/9029ef47.13410411.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1126],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>u});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},f={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=p(n),u=i,y=d["".concat(l,".").concat(u)]||d[u]||f[u]||o;return n?r.createElement(y,a(a({ref:t},c),{},{components:n})):r.createElement(y,a({ref:t},c))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,a=new Array(o);a[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:i,a[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>f,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var r=n(87462),i=(n(67294),n(3905));const o={},a=void 0,s={unversionedId:"sdk/reference/interfaces/IElectionKeysResponse",id:"sdk/reference/interfaces/IElectionKeysResponse",title:"IElectionKeysResponse",description:"@vocdoni/sdk / Exports / IElectionKeysResponse",source:"@site/docs/sdk/reference/interfaces/IElectionKeysResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionKeysResponse",permalink:"/sdk/reference/interfaces/IElectionKeysResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionInfoResponse",permalink:"/sdk/reference/interfaces/IElectionInfoResponse"},next:{title:"IElectionListFilter",permalink:"/sdk/reference/interfaces/IElectionListFilter"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"privateKeys",id:"privatekeys",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"publicKeys",id:"publickeys",level:3},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:p};function f(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IElectionKeysResponse"),(0,i.kt)("h1",{id:"interface-ielectionkeysresponse"},"Interface: IElectionKeysResponse"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IElectionKeysResponse#privatekeys"},"privateKeys")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IElectionKeysResponse#publickeys"},"publicKeys"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"privatekeys"},"privateKeys"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"privateKeys"),": ",(0,i.kt)("a",{parentName:"p",href:"IEncryptionKey"},(0,i.kt)("inlineCode",{parentName:"a"},"IEncryptionKey")),"[]"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L267"},"api/election.ts:267")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"publickeys"},"publicKeys"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"publicKeys"),": ",(0,i.kt)("a",{parentName:"p",href:"IEncryptionKey"},(0,i.kt)("inlineCode",{parentName:"a"},"IEncryptionKey")),"[]"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L266"},"api/election.ts:266")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/92348782.250b24cd.js b/assets/js/92348782.dbbda37f.js similarity index 65% rename from assets/js/92348782.250b24cd.js rename to assets/js/92348782.dbbda37f.js index f1878cdfb..366ac9860 100644 --- a/assets/js/92348782.250b24cd.js +++ b/assets/js/92348782.dbbda37f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9940],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>k});var r=t(67294);function s(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(s[t]=e[t]);return s}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(s[t]=e[t])}return s}var p=r.createContext({}),l=function(e){var n=r.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},c=function(e){var n=l(e.components);return r.createElement(p.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,s=e.mdxType,a=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=l(t),k=s,f=d["".concat(p,".").concat(k)]||d[k]||u[k]||a;return t?r.createElement(f,i(i({ref:n},c),{},{components:t})):r.createElement(f,i({ref:n},c))}));function k(e,n){var t=arguments,s=n&&n.mdxType;if("string"==typeof e||s){var a=t.length,i=new Array(a);i[0]=d;var o={};for(var p in n)hasOwnProperty.call(n,p)&&(o[p]=n[p]);o.originalType=e,o.mdxType="string"==typeof e?e:s,i[1]=o;for(var l=2;l{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>i,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var r=t(87462),s=(t(67294),t(3905));const a={},i=void 0,o={unversionedId:"sdk/reference/interfaces/ICensus3TokenListResponsePaginated",id:"sdk/reference/interfaces/ICensus3TokenListResponsePaginated",title:"ICensus3TokenListResponsePaginated",description:"@vocdoni/sdk / Exports / ICensus3TokenListResponsePaginated",source:"@site/docs/sdk/reference/interfaces/ICensus3TokenListResponsePaginated.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3TokenListResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenListResponse"},next:{title:"ICensus3TokenTypesResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenTypesResponse"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"pagination",id:"pagination",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"tokens",id:"tokens",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:l};function u(e){let{components:n,...t}=e;return(0,s.kt)("wrapper",(0,r.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3TokenListResponsePaginated"),(0,s.kt)("h1",{id:"interface-icensus3tokenlistresponsepaginated"},"Interface: ICensus3TokenListResponsePaginated"),(0,s.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("p",{parentName:"li"},(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3TokenListResponse"},(0,s.kt)("inlineCode",{parentName:"a"},"ICensus3TokenListResponse"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("strong",{parentName:"p"},(0,s.kt)("inlineCode",{parentName:"strong"},"ICensus3TokenListResponsePaginated"))))),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated#pagination"},"pagination")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated#tokens"},"tokens"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"pagination"},"pagination"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"pagination"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"Census3Pagination")),(0,s.kt)("p",null,"The pagination information"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/token.ts#L124"},"api/census3/token.ts:124")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"tokens"},"tokens"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"tokens"),": ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3summarytoken"},(0,s.kt)("inlineCode",{parentName:"a"},"Census3SummaryToken")),"[]"),(0,s.kt)("p",null,"The list of the tokens"),(0,s.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3TokenListResponse"},"ICensus3TokenListResponse"),".",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3TokenListResponse#tokens"},"tokens")),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/token.ts#L110"},"api/census3/token.ts:110")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9940],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>k});var r=t(67294);function s(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(s[t]=e[t]);return s}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(s[t]=e[t])}return s}var p=r.createContext({}),l=function(e){var n=r.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},c=function(e){var n=l(e.components);return r.createElement(p.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,s=e.mdxType,a=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=l(t),k=s,f=d["".concat(p,".").concat(k)]||d[k]||u[k]||a;return t?r.createElement(f,i(i({ref:n},c),{},{components:t})):r.createElement(f,i({ref:n},c))}));function k(e,n){var t=arguments,s=n&&n.mdxType;if("string"==typeof e||s){var a=t.length,i=new Array(a);i[0]=d;var o={};for(var p in n)hasOwnProperty.call(n,p)&&(o[p]=n[p]);o.originalType=e,o.mdxType="string"==typeof e?e:s,i[1]=o;for(var l=2;l{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>i,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var r=t(87462),s=(t(67294),t(3905));const a={},i=void 0,o={unversionedId:"sdk/reference/interfaces/ICensus3TokenListResponsePaginated",id:"sdk/reference/interfaces/ICensus3TokenListResponsePaginated",title:"ICensus3TokenListResponsePaginated",description:"@vocdoni/sdk / Exports / ICensus3TokenListResponsePaginated",source:"@site/docs/sdk/reference/interfaces/ICensus3TokenListResponsePaginated.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3TokenListResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenListResponse"},next:{title:"ICensus3TokenTypesResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenTypesResponse"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"pagination",id:"pagination",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"tokens",id:"tokens",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:l};function u(e){let{components:n,...t}=e;return(0,s.kt)("wrapper",(0,r.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3TokenListResponsePaginated"),(0,s.kt)("h1",{id:"interface-icensus3tokenlistresponsepaginated"},"Interface: ICensus3TokenListResponsePaginated"),(0,s.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("p",{parentName:"li"},(0,s.kt)("a",{parentName:"p",href:"ICensus3TokenListResponse"},(0,s.kt)("inlineCode",{parentName:"a"},"ICensus3TokenListResponse"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("strong",{parentName:"p"},(0,s.kt)("inlineCode",{parentName:"strong"},"ICensus3TokenListResponsePaginated"))))),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus3TokenListResponsePaginated#pagination"},"pagination")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus3TokenListResponsePaginated#tokens"},"tokens"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"pagination"},"pagination"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"pagination"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"Census3Pagination")),(0,s.kt)("p",null,"The pagination information"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/token.ts#L124"},"api/census3/token.ts:124")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"tokens"},"tokens"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"tokens"),": ",(0,s.kt)("a",{parentName:"p",href:"../modules#census3summarytoken"},(0,s.kt)("inlineCode",{parentName:"a"},"Census3SummaryToken")),"[]"),(0,s.kt)("p",null,"The list of the tokens"),(0,s.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3TokenListResponse"},"ICensus3TokenListResponse"),".",(0,s.kt)("a",{parentName:"p",href:"ICensus3TokenListResponse#tokens"},"tokens")),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/token.ts#L110"},"api/census3/token.ts:110")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.dad0fc38.js b/assets/js/935f2afb.dad0fc38.js deleted file mode 100644 index aa47b37b9..000000000 --- a/assets/js/935f2afb.dad0fc38.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"defaultSidebar":[{"type":"link","label":"Getting Started","href":"/intro","docId":"intro"},{"type":"category","label":"Vocdoni Protocol","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Anonymous Voting","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"CSP Blind Signatures","href":"/protocol/anonymity/blind-signatures","docId":"protocol/anonymity/blind-signatures"},{"type":"link","label":"On-Chain Pseudo-Anonymity","href":"/protocol/anonymity/on-chain","docId":"protocol/anonymity/on-chain"},{"type":"link","label":"Off-Chain Tree ZK Census Proof","href":"/protocol/anonymity/zk-census-proof","docId":"protocol/anonymity/zk-census-proof"}],"href":"/protocol/anonymity/"},{"type":"link","label":"Ballot Protocol","href":"/protocol/ballot-protocol","docId":"protocol/ballot-protocol"},{"type":"category","label":"The Census","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Off-Chain CSP Census","href":"/protocol/census/off-chain-csp","docId":"protocol/census/off-chain-csp"},{"type":"link","label":"Off-Chain Tree Census","href":"/protocol/census/off-chain-tree","docId":"protocol/census/off-chain-tree"},{"type":"link","label":"On-Chain Census","href":"/protocol/census/on-chain","docId":"protocol/census/on-chain"}],"href":"/protocol/census/"},{"type":"category","label":"Data Schemes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Election Metadata","href":"/protocol/data-schemes/election","docId":"protocol/data-schemes/election"},{"type":"link","label":"Organization Metadata","href":"/protocol/data-schemes/organization","docId":"protocol/data-schemes/organization"},{"type":"link","label":"Vote Data","href":"/protocol/data-schemes/vote","docId":"protocol/data-schemes/vote"}],"href":"/protocol/data-schemes/"}],"href":"/protocol/"},{"type":"category","label":"Vocdoni SDK","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"SDK Integration Details","href":"/sdk/integration-details","docId":"sdk/integration-details"},{"type":"category","label":"reference","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Changelog","href":"/sdk/reference/changelog","docId":"sdk/reference/changelog"},{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Account","href":"/sdk/reference/classes/Account","docId":"sdk/reference/classes/Account"},{"type":"link","label":"AccountAPI","href":"/sdk/reference/classes/AccountAPI","docId":"sdk/reference/classes/AccountAPI"},{"type":"link","label":"AccountService","href":"/sdk/reference/classes/AccountService","docId":"sdk/reference/classes/AccountService"},{"type":"link","label":"AnonymousService","href":"/sdk/reference/classes/AnonymousService","docId":"sdk/reference/classes/AnonymousService"},{"type":"link","label":"AnonymousVote","href":"/sdk/reference/classes/AnonymousVote","docId":"sdk/reference/classes/AnonymousVote"},{"type":"link","label":"ApprovalElection","href":"/sdk/reference/classes/ApprovalElection","docId":"sdk/reference/classes/ApprovalElection"},{"type":"link","label":"ArchivedElection","href":"/sdk/reference/classes/ArchivedElection","docId":"sdk/reference/classes/ArchivedElection"},{"type":"link","label":"BudgetElection","href":"/sdk/reference/classes/BudgetElection","docId":"sdk/reference/classes/BudgetElection"},{"type":"link","label":"Census","href":"/sdk/reference/classes/Census","docId":"sdk/reference/classes/Census"},{"type":"link","label":"Census3CensusAPI","href":"/sdk/reference/classes/Census3CensusAPI","docId":"sdk/reference/classes/Census3CensusAPI"},{"type":"link","label":"Census3ServiceAPI","href":"/sdk/reference/classes/Census3ServiceAPI","docId":"sdk/reference/classes/Census3ServiceAPI"},{"type":"link","label":"Census3StrategyAPI","href":"/sdk/reference/classes/Census3StrategyAPI","docId":"sdk/reference/classes/Census3StrategyAPI"},{"type":"link","label":"Census3TokenAPI","href":"/sdk/reference/classes/Census3TokenAPI","docId":"sdk/reference/classes/Census3TokenAPI"},{"type":"link","label":"CensusAPI","href":"/sdk/reference/classes/CensusAPI","docId":"sdk/reference/classes/CensusAPI"},{"type":"link","label":"CensusService","href":"/sdk/reference/classes/CensusService","docId":"sdk/reference/classes/CensusService"},{"type":"link","label":"ChainAPI","href":"/sdk/reference/classes/ChainAPI","docId":"sdk/reference/classes/ChainAPI"},{"type":"link","label":"ChainService","href":"/sdk/reference/classes/ChainService","docId":"sdk/reference/classes/ChainService"},{"type":"link","label":"CspCensus","href":"/sdk/reference/classes/CspCensus","docId":"sdk/reference/classes/CspCensus"},{"type":"link","label":"CspService","href":"/sdk/reference/classes/CspService","docId":"sdk/reference/classes/CspService"},{"type":"link","label":"CspVote","href":"/sdk/reference/classes/CspVote","docId":"sdk/reference/classes/CspVote"},{"type":"link","label":"Election","href":"/sdk/reference/classes/Election","docId":"sdk/reference/classes/Election"},{"type":"link","label":"ElectionAPI","href":"/sdk/reference/classes/ElectionAPI","docId":"sdk/reference/classes/ElectionAPI"},{"type":"link","label":"ElectionService","href":"/sdk/reference/classes/ElectionService","docId":"sdk/reference/classes/ElectionService"},{"type":"link","label":"FaucetAPI","href":"/sdk/reference/classes/FaucetAPI","docId":"sdk/reference/classes/FaucetAPI"},{"type":"link","label":"FaucetService","href":"/sdk/reference/classes/FaucetService","docId":"sdk/reference/classes/FaucetService"},{"type":"link","label":"FileAPI","href":"/sdk/reference/classes/FileAPI","docId":"sdk/reference/classes/FileAPI"},{"type":"link","label":"FileService","href":"/sdk/reference/classes/FileService","docId":"sdk/reference/classes/FileService"},{"type":"link","label":"InvalidElection","href":"/sdk/reference/classes/InvalidElection","docId":"sdk/reference/classes/InvalidElection"},{"type":"link","label":"MultiChoiceElection","href":"/sdk/reference/classes/MultiChoiceElection","docId":"sdk/reference/classes/MultiChoiceElection"},{"type":"link","label":"OffchainCensus","href":"/sdk/reference/classes/OffchainCensus","docId":"sdk/reference/classes/OffchainCensus"},{"type":"link","label":"PlainCensus","href":"/sdk/reference/classes/PlainCensus","docId":"sdk/reference/classes/PlainCensus"},{"type":"link","label":"PublishedCensus","href":"/sdk/reference/classes/PublishedCensus","docId":"sdk/reference/classes/PublishedCensus"},{"type":"link","label":"PublishedElection","href":"/sdk/reference/classes/PublishedElection","docId":"sdk/reference/classes/PublishedElection"},{"type":"link","label":"Service","href":"/sdk/reference/classes/Service","docId":"sdk/reference/classes/Service"},{"type":"link","label":"TokenCensus","href":"/sdk/reference/classes/TokenCensus","docId":"sdk/reference/classes/TokenCensus"},{"type":"link","label":"UnpublishedElection","href":"/sdk/reference/classes/UnpublishedElection","docId":"sdk/reference/classes/UnpublishedElection"},{"type":"link","label":"VocdoniCensus3Client","href":"/sdk/reference/classes/VocdoniCensus3Client","docId":"sdk/reference/classes/VocdoniCensus3Client"},{"type":"link","label":"VocdoniSDKClient","href":"/sdk/reference/classes/VocdoniSDKClient","docId":"sdk/reference/classes/VocdoniSDKClient"},{"type":"link","label":"Vote","href":"/sdk/reference/classes/Vote","docId":"sdk/reference/classes/Vote"},{"type":"link","label":"VoteAPI","href":"/sdk/reference/classes/VoteAPI","docId":"sdk/reference/classes/VoteAPI"},{"type":"link","label":"VoteService","href":"/sdk/reference/classes/VoteService","docId":"sdk/reference/classes/VoteService"},{"type":"link","label":"WalletAPI","href":"/sdk/reference/classes/WalletAPI","docId":"sdk/reference/classes/WalletAPI"},{"type":"link","label":"WeightedCensus","href":"/sdk/reference/classes/WeightedCensus","docId":"sdk/reference/classes/WeightedCensus"}]},{"type":"category","label":"enums","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"CensusOrigin","href":"/sdk/reference/enums/CensusOrigin","docId":"sdk/reference/enums/CensusOrigin"},{"type":"link","label":"CensusType","href":"/sdk/reference/enums/CensusType","docId":"sdk/reference/enums/CensusType"},{"type":"link","label":"CensusTypeEnum","href":"/sdk/reference/enums/CensusTypeEnum","docId":"sdk/reference/enums/CensusTypeEnum"},{"type":"link","label":"CspProofType","href":"/sdk/reference/enums/CspProofType","docId":"sdk/reference/enums/CspProofType"},{"type":"link","label":"ElectionCreationSteps","href":"/sdk/reference/enums/ElectionCreationSteps","docId":"sdk/reference/enums/ElectionCreationSteps"},{"type":"link","label":"ElectionResultsTypeNames","href":"/sdk/reference/enums/ElectionResultsTypeNames","docId":"sdk/reference/enums/ElectionResultsTypeNames"},{"type":"link","label":"ElectionStatus","href":"/sdk/reference/enums/ElectionStatus","docId":"sdk/reference/enums/ElectionStatus"},{"type":"link","label":"ElectionStatusReady","href":"/sdk/reference/enums/ElectionStatusReady","docId":"sdk/reference/enums/ElectionStatusReady"},{"type":"link","label":"EnvOptions","href":"/sdk/reference/enums/EnvOptions","docId":"sdk/reference/enums/EnvOptions"},{"type":"link","label":"TransactionType","href":"/sdk/reference/enums/TransactionType","docId":"sdk/reference/enums/TransactionType"},{"type":"link","label":"TxType","href":"/sdk/reference/enums/TxType","docId":"sdk/reference/enums/TxType"},{"type":"link","label":"VoteSteps","href":"/sdk/reference/enums/VoteSteps","docId":"sdk/reference/enums/VoteSteps"}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AccountMetadata","href":"/sdk/reference/interfaces/AccountMetadata","docId":"sdk/reference/interfaces/AccountMetadata"},{"type":"link","label":"AdminTx","href":"/sdk/reference/interfaces/AdminTx","docId":"sdk/reference/interfaces/AdminTx"},{"type":"link","label":"CircuitInputs","href":"/sdk/reference/interfaces/CircuitInputs","docId":"sdk/reference/interfaces/CircuitInputs"},{"type":"link","label":"CollectFaucetTx","href":"/sdk/reference/interfaces/CollectFaucetTx","docId":"sdk/reference/interfaces/CollectFaucetTx"},{"type":"link","label":"ElectionMetadata","href":"/sdk/reference/interfaces/ElectionMetadata","docId":"sdk/reference/interfaces/ElectionMetadata"},{"type":"link","label":"FetchElectionsParameters","href":"/sdk/reference/interfaces/FetchElectionsParameters","docId":"sdk/reference/interfaces/FetchElectionsParameters"},{"type":"link","label":"IAccount","href":"/sdk/reference/interfaces/IAccount","docId":"sdk/reference/interfaces/IAccount"},{"type":"link","label":"IAccountTransfersCountResponse","href":"/sdk/reference/interfaces/IAccountTransfersCountResponse","docId":"sdk/reference/interfaces/IAccountTransfersCountResponse"},{"type":"link","label":"IAccountsCountResponse","href":"/sdk/reference/interfaces/IAccountsCountResponse","docId":"sdk/reference/interfaces/IAccountsCountResponse"},{"type":"link","label":"IAccountsListResponse","href":"/sdk/reference/interfaces/IAccountsListResponse","docId":"sdk/reference/interfaces/IAccountsListResponse"},{"type":"link","label":"IApprovalElectionParameters","href":"/sdk/reference/interfaces/IApprovalElectionParameters","docId":"sdk/reference/interfaces/IApprovalElectionParameters"},{"type":"link","label":"IBlockTransactionsResponse","href":"/sdk/reference/interfaces/IBlockTransactionsResponse","docId":"sdk/reference/interfaces/IBlockTransactionsResponse"},{"type":"link","label":"IBudgetElectionParametersInfo","href":"/sdk/reference/interfaces/IBudgetElectionParametersInfo","docId":"sdk/reference/interfaces/IBudgetElectionParametersInfo"},{"type":"link","label":"IBudgetElectionParametersWithBudget","href":"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget","docId":"sdk/reference/interfaces/IBudgetElectionParametersWithBudget"},{"type":"link","label":"IBudgetElectionParametersWithCensusWeight","href":"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight","docId":"sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight"},{"type":"link","label":"ICensus","href":"/sdk/reference/interfaces/ICensus","docId":"sdk/reference/interfaces/ICensus"},{"type":"link","label":"ICensus3CensusListResponse","href":"/sdk/reference/interfaces/ICensus3CensusListResponse","docId":"sdk/reference/interfaces/ICensus3CensusListResponse"},{"type":"link","label":"ICensus3CensusQueueResponse","href":"/sdk/reference/interfaces/ICensus3CensusQueueResponse","docId":"sdk/reference/interfaces/ICensus3CensusQueueResponse"},{"type":"link","label":"ICensus3CensusResponse","href":"/sdk/reference/interfaces/ICensus3CensusResponse","docId":"sdk/reference/interfaces/ICensus3CensusResponse"},{"type":"link","label":"ICensus3ServiceInfoResponse","href":"/sdk/reference/interfaces/ICensus3ServiceInfoResponse","docId":"sdk/reference/interfaces/ICensus3ServiceInfoResponse"},{"type":"link","label":"ICensus3StrategiesListResponse","href":"/sdk/reference/interfaces/ICensus3StrategiesListResponse","docId":"sdk/reference/interfaces/ICensus3StrategiesListResponse"},{"type":"link","label":"ICensus3StrategiesListResponsePaginated","href":"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated","docId":"sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated"},{"type":"link","label":"ICensus3StrategiesOperator","href":"/sdk/reference/interfaces/ICensus3StrategiesOperator","docId":"sdk/reference/interfaces/ICensus3StrategiesOperator"},{"type":"link","label":"ICensus3StrategiesOperatorsResponse","href":"/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse","docId":"sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse"},{"type":"link","label":"ICensus3StrategyCreateResponse","href":"/sdk/reference/interfaces/ICensus3StrategyCreateResponse","docId":"sdk/reference/interfaces/ICensus3StrategyCreateResponse"},{"type":"link","label":"ICensus3StrategyEstimationQueueResponse","href":"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse","docId":"sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse"},{"type":"link","label":"ICensus3StrategyHoldersResponse","href":"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse","docId":"sdk/reference/interfaces/ICensus3StrategyHoldersResponse"},{"type":"link","label":"ICensus3StrategyHoldersResponsePaginated","href":"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated","docId":"sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated"},{"type":"link","label":"ICensus3StrategyImportQueueResponse","href":"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse","docId":"sdk/reference/interfaces/ICensus3StrategyImportQueueResponse"},{"type":"link","label":"ICensus3StrategyToken","href":"/sdk/reference/interfaces/ICensus3StrategyToken","docId":"sdk/reference/interfaces/ICensus3StrategyToken"},{"type":"link","label":"ICensus3SupportedChain","href":"/sdk/reference/interfaces/ICensus3SupportedChain","docId":"sdk/reference/interfaces/ICensus3SupportedChain"},{"type":"link","label":"ICensus3TokenHolderResponse","href":"/sdk/reference/interfaces/ICensus3TokenHolderResponse","docId":"sdk/reference/interfaces/ICensus3TokenHolderResponse"},{"type":"link","label":"ICensus3TokenListResponse","href":"/sdk/reference/interfaces/ICensus3TokenListResponse","docId":"sdk/reference/interfaces/ICensus3TokenListResponse"},{"type":"link","label":"ICensus3TokenListResponsePaginated","href":"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated","docId":"sdk/reference/interfaces/ICensus3TokenListResponsePaginated"},{"type":"link","label":"ICensus3TokenTypesResponse","href":"/sdk/reference/interfaces/ICensus3TokenTypesResponse","docId":"sdk/reference/interfaces/ICensus3TokenTypesResponse"},{"type":"link","label":"ICensus3ValidatePredicateChild","href":"/sdk/reference/interfaces/ICensus3ValidatePredicateChild","docId":"sdk/reference/interfaces/ICensus3ValidatePredicateChild"},{"type":"link","label":"ICensus3ValidatePredicateResponse","href":"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse","docId":"sdk/reference/interfaces/ICensus3ValidatePredicateResponse"},{"type":"link","label":"ICensus3ValidatePredicateToken","href":"/sdk/reference/interfaces/ICensus3ValidatePredicateToken","docId":"sdk/reference/interfaces/ICensus3ValidatePredicateToken"},{"type":"link","label":"ICensusExportResponse","href":"/sdk/reference/interfaces/ICensusExportResponse","docId":"sdk/reference/interfaces/ICensusExportResponse"},{"type":"link","label":"ICensusImportResponse","href":"/sdk/reference/interfaces/ICensusImportResponse","docId":"sdk/reference/interfaces/ICensusImportResponse"},{"type":"link","label":"ICensusParticipant","href":"/sdk/reference/interfaces/ICensusParticipant","docId":"sdk/reference/interfaces/ICensusParticipant"},{"type":"link","label":"ICensusProofResponse","href":"/sdk/reference/interfaces/ICensusProofResponse","docId":"sdk/reference/interfaces/ICensusProofResponse"},{"type":"link","label":"ICensusPublishResponse","href":"/sdk/reference/interfaces/ICensusPublishResponse","docId":"sdk/reference/interfaces/ICensusPublishResponse"},{"type":"link","label":"IChainBlockInfoResponse","href":"/sdk/reference/interfaces/IChainBlockInfoResponse","docId":"sdk/reference/interfaces/IChainBlockInfoResponse"},{"type":"link","label":"IChainGetCircuitResponse","href":"/sdk/reference/interfaces/IChainGetCircuitResponse","docId":"sdk/reference/interfaces/IChainGetCircuitResponse"},{"type":"link","label":"IChainGetCostsResponse","href":"/sdk/reference/interfaces/IChainGetCostsResponse","docId":"sdk/reference/interfaces/IChainGetCostsResponse"},{"type":"link","label":"IChainGetInfoResponse","href":"/sdk/reference/interfaces/IChainGetInfoResponse","docId":"sdk/reference/interfaces/IChainGetInfoResponse"},{"type":"link","label":"IChainOrganizationCountResponse","href":"/sdk/reference/interfaces/IChainOrganizationCountResponse","docId":"sdk/reference/interfaces/IChainOrganizationCountResponse"},{"type":"link","label":"IChainOrganizationListResponse","href":"/sdk/reference/interfaces/IChainOrganizationListResponse","docId":"sdk/reference/interfaces/IChainOrganizationListResponse"},{"type":"link","label":"IChainOrganizationResponse","href":"/sdk/reference/interfaces/IChainOrganizationResponse","docId":"sdk/reference/interfaces/IChainOrganizationResponse"},{"type":"link","label":"IChainSubmitTxResponse","href":"/sdk/reference/interfaces/IChainSubmitTxResponse","docId":"sdk/reference/interfaces/IChainSubmitTxResponse"},{"type":"link","label":"IChainTxCountResponse","href":"/sdk/reference/interfaces/IChainTxCountResponse","docId":"sdk/reference/interfaces/IChainTxCountResponse"},{"type":"link","label":"IChainTxListResponse","href":"/sdk/reference/interfaces/IChainTxListResponse","docId":"sdk/reference/interfaces/IChainTxListResponse"},{"type":"link","label":"IChainTxReference","href":"/sdk/reference/interfaces/IChainTxReference","docId":"sdk/reference/interfaces/IChainTxReference"},{"type":"link","label":"IChainValidator","href":"/sdk/reference/interfaces/IChainValidator","docId":"sdk/reference/interfaces/IChainValidator"},{"type":"link","label":"IChainValidatorsListResponse","href":"/sdk/reference/interfaces/IChainValidatorsListResponse","docId":"sdk/reference/interfaces/IChainValidatorsListResponse"},{"type":"link","label":"IChoice","href":"/sdk/reference/interfaces/IChoice","docId":"sdk/reference/interfaces/IChoice"},{"type":"link","label":"IElectionCreateResponse","href":"/sdk/reference/interfaces/IElectionCreateResponse","docId":"sdk/reference/interfaces/IElectionCreateResponse"},{"type":"link","label":"IElectionInfoResponse","href":"/sdk/reference/interfaces/IElectionInfoResponse","docId":"sdk/reference/interfaces/IElectionInfoResponse"},{"type":"link","label":"IElectionKeysResponse","href":"/sdk/reference/interfaces/IElectionKeysResponse","docId":"sdk/reference/interfaces/IElectionKeysResponse"},{"type":"link","label":"IElectionListFilter","href":"/sdk/reference/interfaces/IElectionListFilter","docId":"sdk/reference/interfaces/IElectionListFilter"},{"type":"link","label":"IElectionListResponse","href":"/sdk/reference/interfaces/IElectionListResponse","docId":"sdk/reference/interfaces/IElectionListResponse"},{"type":"link","label":"IElectionMode","href":"/sdk/reference/interfaces/IElectionMode","docId":"sdk/reference/interfaces/IElectionMode"},{"type":"link","label":"IElectionNextIdResponse","href":"/sdk/reference/interfaces/IElectionNextIdResponse","docId":"sdk/reference/interfaces/IElectionNextIdResponse"},{"type":"link","label":"IElectionParameters","href":"/sdk/reference/interfaces/IElectionParameters","docId":"sdk/reference/interfaces/IElectionParameters"},{"type":"link","label":"IElectionSummary","href":"/sdk/reference/interfaces/IElectionSummary","docId":"sdk/reference/interfaces/IElectionSummary"},{"type":"link","label":"IElectionType","href":"/sdk/reference/interfaces/IElectionType","docId":"sdk/reference/interfaces/IElectionType"},{"type":"link","label":"IElectionVote","href":"/sdk/reference/interfaces/IElectionVote","docId":"sdk/reference/interfaces/IElectionVote"},{"type":"link","label":"IElectionVoteListResponse","href":"/sdk/reference/interfaces/IElectionVoteListResponse","docId":"sdk/reference/interfaces/IElectionVoteListResponse"},{"type":"link","label":"IEncryptionKey","href":"/sdk/reference/interfaces/IEncryptionKey","docId":"sdk/reference/interfaces/IEncryptionKey"},{"type":"link","label":"IInvalidElectionParameters","href":"/sdk/reference/interfaces/IInvalidElectionParameters","docId":"sdk/reference/interfaces/IInvalidElectionParameters"},{"type":"link","label":"IMultiChoiceElectionParameters","href":"/sdk/reference/interfaces/IMultiChoiceElectionParameters","docId":"sdk/reference/interfaces/IMultiChoiceElectionParameters"},{"type":"link","label":"IPublishedElectionParameters","href":"/sdk/reference/interfaces/IPublishedElectionParameters","docId":"sdk/reference/interfaces/IPublishedElectionParameters"},{"type":"link","label":"IQuestion","href":"/sdk/reference/interfaces/IQuestion","docId":"sdk/reference/interfaces/IQuestion"},{"type":"link","label":"ITallyMode","href":"/sdk/reference/interfaces/ITallyMode","docId":"sdk/reference/interfaces/ITallyMode"},{"type":"link","label":"IVoteInfoResponse","href":"/sdk/reference/interfaces/IVoteInfoResponse","docId":"sdk/reference/interfaces/IVoteInfoResponse"},{"type":"link","label":"IVoteMode","href":"/sdk/reference/interfaces/IVoteMode","docId":"sdk/reference/interfaces/IVoteMode"},{"type":"link","label":"IVoteSubmitResponse","href":"/sdk/reference/interfaces/IVoteSubmitResponse","docId":"sdk/reference/interfaces/IVoteSubmitResponse"},{"type":"link","label":"IVoteType","href":"/sdk/reference/interfaces/IVoteType","docId":"sdk/reference/interfaces/IVoteType"},{"type":"link","label":"MintTokensTx","href":"/sdk/reference/interfaces/MintTokensTx","docId":"sdk/reference/interfaces/MintTokensTx"},{"type":"link","label":"NewProcessTx","href":"/sdk/reference/interfaces/NewProcessTx","docId":"sdk/reference/interfaces/NewProcessTx"},{"type":"link","label":"Process","href":"/sdk/reference/interfaces/Process","docId":"sdk/reference/interfaces/Process"},{"type":"link","label":"Proof","href":"/sdk/reference/interfaces/Proof","docId":"sdk/reference/interfaces/Proof"},{"type":"link","label":"RegisterKeyTx","href":"/sdk/reference/interfaces/RegisterKeyTx","docId":"sdk/reference/interfaces/RegisterKeyTx"},{"type":"link","label":"SendTokensTx","href":"/sdk/reference/interfaces/SendTokensTx","docId":"sdk/reference/interfaces/SendTokensTx"},{"type":"link","label":"ServiceProperties","href":"/sdk/reference/interfaces/ServiceProperties","docId":"sdk/reference/interfaces/ServiceProperties"},{"type":"link","label":"SetAccountTx","href":"/sdk/reference/interfaces/SetAccountTx","docId":"sdk/reference/interfaces/SetAccountTx"},{"type":"link","label":"SetProcessTx","href":"/sdk/reference/interfaces/SetProcessTx","docId":"sdk/reference/interfaces/SetProcessTx"},{"type":"link","label":"SetTransactionCostsTx","href":"/sdk/reference/interfaces/SetTransactionCostsTx","docId":"sdk/reference/interfaces/SetTransactionCostsTx"},{"type":"link","label":"Tx","href":"/sdk/reference/interfaces/Tx","docId":"sdk/reference/interfaces/Tx"},{"type":"link","label":"VoteEnvelope","href":"/sdk/reference/interfaces/VoteEnvelope","docId":"sdk/reference/interfaces/VoteEnvelope"}]},{"type":"link","label":"modules","href":"/sdk/reference/modules","docId":"sdk/reference/modules"}]},{"type":"link","label":"SDK Tutorial","href":"/sdk/tutorial","docId":"sdk/tutorial"},{"type":"category","label":"Voting Types","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Single Choice Voting","href":"/sdk/voting-types/single-choice","docId":"sdk/voting-types/single-choice"},{"type":"link","label":"Ranked Voting","href":"/sdk/voting-types/ranked","docId":"sdk/voting-types/ranked"},{"type":"link","label":"Approval Voting (Multiple Choice)","href":"/sdk/voting-types/approval","docId":"sdk/voting-types/approval"},{"type":"link","label":"Weighted voting","href":"/sdk/voting-types/weighted","docId":"sdk/voting-types/weighted"},{"type":"link","label":"Quadratic voting","href":"/sdk/voting-types/quadratic","docId":"sdk/voting-types/quadratic"}],"href":"/sdk/voting-types/"}],"href":"/sdk/"},{"type":"category","label":"UI Components","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Organization components","href":"/ui-components/Organization","docId":"ui-components/Organization"},{"type":"link","label":"Election components","href":"/ui-components/Election","docId":"ui-components/Election"}],"href":"/ui-components/"},{"type":"category","label":"Vocdoni API","items":[{"type":"category","label":"Chain","items":[{"type":"link","label":"Estimate block to date","href":"/vocdoni-api/estimate-block-to-date","className":"api-method get","docId":"vocdoni-api/estimate-block-to-date"},{"type":"link","label":"Get block (by hash)","href":"/vocdoni-api/get-block-by-hash","className":"api-method get","docId":"vocdoni-api/get-block-by-hash"},{"type":"link","label":"Get block (by height)","href":"/vocdoni-api/get-block-by-height","className":"api-method get","docId":"vocdoni-api/get-block-by-height"},{"type":"link","label":"Transactions in a block","href":"/vocdoni-api/transactions-in-a-block","className":"api-method get","docId":"vocdoni-api/transactions-in-a-block"},{"type":"link","label":"Estimate date to block","href":"/vocdoni-api/estimate-date-to-block","className":"api-method get","docId":"vocdoni-api/estimate-date-to-block"},{"type":"link","label":"Vochain information","href":"/vocdoni-api/vochain-information","className":"api-method get","docId":"vocdoni-api/vochain-information"},{"type":"link","label":"Circuit info","href":"/vocdoni-api/circuit-info","className":"api-method get","docId":"vocdoni-api/circuit-info"},{"type":"link","label":"Price factors information","href":"/vocdoni-api/price-factors-information","className":"api-method get","docId":"vocdoni-api/price-factors-information"},{"type":"link","label":"Count organizations","href":"/vocdoni-api/count-organizations","className":"api-method get","docId":"vocdoni-api/count-organizations"},{"type":"link","label":"List organizations (filtered)","href":"/vocdoni-api/list-organizations-filtered","className":"api-method post","docId":"vocdoni-api/list-organizations-filtered"},{"type":"link","label":"List organizations","href":"/vocdoni-api/list-organizations","className":"api-method get","docId":"vocdoni-api/list-organizations"},{"type":"link","label":"Submit transaction","href":"/vocdoni-api/submit-transaction","className":"api-method post","docId":"vocdoni-api/submit-transaction"},{"type":"link","label":"Transaction costs","href":"/vocdoni-api/transaction-costs","className":"api-method get","docId":"vocdoni-api/transaction-costs"},{"type":"link","label":"Transactions count","href":"/vocdoni-api/transactions-count","className":"api-method get","docId":"vocdoni-api/transactions-count"},{"type":"link","label":"List Transactions","href":"/vocdoni-api/list-transactions","className":"api-method get","docId":"vocdoni-api/list-transactions"},{"type":"link","label":"Transaction by index","href":"/vocdoni-api/transaction-by-index","className":"api-method get","docId":"vocdoni-api/transaction-by-index"},{"type":"link","label":"Transaction by hash","href":"/vocdoni-api/transaction-by-hash","className":"api-method get","docId":"vocdoni-api/transaction-by-hash"},{"type":"link","label":"Transaction by block height and index","href":"/vocdoni-api/transaction-by-block-height-and-index","className":"api-method get","docId":"vocdoni-api/transaction-by-block-height-and-index"},{"type":"link","label":"List validators","href":"/vocdoni-api/list-validators","className":"api-method get","docId":"vocdoni-api/list-validators"}],"collapsed":true,"collapsible":true,"href":"/vocdoni-api/chain"},{"type":"category","label":"Accounts","items":[{"type":"link","label":"Set account","href":"/vocdoni-api/set-account","className":"api-method post","docId":"vocdoni-api/set-account"},{"type":"link","label":"Total number of accounts","href":"/vocdoni-api/total-number-of-accounts","className":"api-method get","docId":"vocdoni-api/total-number-of-accounts"},{"type":"link","label":"List of the existing accounts","href":"/vocdoni-api/list-of-the-existing-accounts","className":"api-method get","docId":"vocdoni-api/list-of-the-existing-accounts"},{"type":"link","label":"List account token fees","href":"/vocdoni-api/list-account-token-fees","className":"api-method get","docId":"vocdoni-api/list-account-token-fees"},{"type":"link","label":"Total number of sent and received transactions","href":"/vocdoni-api/total-number-of-sent-and-received-transactions","className":"api-method get","docId":"vocdoni-api/total-number-of-sent-and-received-transactions"},{"type":"link","label":"List account received and sent token transfers","href":"/vocdoni-api/list-account-received-and-sent-token-transfers","className":"api-method get","docId":"vocdoni-api/list-account-received-and-sent-token-transfers"},{"type":"link","label":"Get account","href":"/vocdoni-api/get-account","className":"api-method get","docId":"vocdoni-api/get-account"},{"type":"link","label":"Get account","href":"/vocdoni-api/get-account","className":"api-method get","docId":"vocdoni-api/get-account"},{"type":"link","label":"Count organization elections","href":"/vocdoni-api/count-organization-elections","className":"api-method get","docId":"vocdoni-api/count-organization-elections"},{"type":"link","label":"List organization elections","href":"/vocdoni-api/list-organization-elections","className":"api-method get","docId":"vocdoni-api/list-organization-elections"},{"type":"link","label":"List organization elections by status","href":"/vocdoni-api/list-organization-elections-by-status","className":"api-method get","docId":"vocdoni-api/list-organization-elections-by-status"},{"type":"link","label":"List all token fees","href":"/vocdoni-api/list-all-token-fees","className":"api-method get","docId":"vocdoni-api/list-all-token-fees"},{"type":"link","label":"List all token fees by reference","href":"/vocdoni-api/list-all-token-fees-by-reference","className":"api-method get","docId":"vocdoni-api/list-all-token-fees-by-reference"},{"type":"link","label":"List all token fees by type","href":"/vocdoni-api/list-all-token-fees-by-type","className":"api-method get","docId":"vocdoni-api/list-all-token-fees-by-type"}],"collapsed":true,"collapsible":true,"href":"/vocdoni-api/accounts"},{"type":"category","label":"Elections","items":[{"type":"link","label":"Create election","href":"/vocdoni-api/create-election","className":"api-method post","docId":"vocdoni-api/create-election"},{"type":"link","label":"List elections (filtered)","href":"/vocdoni-api/list-elections-filtered","className":"api-method post","docId":"vocdoni-api/list-elections-filtered"},{"type":"link","label":"Get next election ID","href":"/vocdoni-api/get-next-election-id","className":"api-method post","docId":"vocdoni-api/get-next-election-id"},{"type":"link","label":"List elections","href":"/vocdoni-api/list-elections","className":"api-method get","docId":"vocdoni-api/list-elections"},{"type":"link","label":"Compute election price","href":"/vocdoni-api/compute-election-price","className":"api-method post","docId":"vocdoni-api/compute-election-price"},{"type":"link","label":"Election information","href":"/vocdoni-api/election-information","className":"api-method get","docId":"vocdoni-api/election-information"},{"type":"link","label":"List encryption keys","href":"/vocdoni-api/list-encryption-keys","className":"api-method get","docId":"vocdoni-api/list-encryption-keys"},{"type":"link","label":"Election results","href":"/vocdoni-api/election-results","className":"api-method get","docId":"vocdoni-api/election-results"},{"type":"link","label":"Count election votes","href":"/vocdoni-api/count-election-votes","className":"api-method get","docId":"vocdoni-api/count-election-votes"},{"type":"link","label":"List election votes","href":"/vocdoni-api/list-election-votes","className":"api-method get","docId":"vocdoni-api/list-election-votes"},{"type":"link","label":"Compute IPFS CIDv1 of file","href":"/vocdoni-api/compute-ipfs-ci-dv-1-of-file","className":"api-method post","docId":"vocdoni-api/compute-ipfs-ci-dv-1-of-file"}],"collapsed":true,"collapsible":true,"href":"/vocdoni-api/elections"},{"type":"category","label":"Censuses","items":[{"type":"link","label":"Export census database","href":"/vocdoni-api/export-census-database","className":"api-method get","docId":"vocdoni-api/export-census-database"},{"type":"link","label":"Import census database","href":"/vocdoni-api/import-census-database","className":"api-method post","docId":"vocdoni-api/import-census-database"},{"type":"link","label":"List all census references","href":"/vocdoni-api/list-all-census-references","className":"api-method get","docId":"vocdoni-api/list-all-census-references"},{"type":"link","label":"Delete census","href":"/vocdoni-api/delete-census","className":"api-method delete","docId":"vocdoni-api/delete-census"},{"type":"link","label":"Export census","href":"/vocdoni-api/export-census","className":"api-method get","docId":"vocdoni-api/export-census"},{"type":"link","label":"Import census","href":"/vocdoni-api/import-census","className":"api-method post","docId":"vocdoni-api/import-census"},{"type":"link","label":"Add participants to census","href":"/vocdoni-api/add-participants-to-census","className":"api-method post","docId":"vocdoni-api/add-participants-to-census"},{"type":"link","label":"Prove key to census","href":"/vocdoni-api/prove-key-to-census","className":"api-method get","docId":"vocdoni-api/prove-key-to-census"},{"type":"link","label":"Publish census","href":"/vocdoni-api/publish-census","className":"api-method post","docId":"vocdoni-api/publish-census"},{"type":"link","label":"Publish census at root","href":"/vocdoni-api/publish-census-at-root","className":"api-method post","docId":"vocdoni-api/publish-census-at-root"},{"type":"link","label":"Census Merkle Root","href":"/vocdoni-api/census-merkle-root","className":"api-method get","docId":"vocdoni-api/census-merkle-root"},{"type":"link","label":"Census size","href":"/vocdoni-api/census-size","className":"api-method get","docId":"vocdoni-api/census-size"},{"type":"link","label":"Get type of census","href":"/vocdoni-api/get-type-of-census","className":"api-method get","docId":"vocdoni-api/get-type-of-census"},{"type":"link","label":"Verify merkle proof","href":"/vocdoni-api/verify-merkle-proof","className":"api-method post","docId":"vocdoni-api/verify-merkle-proof"},{"type":"link","label":"Census total weight","href":"/vocdoni-api/census-total-weight","className":"api-method get","docId":"vocdoni-api/census-total-weight"},{"type":"link","label":"Create a new census","href":"/vocdoni-api/create-a-new-census","className":"api-method post","docId":"vocdoni-api/create-a-new-census"}],"collapsed":true,"collapsible":true,"href":"/vocdoni-api/censuses"},{"type":"category","label":"Votes","items":[{"type":"link","label":"Submit a vote","href":"/vocdoni-api/submit-a-vote","className":"api-method post","docId":"vocdoni-api/submit-a-vote"},{"type":"link","label":"Verify vote","href":"/vocdoni-api/verify-vote","className":"api-method get","docId":"vocdoni-api/verify-vote"},{"type":"link","label":"Get vote","href":"/vocdoni-api/get-vote","className":"api-method get","docId":"vocdoni-api/get-vote"}],"collapsed":true,"collapsible":true,"href":"/vocdoni-api/votes"},{"type":"category","label":"Wallet","items":[{"type":"link","label":"Add account","href":"/vocdoni-api/add-account","className":"api-method post","docId":"vocdoni-api/add-account"},{"type":"link","label":"Set wallet account","href":"/vocdoni-api/set-wallet-account","className":"api-method get","docId":"vocdoni-api/set-wallet-account"},{"type":"link","label":"Create election for wallet","href":"/vocdoni-api/create-election-for-wallet","className":"api-method post","docId":"vocdoni-api/create-election-for-wallet"},{"type":"link","label":"Transfer tokens","href":"/vocdoni-api/transfer-tokens","className":"api-method get","docId":"vocdoni-api/transfer-tokens"}],"collapsed":true,"collapsible":true,"href":"/vocdoni-api/wallet"},{"type":"category","label":"SIK","items":[{"type":"link","label":"List of valid SIK roots","href":"/vocdoni-api/list-of-valid-sik-roots","className":"api-method get","docId":"vocdoni-api/list-of-valid-sik-roots"},{"type":"link","label":"List of valid SIK roots","href":"/vocdoni-api/list-of-valid-sik-roots","className":"api-method get","docId":"vocdoni-api/list-of-valid-sik-roots"},{"type":"link","label":"Returns if the address provided has a valid SIK","href":"/vocdoni-api/returns-if-the-address-provided-has-a-valid-sik","className":"api-method get","docId":"vocdoni-api/returns-if-the-address-provided-has-a-valid-sik"}],"collapsed":true,"collapsible":true,"href":"/vocdoni-api/sik"},{"type":"category","label":"Indexer","items":[{"type":"link","label":"Exports the indexer database","href":"/vocdoni-api/exports-the-indexer-database","className":"api-method get","docId":"vocdoni-api/exports-the-indexer-database"}],"collapsed":true,"collapsible":true}],"collapsed":true,"collapsible":true,"href":"/vocdoni-api/vocdoni-api"}]},"docs":{"intro":{"id":"intro","title":"Getting Started","description":"Vocdoni is the most open, secure, and universally verifiable voting protocol, used by hundreds of organizations worldwide. The core of our stack is a powerful decentralized backend, including blockchain, P2P gateway, and distributed file storage components.","sidebar":"defaultSidebar"},"protocol/anonymity/anonymity":{"id":"protocol/anonymity/anonymity","title":"Anonymous Voting","description":"- Anonymous voting is a type of voting process where the users can vote without revealing their identity, by proving that they are accepted as valid voters. Currently we have 2 types of anonymous voting schemes:","sidebar":"defaultSidebar"},"protocol/anonymity/blind-signatures":{"id":"protocol/anonymity/blind-signatures","title":"CSP Blind Signatures","description":"The current approach by Vocdoni regarding determining the eligibility of a potential voter is to use a Census Merkle Tree. All voter public keys must be known in advance and aggregated together into a hash tree to compute a Merkle root. Then each voter needs to fetch their own Merkle proof to demonstrate their eligibility on a public ledger. The Merkle proof can be anonymized using a zk-SNARK so that the public ledger will verify the SNARK proof instead.","sidebar":"defaultSidebar"},"protocol/anonymity/on-chain":{"id":"protocol/anonymity/on-chain","title":"On-Chain Pseudo-Anonymity","description":"This page is a work-in-progress. Please check back for updates.","sidebar":"defaultSidebar"},"protocol/anonymity/zk-census-proof":{"id":"protocol/anonymity/zk-census-proof","title":"Off-Chain Tree ZK Census Proof","description":"This document is divided in two sections:","sidebar":"defaultSidebar"},"protocol/ballot-protocol":{"id":"protocol/ballot-protocol","title":"Ballot Protocol","description":"Ballot protocol","sidebar":"defaultSidebar"},"protocol/census/census":{"id":"protocol/census/census","title":"The Census","description":"In Vocdoni, a census of identities can be represented in one of three ways. For Ethereum-based processes, in which eligible voters are represented by Ethereum addresses holding a specific token, an on-chain] (ERC-20) census is used. In cases where a central authority wants to manually validate each voter at the time of voting, [off-chain credential service provider is used. For all other voting processes (organizations that are not represented as DAOs), an off-chain tree census is used.","sidebar":"defaultSidebar"},"protocol/census/off-chain-csp":{"id":"protocol/census/off-chain-csp","title":"Off-Chain CSP Census","description":"A census approach based on Credential Service Providers (CSPs) allows organizations to validate users manually and based off of any arbitrary criteria. Rather than a static census published before-hand, CSP census allows each user to be evaluated for voting eligibility individually, throughout the duration of the voting process.","sidebar":"defaultSidebar"},"protocol/census/off-chain-tree":{"id":"protocol/census/off-chain-tree","title":"Off-Chain Tree Census","description":"The census itself is represented as a binary Merkle Tree, where the leaves of the tree contain the public keys of all eligible voters, hashed.","sidebar":"defaultSidebar"},"protocol/census/on-chain":{"id":"protocol/census/on-chain","title":"On-Chain Census","description":"There are two types of census origins: Those who depend on a list of public keys maintained off-chain and those dependent on the status of the Ethereum blockchain at a given point in time.","sidebar":"defaultSidebar"},"protocol/data-schemes/data-schemes":{"id":"protocol/data-schemes/data-schemes","title":"Data Schemes","description":"When it comes to voting processes, there are two main types of data storage at the protocol-level: protocol-level data stored on the Vochain and readable metadata like election descriptions stored on IPFS.","sidebar":"defaultSidebar"},"protocol/data-schemes/election":{"id":"protocol/data-schemes/election","title":"Election Metadata","description":"Election metadata provides the human-readable data associated with an election.","sidebar":"defaultSidebar"},"protocol/data-schemes/organization":{"id":"protocol/data-schemes/organization","title":"Organization Metadata","description":"The metadata of an organization provides human readable content, featuring names, descriptions, images, the list of available processes and more.","sidebar":"defaultSidebar"},"protocol/data-schemes/vote":{"id":"protocol/data-schemes/vote","title":"Vote Data","description":"Vote Envelope","sidebar":"defaultSidebar"},"protocol/index":{"id":"protocol/index","title":"Vocdoni Protocol","description":"1. Introduction","sidebar":"defaultSidebar"},"sdk/index":{"id":"sdk/index","title":"Vocdoni SDK","description":"The Vocdoni SDK is a convenient way to interact with the Vocdoni Protocol through the API, allowing anyone to create, manage and participate in voting processes and collective decision-making. The SDK is the primary mode by which developers should interface with Vocdoni - if you think the SDK is missing functionality you need, please get in touch.","sidebar":"defaultSidebar"},"sdk/integration-details":{"id":"sdk/integration-details","title":"SDK Integration Details","description":"The tutorial covers the basics, but here are some details you\'ll need to consider when integrating the Vocdoni SDK into your application.","sidebar":"defaultSidebar"},"sdk/reference/changelog":{"id":"sdk/reference/changelog","title":"Changelog","description":"All notable changes to this project will be documented in this file.","sidebar":"defaultSidebar"},"sdk/reference/classes/Account":{"id":"sdk/reference/classes/Account","title":"Account","description":"@vocdoni/sdk / Exports / Account","sidebar":"defaultSidebar"},"sdk/reference/classes/AccountAPI":{"id":"sdk/reference/classes/AccountAPI","title":"AccountAPI","description":"@vocdoni/sdk / Exports / AccountAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/AccountService":{"id":"sdk/reference/classes/AccountService","title":"AccountService","description":"@vocdoni/sdk / Exports / AccountService","sidebar":"defaultSidebar"},"sdk/reference/classes/AnonymousService":{"id":"sdk/reference/classes/AnonymousService","title":"AnonymousService","description":"@vocdoni/sdk / Exports / AnonymousService","sidebar":"defaultSidebar"},"sdk/reference/classes/AnonymousVote":{"id":"sdk/reference/classes/AnonymousVote","title":"AnonymousVote","description":"@vocdoni/sdk / Exports / AnonymousVote","sidebar":"defaultSidebar"},"sdk/reference/classes/ApprovalElection":{"id":"sdk/reference/classes/ApprovalElection","title":"ApprovalElection","description":"@vocdoni/sdk / Exports / ApprovalElection","sidebar":"defaultSidebar"},"sdk/reference/classes/ArchivedElection":{"id":"sdk/reference/classes/ArchivedElection","title":"ArchivedElection","description":"@vocdoni/sdk / Exports / ArchivedElection","sidebar":"defaultSidebar"},"sdk/reference/classes/BudgetElection":{"id":"sdk/reference/classes/BudgetElection","title":"BudgetElection","description":"@vocdoni/sdk / Exports / BudgetElection","sidebar":"defaultSidebar"},"sdk/reference/classes/Census":{"id":"sdk/reference/classes/Census","title":"Census","description":"@vocdoni/sdk / Exports / Census","sidebar":"defaultSidebar"},"sdk/reference/classes/Census3CensusAPI":{"id":"sdk/reference/classes/Census3CensusAPI","title":"Census3CensusAPI","description":"@vocdoni/sdk / Exports / Census3CensusAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/Census3ServiceAPI":{"id":"sdk/reference/classes/Census3ServiceAPI","title":"Census3ServiceAPI","description":"@vocdoni/sdk / Exports / Census3ServiceAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/Census3StrategyAPI":{"id":"sdk/reference/classes/Census3StrategyAPI","title":"Census3StrategyAPI","description":"@vocdoni/sdk / Exports / Census3StrategyAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/Census3TokenAPI":{"id":"sdk/reference/classes/Census3TokenAPI","title":"Census3TokenAPI","description":"@vocdoni/sdk / Exports / Census3TokenAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/CensusAPI":{"id":"sdk/reference/classes/CensusAPI","title":"CensusAPI","description":"@vocdoni/sdk / Exports / CensusAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/CensusService":{"id":"sdk/reference/classes/CensusService","title":"CensusService","description":"@vocdoni/sdk / Exports / CensusService","sidebar":"defaultSidebar"},"sdk/reference/classes/ChainAPI":{"id":"sdk/reference/classes/ChainAPI","title":"ChainAPI","description":"@vocdoni/sdk / Exports / ChainAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/ChainService":{"id":"sdk/reference/classes/ChainService","title":"ChainService","description":"@vocdoni/sdk / Exports / ChainService","sidebar":"defaultSidebar"},"sdk/reference/classes/CspCensus":{"id":"sdk/reference/classes/CspCensus","title":"CspCensus","description":"@vocdoni/sdk / Exports / CspCensus","sidebar":"defaultSidebar"},"sdk/reference/classes/CspService":{"id":"sdk/reference/classes/CspService","title":"CspService","description":"@vocdoni/sdk / Exports / CspService","sidebar":"defaultSidebar"},"sdk/reference/classes/CspVote":{"id":"sdk/reference/classes/CspVote","title":"CspVote","description":"@vocdoni/sdk / Exports / CspVote","sidebar":"defaultSidebar"},"sdk/reference/classes/Election":{"id":"sdk/reference/classes/Election","title":"Election","description":"@vocdoni/sdk / Exports / Election","sidebar":"defaultSidebar"},"sdk/reference/classes/ElectionAPI":{"id":"sdk/reference/classes/ElectionAPI","title":"ElectionAPI","description":"@vocdoni/sdk / Exports / ElectionAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/ElectionService":{"id":"sdk/reference/classes/ElectionService","title":"ElectionService","description":"@vocdoni/sdk / Exports / ElectionService","sidebar":"defaultSidebar"},"sdk/reference/classes/FaucetAPI":{"id":"sdk/reference/classes/FaucetAPI","title":"FaucetAPI","description":"@vocdoni/sdk / Exports / FaucetAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/FaucetService":{"id":"sdk/reference/classes/FaucetService","title":"FaucetService","description":"@vocdoni/sdk / Exports / FaucetService","sidebar":"defaultSidebar"},"sdk/reference/classes/FileAPI":{"id":"sdk/reference/classes/FileAPI","title":"FileAPI","description":"@vocdoni/sdk / Exports / FileAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/FileService":{"id":"sdk/reference/classes/FileService","title":"FileService","description":"@vocdoni/sdk / Exports / FileService","sidebar":"defaultSidebar"},"sdk/reference/classes/InvalidElection":{"id":"sdk/reference/classes/InvalidElection","title":"InvalidElection","description":"@vocdoni/sdk / Exports / InvalidElection","sidebar":"defaultSidebar"},"sdk/reference/classes/MultiChoiceElection":{"id":"sdk/reference/classes/MultiChoiceElection","title":"MultiChoiceElection","description":"@vocdoni/sdk / Exports / MultiChoiceElection","sidebar":"defaultSidebar"},"sdk/reference/classes/OffchainCensus":{"id":"sdk/reference/classes/OffchainCensus","title":"OffchainCensus","description":"@vocdoni/sdk / Exports / OffchainCensus","sidebar":"defaultSidebar"},"sdk/reference/classes/PlainCensus":{"id":"sdk/reference/classes/PlainCensus","title":"PlainCensus","description":"@vocdoni/sdk / Exports / PlainCensus","sidebar":"defaultSidebar"},"sdk/reference/classes/PublishedCensus":{"id":"sdk/reference/classes/PublishedCensus","title":"PublishedCensus","description":"@vocdoni/sdk / Exports / PublishedCensus","sidebar":"defaultSidebar"},"sdk/reference/classes/PublishedElection":{"id":"sdk/reference/classes/PublishedElection","title":"PublishedElection","description":"@vocdoni/sdk / Exports / PublishedElection","sidebar":"defaultSidebar"},"sdk/reference/classes/Service":{"id":"sdk/reference/classes/Service","title":"Service","description":"@vocdoni/sdk / Exports / Service","sidebar":"defaultSidebar"},"sdk/reference/classes/TokenCensus":{"id":"sdk/reference/classes/TokenCensus","title":"TokenCensus","description":"@vocdoni/sdk / Exports / TokenCensus","sidebar":"defaultSidebar"},"sdk/reference/classes/UnpublishedElection":{"id":"sdk/reference/classes/UnpublishedElection","title":"UnpublishedElection","description":"@vocdoni/sdk / Exports / UnpublishedElection","sidebar":"defaultSidebar"},"sdk/reference/classes/VocdoniCensus3Client":{"id":"sdk/reference/classes/VocdoniCensus3Client","title":"VocdoniCensus3Client","description":"@vocdoni/sdk / Exports / VocdoniCensus3Client","sidebar":"defaultSidebar"},"sdk/reference/classes/VocdoniSDKClient":{"id":"sdk/reference/classes/VocdoniSDKClient","title":"VocdoniSDKClient","description":"@vocdoni/sdk / Exports / VocdoniSDKClient","sidebar":"defaultSidebar"},"sdk/reference/classes/Vote":{"id":"sdk/reference/classes/Vote","title":"Vote","description":"@vocdoni/sdk / Exports / Vote","sidebar":"defaultSidebar"},"sdk/reference/classes/VoteAPI":{"id":"sdk/reference/classes/VoteAPI","title":"VoteAPI","description":"@vocdoni/sdk / Exports / VoteAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/VoteService":{"id":"sdk/reference/classes/VoteService","title":"VoteService","description":"@vocdoni/sdk / Exports / VoteService","sidebar":"defaultSidebar"},"sdk/reference/classes/WalletAPI":{"id":"sdk/reference/classes/WalletAPI","title":"WalletAPI","description":"@vocdoni/sdk / Exports / WalletAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/WeightedCensus":{"id":"sdk/reference/classes/WeightedCensus","title":"WeightedCensus","description":"@vocdoni/sdk / Exports / WeightedCensus","sidebar":"defaultSidebar"},"sdk/reference/enums/CensusOrigin":{"id":"sdk/reference/enums/CensusOrigin","title":"CensusOrigin","description":"@vocdoni/sdk / Exports / CensusOrigin","sidebar":"defaultSidebar"},"sdk/reference/enums/CensusType":{"id":"sdk/reference/enums/CensusType","title":"CensusType","description":"@vocdoni/sdk / Exports / CensusType","sidebar":"defaultSidebar"},"sdk/reference/enums/CensusTypeEnum":{"id":"sdk/reference/enums/CensusTypeEnum","title":"CensusTypeEnum","description":"@vocdoni/sdk / Exports / CensusTypeEnum","sidebar":"defaultSidebar"},"sdk/reference/enums/CspProofType":{"id":"sdk/reference/enums/CspProofType","title":"CspProofType","description":"@vocdoni/sdk / Exports / CspProofType","sidebar":"defaultSidebar"},"sdk/reference/enums/ElectionCreationSteps":{"id":"sdk/reference/enums/ElectionCreationSteps","title":"ElectionCreationSteps","description":"@vocdoni/sdk / Exports / ElectionCreationSteps","sidebar":"defaultSidebar"},"sdk/reference/enums/ElectionResultsTypeNames":{"id":"sdk/reference/enums/ElectionResultsTypeNames","title":"ElectionResultsTypeNames","description":"@vocdoni/sdk / Exports / ElectionResultsTypeNames","sidebar":"defaultSidebar"},"sdk/reference/enums/ElectionStatus":{"id":"sdk/reference/enums/ElectionStatus","title":"ElectionStatus","description":"@vocdoni/sdk / Exports / ElectionStatus","sidebar":"defaultSidebar"},"sdk/reference/enums/ElectionStatusReady":{"id":"sdk/reference/enums/ElectionStatusReady","title":"ElectionStatusReady","description":"@vocdoni/sdk / Exports / ElectionStatusReady","sidebar":"defaultSidebar"},"sdk/reference/enums/EnvOptions":{"id":"sdk/reference/enums/EnvOptions","title":"EnvOptions","description":"@vocdoni/sdk / Exports / EnvOptions","sidebar":"defaultSidebar"},"sdk/reference/enums/TransactionType":{"id":"sdk/reference/enums/TransactionType","title":"TransactionType","description":"@vocdoni/sdk / Exports / TransactionType","sidebar":"defaultSidebar"},"sdk/reference/enums/TxType":{"id":"sdk/reference/enums/TxType","title":"TxType","description":"@vocdoni/sdk / Exports / TxType","sidebar":"defaultSidebar"},"sdk/reference/enums/VoteSteps":{"id":"sdk/reference/enums/VoteSteps","title":"VoteSteps","description":"@vocdoni/sdk / Exports / VoteSteps","sidebar":"defaultSidebar"},"sdk/reference/interfaces/AccountMetadata":{"id":"sdk/reference/interfaces/AccountMetadata","title":"AccountMetadata","description":"@vocdoni/sdk / Exports / AccountMetadata","sidebar":"defaultSidebar"},"sdk/reference/interfaces/AdminTx":{"id":"sdk/reference/interfaces/AdminTx","title":"AdminTx","description":"@vocdoni/sdk / Exports / AdminTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/CircuitInputs":{"id":"sdk/reference/interfaces/CircuitInputs","title":"CircuitInputs","description":"@vocdoni/sdk / Exports / CircuitInputs","sidebar":"defaultSidebar"},"sdk/reference/interfaces/CollectFaucetTx":{"id":"sdk/reference/interfaces/CollectFaucetTx","title":"CollectFaucetTx","description":"@vocdoni/sdk / Exports / CollectFaucetTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ElectionMetadata":{"id":"sdk/reference/interfaces/ElectionMetadata","title":"ElectionMetadata","description":"@vocdoni/sdk / Exports / ElectionMetadata","sidebar":"defaultSidebar"},"sdk/reference/interfaces/FetchElectionsParameters":{"id":"sdk/reference/interfaces/FetchElectionsParameters","title":"FetchElectionsParameters","description":"@vocdoni/sdk / Exports / FetchElectionsParameters","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IAccount":{"id":"sdk/reference/interfaces/IAccount","title":"IAccount","description":"@vocdoni/sdk / Exports / IAccount","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IAccountsCountResponse":{"id":"sdk/reference/interfaces/IAccountsCountResponse","title":"IAccountsCountResponse","description":"@vocdoni/sdk / Exports / IAccountsCountResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IAccountsListResponse":{"id":"sdk/reference/interfaces/IAccountsListResponse","title":"IAccountsListResponse","description":"@vocdoni/sdk / Exports / IAccountsListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IAccountTransfersCountResponse":{"id":"sdk/reference/interfaces/IAccountTransfersCountResponse","title":"IAccountTransfersCountResponse","description":"@vocdoni/sdk / Exports / IAccountTransfersCountResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IApprovalElectionParameters":{"id":"sdk/reference/interfaces/IApprovalElectionParameters","title":"IApprovalElectionParameters","description":"@vocdoni/sdk / Exports / IApprovalElectionParameters","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IBlockTransactionsResponse":{"id":"sdk/reference/interfaces/IBlockTransactionsResponse","title":"IBlockTransactionsResponse","description":"@vocdoni/sdk / Exports / IBlockTransactionsResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IBudgetElectionParametersInfo":{"id":"sdk/reference/interfaces/IBudgetElectionParametersInfo","title":"IBudgetElectionParametersInfo","description":"@vocdoni/sdk / Exports / IBudgetElectionParametersInfo","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IBudgetElectionParametersWithBudget":{"id":"sdk/reference/interfaces/IBudgetElectionParametersWithBudget","title":"IBudgetElectionParametersWithBudget","description":"@vocdoni/sdk / Exports / IBudgetElectionParametersWithBudget","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight":{"id":"sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight","title":"IBudgetElectionParametersWithCensusWeight","description":"@vocdoni/sdk / Exports / IBudgetElectionParametersWithCensusWeight","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus":{"id":"sdk/reference/interfaces/ICensus","title":"ICensus","description":"@vocdoni/sdk / Exports / ICensus","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3CensusListResponse":{"id":"sdk/reference/interfaces/ICensus3CensusListResponse","title":"ICensus3CensusListResponse","description":"@vocdoni/sdk / Exports / ICensus3CensusListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3CensusQueueResponse":{"id":"sdk/reference/interfaces/ICensus3CensusQueueResponse","title":"ICensus3CensusQueueResponse","description":"@vocdoni/sdk / Exports / ICensus3CensusQueueResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3CensusResponse":{"id":"sdk/reference/interfaces/ICensus3CensusResponse","title":"ICensus3CensusResponse","description":"@vocdoni/sdk / Exports / ICensus3CensusResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3ServiceInfoResponse":{"id":"sdk/reference/interfaces/ICensus3ServiceInfoResponse","title":"ICensus3ServiceInfoResponse","description":"@vocdoni/sdk / Exports / ICensus3ServiceInfoResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategiesListResponse":{"id":"sdk/reference/interfaces/ICensus3StrategiesListResponse","title":"ICensus3StrategiesListResponse","description":"@vocdoni/sdk / Exports / ICensus3StrategiesListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated":{"id":"sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated","title":"ICensus3StrategiesListResponsePaginated","description":"@vocdoni/sdk / Exports / ICensus3StrategiesListResponsePaginated","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategiesOperator":{"id":"sdk/reference/interfaces/ICensus3StrategiesOperator","title":"ICensus3StrategiesOperator","description":"@vocdoni/sdk / Exports / ICensus3StrategiesOperator","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse":{"id":"sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse","title":"ICensus3StrategiesOperatorsResponse","description":"@vocdoni/sdk / Exports / ICensus3StrategiesOperatorsResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategyCreateResponse":{"id":"sdk/reference/interfaces/ICensus3StrategyCreateResponse","title":"ICensus3StrategyCreateResponse","description":"@vocdoni/sdk / Exports / ICensus3StrategyCreateResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse":{"id":"sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse","title":"ICensus3StrategyEstimationQueueResponse","description":"@vocdoni/sdk / Exports / ICensus3StrategyEstimationQueueResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategyHoldersResponse":{"id":"sdk/reference/interfaces/ICensus3StrategyHoldersResponse","title":"ICensus3StrategyHoldersResponse","description":"@vocdoni/sdk / Exports / ICensus3StrategyHoldersResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated":{"id":"sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated","title":"ICensus3StrategyHoldersResponsePaginated","description":"@vocdoni/sdk / Exports / ICensus3StrategyHoldersResponsePaginated","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategyImportQueueResponse":{"id":"sdk/reference/interfaces/ICensus3StrategyImportQueueResponse","title":"ICensus3StrategyImportQueueResponse","description":"@vocdoni/sdk / Exports / ICensus3StrategyImportQueueResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategyToken":{"id":"sdk/reference/interfaces/ICensus3StrategyToken","title":"ICensus3StrategyToken","description":"@vocdoni/sdk / Exports / ICensus3StrategyToken","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3SupportedChain":{"id":"sdk/reference/interfaces/ICensus3SupportedChain","title":"ICensus3SupportedChain","description":"@vocdoni/sdk / Exports / ICensus3SupportedChain","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3TokenHolderResponse":{"id":"sdk/reference/interfaces/ICensus3TokenHolderResponse","title":"ICensus3TokenHolderResponse","description":"@vocdoni/sdk / Exports / ICensus3TokenHolderResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3TokenListResponse":{"id":"sdk/reference/interfaces/ICensus3TokenListResponse","title":"ICensus3TokenListResponse","description":"@vocdoni/sdk / Exports / ICensus3TokenListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3TokenListResponsePaginated":{"id":"sdk/reference/interfaces/ICensus3TokenListResponsePaginated","title":"ICensus3TokenListResponsePaginated","description":"@vocdoni/sdk / Exports / ICensus3TokenListResponsePaginated","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3TokenTypesResponse":{"id":"sdk/reference/interfaces/ICensus3TokenTypesResponse","title":"ICensus3TokenTypesResponse","description":"@vocdoni/sdk / Exports / ICensus3TokenTypesResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3ValidatePredicateChild":{"id":"sdk/reference/interfaces/ICensus3ValidatePredicateChild","title":"ICensus3ValidatePredicateChild","description":"@vocdoni/sdk / Exports / ICensus3ValidatePredicateChild","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3ValidatePredicateResponse":{"id":"sdk/reference/interfaces/ICensus3ValidatePredicateResponse","title":"ICensus3ValidatePredicateResponse","description":"@vocdoni/sdk / Exports / ICensus3ValidatePredicateResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3ValidatePredicateToken":{"id":"sdk/reference/interfaces/ICensus3ValidatePredicateToken","title":"ICensus3ValidatePredicateToken","description":"@vocdoni/sdk / Exports / ICensus3ValidatePredicateToken","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensusExportResponse":{"id":"sdk/reference/interfaces/ICensusExportResponse","title":"ICensusExportResponse","description":"@vocdoni/sdk / Exports / ICensusExportResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensusImportResponse":{"id":"sdk/reference/interfaces/ICensusImportResponse","title":"ICensusImportResponse","description":"@vocdoni/sdk / Exports / ICensusImportResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensusParticipant":{"id":"sdk/reference/interfaces/ICensusParticipant","title":"ICensusParticipant","description":"@vocdoni/sdk / Exports / ICensusParticipant","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensusProofResponse":{"id":"sdk/reference/interfaces/ICensusProofResponse","title":"ICensusProofResponse","description":"@vocdoni/sdk / Exports / ICensusProofResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensusPublishResponse":{"id":"sdk/reference/interfaces/ICensusPublishResponse","title":"ICensusPublishResponse","description":"@vocdoni/sdk / Exports / ICensusPublishResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainBlockInfoResponse":{"id":"sdk/reference/interfaces/IChainBlockInfoResponse","title":"IChainBlockInfoResponse","description":"@vocdoni/sdk / Exports / IChainBlockInfoResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainGetCircuitResponse":{"id":"sdk/reference/interfaces/IChainGetCircuitResponse","title":"IChainGetCircuitResponse","description":"@vocdoni/sdk / Exports / IChainGetCircuitResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainGetCostsResponse":{"id":"sdk/reference/interfaces/IChainGetCostsResponse","title":"IChainGetCostsResponse","description":"@vocdoni/sdk / Exports / IChainGetCostsResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainGetInfoResponse":{"id":"sdk/reference/interfaces/IChainGetInfoResponse","title":"IChainGetInfoResponse","description":"@vocdoni/sdk / Exports / IChainGetInfoResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainOrganizationCountResponse":{"id":"sdk/reference/interfaces/IChainOrganizationCountResponse","title":"IChainOrganizationCountResponse","description":"@vocdoni/sdk / Exports / IChainOrganizationCountResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainOrganizationListResponse":{"id":"sdk/reference/interfaces/IChainOrganizationListResponse","title":"IChainOrganizationListResponse","description":"@vocdoni/sdk / Exports / IChainOrganizationListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainOrganizationResponse":{"id":"sdk/reference/interfaces/IChainOrganizationResponse","title":"IChainOrganizationResponse","description":"@vocdoni/sdk / Exports / IChainOrganizationResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainSubmitTxResponse":{"id":"sdk/reference/interfaces/IChainSubmitTxResponse","title":"IChainSubmitTxResponse","description":"@vocdoni/sdk / Exports / IChainSubmitTxResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainTxCountResponse":{"id":"sdk/reference/interfaces/IChainTxCountResponse","title":"IChainTxCountResponse","description":"@vocdoni/sdk / Exports / IChainTxCountResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainTxListResponse":{"id":"sdk/reference/interfaces/IChainTxListResponse","title":"IChainTxListResponse","description":"@vocdoni/sdk / Exports / IChainTxListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainTxReference":{"id":"sdk/reference/interfaces/IChainTxReference","title":"IChainTxReference","description":"@vocdoni/sdk / Exports / IChainTxReference","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainValidator":{"id":"sdk/reference/interfaces/IChainValidator","title":"IChainValidator","description":"@vocdoni/sdk / Exports / IChainValidator","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainValidatorsListResponse":{"id":"sdk/reference/interfaces/IChainValidatorsListResponse","title":"IChainValidatorsListResponse","description":"@vocdoni/sdk / Exports / IChainValidatorsListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChoice":{"id":"sdk/reference/interfaces/IChoice","title":"IChoice","description":"@vocdoni/sdk / Exports / IChoice","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionCreateResponse":{"id":"sdk/reference/interfaces/IElectionCreateResponse","title":"IElectionCreateResponse","description":"@vocdoni/sdk / Exports / IElectionCreateResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionInfoResponse":{"id":"sdk/reference/interfaces/IElectionInfoResponse","title":"IElectionInfoResponse","description":"@vocdoni/sdk / Exports / IElectionInfoResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionKeysResponse":{"id":"sdk/reference/interfaces/IElectionKeysResponse","title":"IElectionKeysResponse","description":"@vocdoni/sdk / Exports / IElectionKeysResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionListFilter":{"id":"sdk/reference/interfaces/IElectionListFilter","title":"IElectionListFilter","description":"@vocdoni/sdk / Exports / IElectionListFilter","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionListResponse":{"id":"sdk/reference/interfaces/IElectionListResponse","title":"IElectionListResponse","description":"@vocdoni/sdk / Exports / IElectionListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionMode":{"id":"sdk/reference/interfaces/IElectionMode","title":"IElectionMode","description":"@vocdoni/sdk / Exports / IElectionMode","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionNextIdResponse":{"id":"sdk/reference/interfaces/IElectionNextIdResponse","title":"IElectionNextIdResponse","description":"@vocdoni/sdk / Exports / IElectionNextIdResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionParameters":{"id":"sdk/reference/interfaces/IElectionParameters","title":"IElectionParameters","description":"@vocdoni/sdk / Exports / IElectionParameters","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionSummary":{"id":"sdk/reference/interfaces/IElectionSummary","title":"IElectionSummary","description":"@vocdoni/sdk / Exports / IElectionSummary","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionType":{"id":"sdk/reference/interfaces/IElectionType","title":"IElectionType","description":"@vocdoni/sdk / Exports / IElectionType","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionVote":{"id":"sdk/reference/interfaces/IElectionVote","title":"IElectionVote","description":"@vocdoni/sdk / Exports / IElectionVote","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionVoteListResponse":{"id":"sdk/reference/interfaces/IElectionVoteListResponse","title":"IElectionVoteListResponse","description":"@vocdoni/sdk / Exports / IElectionVoteListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IEncryptionKey":{"id":"sdk/reference/interfaces/IEncryptionKey","title":"IEncryptionKey","description":"@vocdoni/sdk / Exports / IEncryptionKey","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IInvalidElectionParameters":{"id":"sdk/reference/interfaces/IInvalidElectionParameters","title":"IInvalidElectionParameters","description":"@vocdoni/sdk / Exports / IInvalidElectionParameters","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IMultiChoiceElectionParameters":{"id":"sdk/reference/interfaces/IMultiChoiceElectionParameters","title":"IMultiChoiceElectionParameters","description":"@vocdoni/sdk / Exports / IMultiChoiceElectionParameters","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IPublishedElectionParameters":{"id":"sdk/reference/interfaces/IPublishedElectionParameters","title":"IPublishedElectionParameters","description":"@vocdoni/sdk / Exports / IPublishedElectionParameters","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IQuestion":{"id":"sdk/reference/interfaces/IQuestion","title":"IQuestion","description":"@vocdoni/sdk / Exports / IQuestion","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ITallyMode":{"id":"sdk/reference/interfaces/ITallyMode","title":"ITallyMode","description":"@vocdoni/sdk / Exports / ITallyMode","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IVoteInfoResponse":{"id":"sdk/reference/interfaces/IVoteInfoResponse","title":"IVoteInfoResponse","description":"@vocdoni/sdk / Exports / IVoteInfoResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IVoteMode":{"id":"sdk/reference/interfaces/IVoteMode","title":"IVoteMode","description":"@vocdoni/sdk / Exports / IVoteMode","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IVoteSubmitResponse":{"id":"sdk/reference/interfaces/IVoteSubmitResponse","title":"IVoteSubmitResponse","description":"@vocdoni/sdk / Exports / IVoteSubmitResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IVoteType":{"id":"sdk/reference/interfaces/IVoteType","title":"IVoteType","description":"@vocdoni/sdk / Exports / IVoteType","sidebar":"defaultSidebar"},"sdk/reference/interfaces/MintTokensTx":{"id":"sdk/reference/interfaces/MintTokensTx","title":"MintTokensTx","description":"@vocdoni/sdk / Exports / MintTokensTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/NewProcessTx":{"id":"sdk/reference/interfaces/NewProcessTx","title":"NewProcessTx","description":"@vocdoni/sdk / Exports / NewProcessTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/Process":{"id":"sdk/reference/interfaces/Process","title":"Process","description":"@vocdoni/sdk / Exports / Process","sidebar":"defaultSidebar"},"sdk/reference/interfaces/Proof":{"id":"sdk/reference/interfaces/Proof","title":"Proof","description":"@vocdoni/sdk / Exports / Proof","sidebar":"defaultSidebar"},"sdk/reference/interfaces/RegisterKeyTx":{"id":"sdk/reference/interfaces/RegisterKeyTx","title":"RegisterKeyTx","description":"@vocdoni/sdk / Exports / RegisterKeyTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/SendTokensTx":{"id":"sdk/reference/interfaces/SendTokensTx","title":"SendTokensTx","description":"@vocdoni/sdk / Exports / SendTokensTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ServiceProperties":{"id":"sdk/reference/interfaces/ServiceProperties","title":"ServiceProperties","description":"@vocdoni/sdk / Exports / ServiceProperties","sidebar":"defaultSidebar"},"sdk/reference/interfaces/SetAccountTx":{"id":"sdk/reference/interfaces/SetAccountTx","title":"SetAccountTx","description":"@vocdoni/sdk / Exports / SetAccountTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/SetProcessTx":{"id":"sdk/reference/interfaces/SetProcessTx","title":"SetProcessTx","description":"@vocdoni/sdk / Exports / SetProcessTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/SetTransactionCostsTx":{"id":"sdk/reference/interfaces/SetTransactionCostsTx","title":"SetTransactionCostsTx","description":"@vocdoni/sdk / Exports / SetTransactionCostsTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/Tx":{"id":"sdk/reference/interfaces/Tx","title":"Tx","description":"@vocdoni/sdk / Exports / Tx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/VoteEnvelope":{"id":"sdk/reference/interfaces/VoteEnvelope","title":"VoteEnvelope","description":"@vocdoni/sdk / Exports / VoteEnvelope","sidebar":"defaultSidebar"},"sdk/reference/modules":{"id":"sdk/reference/modules","title":"modules","description":"@vocdoni/sdk / Exports","sidebar":"defaultSidebar"},"sdk/tutorial":{"id":"sdk/tutorial","title":"SDK Tutorial","description":"This tutorial will show you how to get your environment set up, start using the SDK, and create and vote in an election. We will be using typescript.","sidebar":"defaultSidebar"},"sdk/voting-types/approval":{"id":"sdk/voting-types/approval","title":"Approval Voting (Multiple Choice)","description":"An election with Approval voting is a voting system where voters are allowed to indicate their support for multiple","sidebar":"defaultSidebar"},"sdk/voting-types/quadratic":{"id":"sdk/voting-types/quadratic","title":"Quadratic voting","description":"Quadratic voting is a voting mechanism that allows individuals to express their preferences on different issues with","sidebar":"defaultSidebar"},"sdk/voting-types/ranked":{"id":"sdk/voting-types/ranked","title":"Ranked Voting","description":"Ranked voting, also known as preferential voting or ranked-choice voting (RCV), is an electoral system where voters rank","sidebar":"defaultSidebar"},"sdk/voting-types/single-choice":{"id":"sdk/voting-types/single-choice","title":"Single Choice Voting","description":"An election with a single-choice result, also known as First-past-the-post voting (FPTP or FPP) or informally called","sidebar":"defaultSidebar"},"sdk/voting-types/voting-types":{"id":"sdk/voting-types/voting-types","title":"Voting Types","description":"In this section, we will provide a brief overview of the different types of voting supported by the Vocdoni protocol and","sidebar":"defaultSidebar"},"sdk/voting-types/weighted":{"id":"sdk/voting-types/weighted","title":"Weighted voting","description":"Weighted voting is a voting system where each voter is assigned a specific weight or value that reflects their relative influence or importance in the decision-making process.","sidebar":"defaultSidebar"},"ui-components/Election":{"id":"ui-components/Election","title":"Election components","description":"Vocdoni Chakra components for Elections","sidebar":"defaultSidebar"},"ui-components/index":{"id":"ui-components/index","title":"UI Components","description":"Vocdoni Chakra components","sidebar":"defaultSidebar"},"ui-components/Organization":{"id":"ui-components/Organization","title":"Organization components","description":"Vocdoni Chakra components for Organizations","sidebar":"defaultSidebar"},"vocdoni-api/accounts":{"id":"vocdoni-api/accounts","title":"Accounts","description":"Accounts","sidebar":"defaultSidebar"},"vocdoni-api/add-account":{"id":"vocdoni-api/add-account","title":"Add account","description":"Add a new account to the local store. It returns a token used to manage this account on the future.","sidebar":"defaultSidebar"},"vocdoni-api/add-participants-to-census":{"id":"vocdoni-api/add-participants-to-census","title":"Add participants to census","description":"Add list of public key/address with its weight to an unpublished census and returns the resulting","sidebar":"defaultSidebar"},"vocdoni-api/census-merkle-root":{"id":"vocdoni-api/census-merkle-root","title":"Census Merkle Root","description":"Get census [Merkle Tree root](https://docs.vocdoni.io/architecture/census/off-chain-tree.html) hash, used to identify the census at specific snapshot.\\n\\n- Bearer token not required","sidebar":"defaultSidebar"},"vocdoni-api/census-size":{"id":"vocdoni-api/census-size","title":"Census size","description":"Total number of keys added to the census. Size as integer","sidebar":"defaultSidebar"},"vocdoni-api/census-total-weight":{"id":"vocdoni-api/census-total-weight","title":"Census total weight","description":"It sums all weights added to the census. Weight is a stringified bigInt","sidebar":"defaultSidebar"},"vocdoni-api/censuses":{"id":"vocdoni-api/censuses","title":"Censuses","description":"Censuses","sidebar":"defaultSidebar"},"vocdoni-api/chain":{"id":"vocdoni-api/chain","title":"Chain","description":"Chain","sidebar":"defaultSidebar"},"vocdoni-api/circuit-info":{"id":"vocdoni-api/circuit-info","title":"Circuit info","description":"Returns the circuit configuration according to the current circuit","sidebar":"defaultSidebar"},"vocdoni-api/compute-election-price":{"id":"vocdoni-api/compute-election-price","title":"Compute election price","description":"Helper endpoint to get the election price.","sidebar":"defaultSidebar"},"vocdoni-api/compute-ipfs-ci-dv-1-of-file":{"id":"vocdoni-api/compute-ipfs-ci-dv-1-of-file","title":"Compute IPFS CIDv1 of file","description":"Helper endpoint to get the IPFS CIDv1 hash of a file","sidebar":"defaultSidebar"},"vocdoni-api/count-election-votes":{"id":"vocdoni-api/count-election-votes","title":"Count election votes","description":"Get the number of votes for an election","sidebar":"defaultSidebar"},"vocdoni-api/count-organization-elections":{"id":"vocdoni-api/count-organization-elections","title":"Count organization elections","description":"Returns the number of elections for an organization","sidebar":"defaultSidebar"},"vocdoni-api/count-organizations":{"id":"vocdoni-api/count-organizations","title":"Count organizations","description":"Return the number of organizations","sidebar":"defaultSidebar"},"vocdoni-api/create-a-new-census":{"id":"vocdoni-api/create-a-new-census","title":"Create a new census","description":"Create a new census on the backend side. The census is still unpublished until [publish](publish-census) is called.","sidebar":"defaultSidebar"},"vocdoni-api/create-election":{"id":"vocdoni-api/create-election","title":"Create election","description":"It creates an election on the Vochain.","sidebar":"defaultSidebar"},"vocdoni-api/create-election-for-wallet":{"id":"vocdoni-api/create-election-for-wallet","title":"Create election for wallet","description":"Creates an election. Requires the bearer token of the account you want to create the election.","sidebar":"defaultSidebar"},"vocdoni-api/delete-census":{"id":"vocdoni-api/delete-census","title":"Delete census","description":"Delete unpublished census (not on the storage yet). See [publish census](census-publish)\\n","sidebar":"defaultSidebar"},"vocdoni-api/election-information":{"id":"vocdoni-api/election-information","title":"Election information","description":"Get full election information","sidebar":"defaultSidebar"},"vocdoni-api/election-results":{"id":"vocdoni-api/election-results","title":"Election results","description":"Returns a given election consensus results and useful information about the results. Results represented with BigInt strings.","sidebar":"defaultSidebar"},"vocdoni-api/elections":{"id":"vocdoni-api/elections","title":"Elections","description":"Elections","sidebar":"defaultSidebar"},"vocdoni-api/estimate-block-to-date":{"id":"vocdoni-api/estimate-block-to-date","title":"Estimate block to date","description":"Returns the estimated timestamp for the block height provided","sidebar":"defaultSidebar"},"vocdoni-api/estimate-date-to-block":{"id":"vocdoni-api/estimate-date-to-block","title":"Estimate date to block","description":"Returns the estimated block height for the timestamp provided","sidebar":"defaultSidebar"},"vocdoni-api/export-census":{"id":"vocdoni-api/export-census","title":"Export census","description":"Export census to JSON format. Requires Bearer token","sidebar":"defaultSidebar"},"vocdoni-api/export-census-database":{"id":"vocdoni-api/export-census-database","title":"Export census database","description":"Export the whole census database to a JSON file. Requires Admin Bearer token.","sidebar":"defaultSidebar"},"vocdoni-api/exports-the-indexer-database":{"id":"vocdoni-api/exports-the-indexer-database","title":"Exports the indexer database","description":"Exports the indexer SQL database in raw format","sidebar":"defaultSidebar"},"vocdoni-api/get-account":{"id":"vocdoni-api/get-account","title":"Get account","description":"Get account information by its address or public key. The `infoURI` parameter contain where account metadata is uploaded (like avatar, name...). It return also an already parsed \'metadata\' object from this infoUri.","sidebar":"defaultSidebar"},"vocdoni-api/get-block-by-hash":{"id":"vocdoni-api/get-block-by-hash","title":"Get block (by hash)","description":"Returns the block from the given hash","sidebar":"defaultSidebar"},"vocdoni-api/get-block-by-height":{"id":"vocdoni-api/get-block-by-height","title":"Get block (by height)","description":"Returns the full block information at the given height","sidebar":"defaultSidebar"},"vocdoni-api/get-next-election-id":{"id":"vocdoni-api/get-next-election-id","title":"Get next election ID","description":"nextElectionIDHandler","sidebar":"defaultSidebar"},"vocdoni-api/get-type-of-census":{"id":"vocdoni-api/get-type-of-census","title":"Get type of census","description":"Get the census type","sidebar":"defaultSidebar"},"vocdoni-api/get-vote":{"id":"vocdoni-api/get-vote","title":"Get vote","description":"Get the content of an existing Vote. If is an encrypted election it return the `encryptionKeys` indexes and the package will be codified.","sidebar":"defaultSidebar"},"vocdoni-api/import-census":{"id":"vocdoni-api/import-census","title":"Import census","description":"Import census from JSON previously exported using [`/censuses/{censusId}/export`](census-export). Requires Bearer token","sidebar":"defaultSidebar"},"vocdoni-api/import-census-database":{"id":"vocdoni-api/import-census-database","title":"Import census database","description":"Import the whole census database from a JSON file.","sidebar":"defaultSidebar"},"vocdoni-api/list-account-received-and-sent-token-transfers":{"id":"vocdoni-api/list-account-received-and-sent-token-transfers","title":"List account received and sent token transfers","description":"Returns the token transfers for an account. A transfer is a token transference from one account to other (excepting the burn address).","sidebar":"defaultSidebar"},"vocdoni-api/list-account-token-fees":{"id":"vocdoni-api/list-account-token-fees","title":"List account token fees","description":"Returns the token fees for an account. A spending is an amount of tokens burnt from one account for executing transactions.","sidebar":"defaultSidebar"},"vocdoni-api/list-all-census-references":{"id":"vocdoni-api/list-all-census-references","title":"List all census references","description":"List all census references. Requires Admin Bearer token.","sidebar":"defaultSidebar"},"vocdoni-api/list-all-token-fees":{"id":"vocdoni-api/list-all-token-fees","title":"List all token fees","description":"Returns the token fees list ordered by date. A spending is an amount of tokens burnt from one account for executing transactions.","sidebar":"defaultSidebar"},"vocdoni-api/list-all-token-fees-by-reference":{"id":"vocdoni-api/list-all-token-fees-by-reference","title":"List all token fees by reference","description":"Returns the token fees list filtered by reference and ordered by date. A spending is an amount of tokens burnt from one account for executing transactions.","sidebar":"defaultSidebar"},"vocdoni-api/list-all-token-fees-by-type":{"id":"vocdoni-api/list-all-token-fees-by-type","title":"List all token fees by type","description":"Returns the token fees list filtered by type and ordered by date. A spending is an amount of tokens burnt from one account for executing transactions.","sidebar":"defaultSidebar"},"vocdoni-api/list-election-votes":{"id":"vocdoni-api/list-election-votes","title":"List election votes","description":"Returns the list of voteIDs for an election (paginated)","sidebar":"defaultSidebar"},"vocdoni-api/list-elections":{"id":"vocdoni-api/list-elections","title":"List elections","description":"Get a list of elections summaries.","sidebar":"defaultSidebar"},"vocdoni-api/list-elections-filtered":{"id":"vocdoni-api/list-elections-filtered","title":"List elections (filtered)","description":"Return a filtered elections list, the available filters have to be sent on the request body. Available are:","sidebar":"defaultSidebar"},"vocdoni-api/list-encryption-keys":{"id":"vocdoni-api/list-encryption-keys","title":"List encryption keys","description":"Returns the list of public/private encryption keys","sidebar":"defaultSidebar"},"vocdoni-api/list-of-the-existing-accounts":{"id":"vocdoni-api/list-of-the-existing-accounts","title":"List of the existing accounts","description":"Returns information (address, balance and nonce) of the existing accounts","sidebar":"defaultSidebar"},"vocdoni-api/list-of-valid-sik-roots":{"id":"vocdoni-api/list-of-valid-sik-roots","title":"List of valid SIK roots","description":"Returns the list of currently valid roots of the merkle tree where the vochain account SIK\'s are stored.","sidebar":"defaultSidebar"},"vocdoni-api/list-organization-elections":{"id":"vocdoni-api/list-organization-elections","title":"List organization elections","description":"List the elections of an organization","sidebar":"defaultSidebar"},"vocdoni-api/list-organization-elections-by-status":{"id":"vocdoni-api/list-organization-elections-by-status","title":"List organization elections by status","description":"List the elections of an organization by status","sidebar":"defaultSidebar"},"vocdoni-api/list-organizations":{"id":"vocdoni-api/list-organizations","title":"List organizations","description":"An **Organizations** is an account with `infoUri` that contains organization associated metadata.","sidebar":"defaultSidebar"},"vocdoni-api/list-organizations-filtered":{"id":"vocdoni-api/list-organizations-filtered","title":"List organizations (filtered)","description":"Returns a list of organizations filtered by its partial id, paginated by the given page","sidebar":"defaultSidebar"},"vocdoni-api/list-transactions":{"id":"vocdoni-api/list-transactions","title":"List Transactions","description":"To get full transaction information use [/chain/transaction/{blockHeight}/{txIndex}](transaction-by-block-index).\\nWhere transactionIndex is the index of the transaction on the containing block.","sidebar":"defaultSidebar"},"vocdoni-api/list-validators":{"id":"vocdoni-api/list-validators","title":"List validators","description":"Returns the list of validators","sidebar":"defaultSidebar"},"vocdoni-api/price-factors-information":{"id":"vocdoni-api/price-factors-information","title":"Price factors information","description":"Package electionprice provides a mechanism for calculating the price of an election based on its characteristics.","sidebar":"defaultSidebar"},"vocdoni-api/prove-key-to-census":{"id":"vocdoni-api/prove-key-to-census","title":"Prove key to census","description":"Prove the key and weight belong to the census root hash.","sidebar":"defaultSidebar"},"vocdoni-api/publish-census":{"id":"vocdoni-api/publish-census","title":"Publish census","description":"Register a census to the storage (IPFS in our case). After this, the census can\'t be edited.","sidebar":"defaultSidebar"},"vocdoni-api/publish-census-at-root":{"id":"vocdoni-api/publish-census-at-root","title":"Publish census at root","description":"Register a census to the storage (IPFS in our case). After this, the census can\'t be edited.","sidebar":"defaultSidebar"},"vocdoni-api/returns-if-the-address-provided-has-a-valid-sik":{"id":"vocdoni-api/returns-if-the-address-provided-has-a-valid-sik","title":"Returns if the address provided has a valid SIK","description":"Returns if the address provided, associated to an a registered account or not, has a valid SIK already registered or not.","sidebar":"defaultSidebar"},"vocdoni-api/set-account":{"id":"vocdoni-api/set-account","title":"Set account","description":"It register an account to the blockchain including IPFS metadata upload.","sidebar":"defaultSidebar"},"vocdoni-api/set-wallet-account":{"id":"vocdoni-api/set-wallet-account","title":"Set wallet account","description":"Set a new account. Needed the bearer token associated the account.","sidebar":"defaultSidebar"},"vocdoni-api/sik":{"id":"vocdoni-api/sik","title":"SIK","description":"SIK","sidebar":"defaultSidebar"},"vocdoni-api/submit-a-vote":{"id":"vocdoni-api/submit-a-vote","title":"Submit a vote","description":"Submit a vote using a protobuf signed transaction. The corresponding result are the vote id and transaction hash where the vote is registered.","sidebar":"defaultSidebar"},"vocdoni-api/submit-transaction":{"id":"vocdoni-api/submit-transaction","title":"Submit transaction","description":"It submit a transaction. Depending of transaction type will return different kinds of responses:","sidebar":"defaultSidebar"},"vocdoni-api/total-number-of-accounts":{"id":"vocdoni-api/total-number-of-accounts","title":"Total number of accounts","description":"Returns the count of total number of existing accounts","sidebar":"defaultSidebar"},"vocdoni-api/total-number-of-sent-and-received-transactions":{"id":"vocdoni-api/total-number-of-sent-and-received-transactions","title":"Total number of sent and received transactions","description":"Returns the count of total number of sent and received transactions for an account. A transaction is a token transfer from one account to another existing account","sidebar":"defaultSidebar"},"vocdoni-api/transaction-by-block-height-and-index":{"id":"vocdoni-api/transaction-by-block-height-and-index","title":"Transaction by block height and index","description":"Get transaction full information by block height and index. It returns JSON transaction protobuf encoded. Depending of transaction type will return different types of objects. Current transaction types can be found calling `/chain/transactions/cost`","sidebar":"defaultSidebar"},"vocdoni-api/transaction-by-hash":{"id":"vocdoni-api/transaction-by-hash","title":"Transaction by hash","description":"Using transaction hash it return the `block` and `index` containing that contains the transaction. After, you could use this `block` and `index` to retrieve transaction full info using [transaction by block and index](transaction-by-block-index)","sidebar":"defaultSidebar"},"vocdoni-api/transaction-by-index":{"id":"vocdoni-api/transaction-by-index","title":"Transaction by index","description":"Get transaction by its index. This is not transaction reference (hash), and neither the block height and block index. The transaction index is an incremental counter for each transaction. You could use the transaction `block` and `index` to retrieve full info using [transaction by block and index](transaction-by-block-index).","sidebar":"defaultSidebar"},"vocdoni-api/transaction-costs":{"id":"vocdoni-api/transaction-costs","title":"Transaction costs","description":"Returns the list of transactions and its cost","sidebar":"defaultSidebar"},"vocdoni-api/transactions-count":{"id":"vocdoni-api/transactions-count","title":"Transactions count","description":"Returns the number of transactions","sidebar":"defaultSidebar"},"vocdoni-api/transactions-in-a-block":{"id":"vocdoni-api/transactions-in-a-block","title":"Transactions in a block","description":"Given a block returns the list of transactions for that block","sidebar":"defaultSidebar"},"vocdoni-api/transfer-tokens":{"id":"vocdoni-api/transfer-tokens","title":"Transfer tokens","description":"Transfer balance to another account. Needed the bearer token associated the account.","sidebar":"defaultSidebar"},"vocdoni-api/verify-merkle-proof":{"id":"vocdoni-api/verify-merkle-proof","title":"Verify merkle proof","description":"Verify that a previously obtained Merkle proof for a key, acquired via [/censuses/{censusId}/proof/{publicKey}](prove-key-to-census) is still correct.","sidebar":"defaultSidebar"},"vocdoni-api/verify-vote":{"id":"vocdoni-api/verify-vote","title":"Verify vote","description":"Check if vote is registered on the blockchain on specific election. Just return Ok status code","sidebar":"defaultSidebar"},"vocdoni-api/vocdoni-api":{"id":"vocdoni-api/vocdoni-api","title":"Vocdoni API","description":"The Vocdoni API is a REST API that substitutes the previous RPCs in order to make it easier for developers/integrators to build on top of the voting protocol. This API facilitates creating votings using Vocdoni, without the hassle of learning a complex blockchain platform, allowing to perform all the features that enable the voting protocol such as creating an account, entity, voting process, census & vote, abstracting as much as possible the complexity and offering simple and straightforward methods to perform those actions.","sidebar":"defaultSidebar"},"vocdoni-api/vochain-information":{"id":"vocdoni-api/vochain-information","title":"Vochain information","description":"Return basic Vocdoni Blockchain (Vochain) information like blockTime, chainId, current height...","sidebar":"defaultSidebar"},"vocdoni-api/votes":{"id":"vocdoni-api/votes","title":"Votes","description":"Votes","sidebar":"defaultSidebar"},"vocdoni-api/wallet":{"id":"vocdoni-api/wallet","title":"Wallet","description":"Wallet","sidebar":"defaultSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.fcc23445.js b/assets/js/935f2afb.fcc23445.js new file mode 100644 index 000000000..a30630370 --- /dev/null +++ b/assets/js/935f2afb.fcc23445.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"defaultSidebar":[{"type":"link","label":"Getting Started","href":"/intro","docId":"intro"},{"type":"category","label":"Vocdoni Protocol","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Anonymous Voting","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"CSP Blind Signatures","href":"/protocol/anonymity/blind-signatures","docId":"protocol/anonymity/blind-signatures"},{"type":"link","label":"On-Chain Census Anonymity","href":"/protocol/anonymity/on-chain","docId":"protocol/anonymity/on-chain"},{"type":"link","label":"Off-Chain Tree ZK Census Proof","href":"/protocol/anonymity/zk-census-proof","docId":"protocol/anonymity/zk-census-proof"}],"href":"/protocol/anonymity/"},{"type":"link","label":"Ballot Protocol","href":"/protocol/ballot-protocol","docId":"protocol/ballot-protocol"},{"type":"category","label":"The Census","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Off-Chain CSP Census","href":"/protocol/census/off-chain-csp","docId":"protocol/census/off-chain-csp"},{"type":"link","label":"Off-Chain Tree Census","href":"/protocol/census/off-chain-tree","docId":"protocol/census/off-chain-tree"},{"type":"link","label":"On-Chain Census","href":"/protocol/census/on-chain","docId":"protocol/census/on-chain"}],"href":"/protocol/census/"},{"type":"category","label":"Data Schemes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Election Metadata","href":"/protocol/data-schemes/election","docId":"protocol/data-schemes/election"},{"type":"link","label":"Organization Metadata","href":"/protocol/data-schemes/organization","docId":"protocol/data-schemes/organization"},{"type":"link","label":"Vote Data","href":"/protocol/data-schemes/vote","docId":"protocol/data-schemes/vote"}],"href":"/protocol/data-schemes/"}],"href":"/protocol/"},{"type":"category","label":"Vocdoni SDK","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"SDK Tutorial","href":"/sdk/tutorial","docId":"sdk/tutorial"},{"type":"category","label":"Integration Details","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Census Types","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Off-chain Credential Service Provider","href":"/sdk/integration-details/census-types/off-chain-csp","docId":"sdk/integration-details/census-types/off-chain-csp"},{"type":"link","label":"Off-chain Merkle Tree","href":"/sdk/integration-details/census-types/off-chain-tree","docId":"sdk/integration-details/census-types/off-chain-tree"},{"type":"category","label":"On-chain Token-Based Census","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Complex Census","href":"/sdk/integration-details/census-types/on-chain/complex-census","docId":"sdk/integration-details/census-types/on-chain/complex-census"}],"href":"/sdk/integration-details/census-types/on-chain/"}],"href":"/sdk/integration-details/census-types/"},{"type":"link","label":"Vocdoni Tokens","href":"/sdk/integration-details/vocdoni-tokens","docId":"sdk/integration-details/vocdoni-tokens"},{"type":"category","label":"Voting Types","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Single Choice Voting","href":"/sdk/integration-details/voting-types/single-choice","docId":"sdk/integration-details/voting-types/single-choice"},{"type":"link","label":"Ranked Voting","href":"/sdk/integration-details/voting-types/ranked","docId":"sdk/integration-details/voting-types/ranked"},{"type":"link","label":"Approval Voting (Multiple Choice)","href":"/sdk/integration-details/voting-types/approval","docId":"sdk/integration-details/voting-types/approval"},{"type":"link","label":"Weighted voting","href":"/sdk/integration-details/voting-types/weighted","docId":"sdk/integration-details/voting-types/weighted"},{"type":"link","label":"Quadratic voting","href":"/sdk/integration-details/voting-types/quadratic","docId":"sdk/integration-details/voting-types/quadratic"}],"href":"/sdk/integration-details/voting-types/"}],"href":"/sdk/integration-details/"},{"type":"category","label":"Reference","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Account","href":"/sdk/reference/classes/Account","docId":"sdk/reference/classes/Account"},{"type":"link","label":"AccountAPI","href":"/sdk/reference/classes/AccountAPI","docId":"sdk/reference/classes/AccountAPI"},{"type":"link","label":"AccountService","href":"/sdk/reference/classes/AccountService","docId":"sdk/reference/classes/AccountService"},{"type":"link","label":"AnonymousService","href":"/sdk/reference/classes/AnonymousService","docId":"sdk/reference/classes/AnonymousService"},{"type":"link","label":"AnonymousVote","href":"/sdk/reference/classes/AnonymousVote","docId":"sdk/reference/classes/AnonymousVote"},{"type":"link","label":"ApprovalElection","href":"/sdk/reference/classes/ApprovalElection","docId":"sdk/reference/classes/ApprovalElection"},{"type":"link","label":"ArchivedElection","href":"/sdk/reference/classes/ArchivedElection","docId":"sdk/reference/classes/ArchivedElection"},{"type":"link","label":"BudgetElection","href":"/sdk/reference/classes/BudgetElection","docId":"sdk/reference/classes/BudgetElection"},{"type":"link","label":"Census","href":"/sdk/reference/classes/Census","docId":"sdk/reference/classes/Census"},{"type":"link","label":"Census3CensusAPI","href":"/sdk/reference/classes/Census3CensusAPI","docId":"sdk/reference/classes/Census3CensusAPI"},{"type":"link","label":"Census3ServiceAPI","href":"/sdk/reference/classes/Census3ServiceAPI","docId":"sdk/reference/classes/Census3ServiceAPI"},{"type":"link","label":"Census3StrategyAPI","href":"/sdk/reference/classes/Census3StrategyAPI","docId":"sdk/reference/classes/Census3StrategyAPI"},{"type":"link","label":"Census3TokenAPI","href":"/sdk/reference/classes/Census3TokenAPI","docId":"sdk/reference/classes/Census3TokenAPI"},{"type":"link","label":"CensusAPI","href":"/sdk/reference/classes/CensusAPI","docId":"sdk/reference/classes/CensusAPI"},{"type":"link","label":"CensusService","href":"/sdk/reference/classes/CensusService","docId":"sdk/reference/classes/CensusService"},{"type":"link","label":"ChainAPI","href":"/sdk/reference/classes/ChainAPI","docId":"sdk/reference/classes/ChainAPI"},{"type":"link","label":"ChainService","href":"/sdk/reference/classes/ChainService","docId":"sdk/reference/classes/ChainService"},{"type":"link","label":"CspCensus","href":"/sdk/reference/classes/CspCensus","docId":"sdk/reference/classes/CspCensus"},{"type":"link","label":"CspService","href":"/sdk/reference/classes/CspService","docId":"sdk/reference/classes/CspService"},{"type":"link","label":"CspVote","href":"/sdk/reference/classes/CspVote","docId":"sdk/reference/classes/CspVote"},{"type":"link","label":"Election","href":"/sdk/reference/classes/Election","docId":"sdk/reference/classes/Election"},{"type":"link","label":"ElectionAPI","href":"/sdk/reference/classes/ElectionAPI","docId":"sdk/reference/classes/ElectionAPI"},{"type":"link","label":"ElectionService","href":"/sdk/reference/classes/ElectionService","docId":"sdk/reference/classes/ElectionService"},{"type":"link","label":"FaucetAPI","href":"/sdk/reference/classes/FaucetAPI","docId":"sdk/reference/classes/FaucetAPI"},{"type":"link","label":"FaucetService","href":"/sdk/reference/classes/FaucetService","docId":"sdk/reference/classes/FaucetService"},{"type":"link","label":"FileAPI","href":"/sdk/reference/classes/FileAPI","docId":"sdk/reference/classes/FileAPI"},{"type":"link","label":"FileService","href":"/sdk/reference/classes/FileService","docId":"sdk/reference/classes/FileService"},{"type":"link","label":"InvalidElection","href":"/sdk/reference/classes/InvalidElection","docId":"sdk/reference/classes/InvalidElection"},{"type":"link","label":"MultiChoiceElection","href":"/sdk/reference/classes/MultiChoiceElection","docId":"sdk/reference/classes/MultiChoiceElection"},{"type":"link","label":"OffchainCensus","href":"/sdk/reference/classes/OffchainCensus","docId":"sdk/reference/classes/OffchainCensus"},{"type":"link","label":"PlainCensus","href":"/sdk/reference/classes/PlainCensus","docId":"sdk/reference/classes/PlainCensus"},{"type":"link","label":"PublishedCensus","href":"/sdk/reference/classes/PublishedCensus","docId":"sdk/reference/classes/PublishedCensus"},{"type":"link","label":"PublishedElection","href":"/sdk/reference/classes/PublishedElection","docId":"sdk/reference/classes/PublishedElection"},{"type":"link","label":"Service","href":"/sdk/reference/classes/Service","docId":"sdk/reference/classes/Service"},{"type":"link","label":"TokenCensus","href":"/sdk/reference/classes/TokenCensus","docId":"sdk/reference/classes/TokenCensus"},{"type":"link","label":"UnpublishedElection","href":"/sdk/reference/classes/UnpublishedElection","docId":"sdk/reference/classes/UnpublishedElection"},{"type":"link","label":"VocdoniCensus3Client","href":"/sdk/reference/classes/VocdoniCensus3Client","docId":"sdk/reference/classes/VocdoniCensus3Client"},{"type":"link","label":"VocdoniSDKClient","href":"/sdk/reference/classes/VocdoniSDKClient","docId":"sdk/reference/classes/VocdoniSDKClient"},{"type":"link","label":"Vote","href":"/sdk/reference/classes/Vote","docId":"sdk/reference/classes/Vote"},{"type":"link","label":"VoteAPI","href":"/sdk/reference/classes/VoteAPI","docId":"sdk/reference/classes/VoteAPI"},{"type":"link","label":"VoteService","href":"/sdk/reference/classes/VoteService","docId":"sdk/reference/classes/VoteService"},{"type":"link","label":"WalletAPI","href":"/sdk/reference/classes/WalletAPI","docId":"sdk/reference/classes/WalletAPI"},{"type":"link","label":"WeightedCensus","href":"/sdk/reference/classes/WeightedCensus","docId":"sdk/reference/classes/WeightedCensus"}]},{"type":"category","label":"Enums","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"CensusOrigin","href":"/sdk/reference/enums/CensusOrigin","docId":"sdk/reference/enums/CensusOrigin"},{"type":"link","label":"CensusType","href":"/sdk/reference/enums/CensusType","docId":"sdk/reference/enums/CensusType"},{"type":"link","label":"CensusTypeEnum","href":"/sdk/reference/enums/CensusTypeEnum","docId":"sdk/reference/enums/CensusTypeEnum"},{"type":"link","label":"CspProofType","href":"/sdk/reference/enums/CspProofType","docId":"sdk/reference/enums/CspProofType"},{"type":"link","label":"ElectionCreationSteps","href":"/sdk/reference/enums/ElectionCreationSteps","docId":"sdk/reference/enums/ElectionCreationSteps"},{"type":"link","label":"ElectionResultsTypeNames","href":"/sdk/reference/enums/ElectionResultsTypeNames","docId":"sdk/reference/enums/ElectionResultsTypeNames"},{"type":"link","label":"ElectionStatus","href":"/sdk/reference/enums/ElectionStatus","docId":"sdk/reference/enums/ElectionStatus"},{"type":"link","label":"ElectionStatusReady","href":"/sdk/reference/enums/ElectionStatusReady","docId":"sdk/reference/enums/ElectionStatusReady"},{"type":"link","label":"EnvOptions","href":"/sdk/reference/enums/EnvOptions","docId":"sdk/reference/enums/EnvOptions"},{"type":"link","label":"TransactionType","href":"/sdk/reference/enums/TransactionType","docId":"sdk/reference/enums/TransactionType"},{"type":"link","label":"TxType","href":"/sdk/reference/enums/TxType","docId":"sdk/reference/enums/TxType"},{"type":"link","label":"VoteSteps","href":"/sdk/reference/enums/VoteSteps","docId":"sdk/reference/enums/VoteSteps"}]},{"type":"category","label":"Interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AccountMetadata","href":"/sdk/reference/interfaces/AccountMetadata","docId":"sdk/reference/interfaces/AccountMetadata"},{"type":"link","label":"AdminTx","href":"/sdk/reference/interfaces/AdminTx","docId":"sdk/reference/interfaces/AdminTx"},{"type":"link","label":"CircuitInputs","href":"/sdk/reference/interfaces/CircuitInputs","docId":"sdk/reference/interfaces/CircuitInputs"},{"type":"link","label":"CollectFaucetTx","href":"/sdk/reference/interfaces/CollectFaucetTx","docId":"sdk/reference/interfaces/CollectFaucetTx"},{"type":"link","label":"ElectionMetadata","href":"/sdk/reference/interfaces/ElectionMetadata","docId":"sdk/reference/interfaces/ElectionMetadata"},{"type":"link","label":"FetchElectionsParameters","href":"/sdk/reference/interfaces/FetchElectionsParameters","docId":"sdk/reference/interfaces/FetchElectionsParameters"},{"type":"link","label":"IAccount","href":"/sdk/reference/interfaces/IAccount","docId":"sdk/reference/interfaces/IAccount"},{"type":"link","label":"IAccountTransfersCountResponse","href":"/sdk/reference/interfaces/IAccountTransfersCountResponse","docId":"sdk/reference/interfaces/IAccountTransfersCountResponse"},{"type":"link","label":"IAccountsCountResponse","href":"/sdk/reference/interfaces/IAccountsCountResponse","docId":"sdk/reference/interfaces/IAccountsCountResponse"},{"type":"link","label":"IAccountsListResponse","href":"/sdk/reference/interfaces/IAccountsListResponse","docId":"sdk/reference/interfaces/IAccountsListResponse"},{"type":"link","label":"IApprovalElectionParameters","href":"/sdk/reference/interfaces/IApprovalElectionParameters","docId":"sdk/reference/interfaces/IApprovalElectionParameters"},{"type":"link","label":"IBlockTransactionsResponse","href":"/sdk/reference/interfaces/IBlockTransactionsResponse","docId":"sdk/reference/interfaces/IBlockTransactionsResponse"},{"type":"link","label":"IBudgetElectionParametersInfo","href":"/sdk/reference/interfaces/IBudgetElectionParametersInfo","docId":"sdk/reference/interfaces/IBudgetElectionParametersInfo"},{"type":"link","label":"IBudgetElectionParametersWithBudget","href":"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget","docId":"sdk/reference/interfaces/IBudgetElectionParametersWithBudget"},{"type":"link","label":"IBudgetElectionParametersWithCensusWeight","href":"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight","docId":"sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight"},{"type":"link","label":"ICensus","href":"/sdk/reference/interfaces/ICensus","docId":"sdk/reference/interfaces/ICensus"},{"type":"link","label":"ICensus3CensusListResponse","href":"/sdk/reference/interfaces/ICensus3CensusListResponse","docId":"sdk/reference/interfaces/ICensus3CensusListResponse"},{"type":"link","label":"ICensus3CensusQueueResponse","href":"/sdk/reference/interfaces/ICensus3CensusQueueResponse","docId":"sdk/reference/interfaces/ICensus3CensusQueueResponse"},{"type":"link","label":"ICensus3CensusResponse","href":"/sdk/reference/interfaces/ICensus3CensusResponse","docId":"sdk/reference/interfaces/ICensus3CensusResponse"},{"type":"link","label":"ICensus3ServiceInfoResponse","href":"/sdk/reference/interfaces/ICensus3ServiceInfoResponse","docId":"sdk/reference/interfaces/ICensus3ServiceInfoResponse"},{"type":"link","label":"ICensus3StrategiesListResponse","href":"/sdk/reference/interfaces/ICensus3StrategiesListResponse","docId":"sdk/reference/interfaces/ICensus3StrategiesListResponse"},{"type":"link","label":"ICensus3StrategiesListResponsePaginated","href":"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated","docId":"sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated"},{"type":"link","label":"ICensus3StrategiesOperator","href":"/sdk/reference/interfaces/ICensus3StrategiesOperator","docId":"sdk/reference/interfaces/ICensus3StrategiesOperator"},{"type":"link","label":"ICensus3StrategiesOperatorsResponse","href":"/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse","docId":"sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse"},{"type":"link","label":"ICensus3StrategyCreateResponse","href":"/sdk/reference/interfaces/ICensus3StrategyCreateResponse","docId":"sdk/reference/interfaces/ICensus3StrategyCreateResponse"},{"type":"link","label":"ICensus3StrategyEstimationQueueResponse","href":"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse","docId":"sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse"},{"type":"link","label":"ICensus3StrategyHoldersResponse","href":"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse","docId":"sdk/reference/interfaces/ICensus3StrategyHoldersResponse"},{"type":"link","label":"ICensus3StrategyHoldersResponsePaginated","href":"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated","docId":"sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated"},{"type":"link","label":"ICensus3StrategyImportQueueResponse","href":"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse","docId":"sdk/reference/interfaces/ICensus3StrategyImportQueueResponse"},{"type":"link","label":"ICensus3StrategyToken","href":"/sdk/reference/interfaces/ICensus3StrategyToken","docId":"sdk/reference/interfaces/ICensus3StrategyToken"},{"type":"link","label":"ICensus3SupportedChain","href":"/sdk/reference/interfaces/ICensus3SupportedChain","docId":"sdk/reference/interfaces/ICensus3SupportedChain"},{"type":"link","label":"ICensus3TokenHolderResponse","href":"/sdk/reference/interfaces/ICensus3TokenHolderResponse","docId":"sdk/reference/interfaces/ICensus3TokenHolderResponse"},{"type":"link","label":"ICensus3TokenListResponse","href":"/sdk/reference/interfaces/ICensus3TokenListResponse","docId":"sdk/reference/interfaces/ICensus3TokenListResponse"},{"type":"link","label":"ICensus3TokenListResponsePaginated","href":"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated","docId":"sdk/reference/interfaces/ICensus3TokenListResponsePaginated"},{"type":"link","label":"ICensus3TokenTypesResponse","href":"/sdk/reference/interfaces/ICensus3TokenTypesResponse","docId":"sdk/reference/interfaces/ICensus3TokenTypesResponse"},{"type":"link","label":"ICensus3ValidatePredicateChild","href":"/sdk/reference/interfaces/ICensus3ValidatePredicateChild","docId":"sdk/reference/interfaces/ICensus3ValidatePredicateChild"},{"type":"link","label":"ICensus3ValidatePredicateResponse","href":"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse","docId":"sdk/reference/interfaces/ICensus3ValidatePredicateResponse"},{"type":"link","label":"ICensus3ValidatePredicateToken","href":"/sdk/reference/interfaces/ICensus3ValidatePredicateToken","docId":"sdk/reference/interfaces/ICensus3ValidatePredicateToken"},{"type":"link","label":"ICensusExportResponse","href":"/sdk/reference/interfaces/ICensusExportResponse","docId":"sdk/reference/interfaces/ICensusExportResponse"},{"type":"link","label":"ICensusImportResponse","href":"/sdk/reference/interfaces/ICensusImportResponse","docId":"sdk/reference/interfaces/ICensusImportResponse"},{"type":"link","label":"ICensusParticipant","href":"/sdk/reference/interfaces/ICensusParticipant","docId":"sdk/reference/interfaces/ICensusParticipant"},{"type":"link","label":"ICensusProofResponse","href":"/sdk/reference/interfaces/ICensusProofResponse","docId":"sdk/reference/interfaces/ICensusProofResponse"},{"type":"link","label":"ICensusPublishResponse","href":"/sdk/reference/interfaces/ICensusPublishResponse","docId":"sdk/reference/interfaces/ICensusPublishResponse"},{"type":"link","label":"IChainBlockInfoResponse","href":"/sdk/reference/interfaces/IChainBlockInfoResponse","docId":"sdk/reference/interfaces/IChainBlockInfoResponse"},{"type":"link","label":"IChainGetCircuitResponse","href":"/sdk/reference/interfaces/IChainGetCircuitResponse","docId":"sdk/reference/interfaces/IChainGetCircuitResponse"},{"type":"link","label":"IChainGetCostsResponse","href":"/sdk/reference/interfaces/IChainGetCostsResponse","docId":"sdk/reference/interfaces/IChainGetCostsResponse"},{"type":"link","label":"IChainGetInfoResponse","href":"/sdk/reference/interfaces/IChainGetInfoResponse","docId":"sdk/reference/interfaces/IChainGetInfoResponse"},{"type":"link","label":"IChainOrganizationCountResponse","href":"/sdk/reference/interfaces/IChainOrganizationCountResponse","docId":"sdk/reference/interfaces/IChainOrganizationCountResponse"},{"type":"link","label":"IChainOrganizationListResponse","href":"/sdk/reference/interfaces/IChainOrganizationListResponse","docId":"sdk/reference/interfaces/IChainOrganizationListResponse"},{"type":"link","label":"IChainOrganizationResponse","href":"/sdk/reference/interfaces/IChainOrganizationResponse","docId":"sdk/reference/interfaces/IChainOrganizationResponse"},{"type":"link","label":"IChainSubmitTxResponse","href":"/sdk/reference/interfaces/IChainSubmitTxResponse","docId":"sdk/reference/interfaces/IChainSubmitTxResponse"},{"type":"link","label":"IChainTxCountResponse","href":"/sdk/reference/interfaces/IChainTxCountResponse","docId":"sdk/reference/interfaces/IChainTxCountResponse"},{"type":"link","label":"IChainTxListResponse","href":"/sdk/reference/interfaces/IChainTxListResponse","docId":"sdk/reference/interfaces/IChainTxListResponse"},{"type":"link","label":"IChainTxReference","href":"/sdk/reference/interfaces/IChainTxReference","docId":"sdk/reference/interfaces/IChainTxReference"},{"type":"link","label":"IChainValidator","href":"/sdk/reference/interfaces/IChainValidator","docId":"sdk/reference/interfaces/IChainValidator"},{"type":"link","label":"IChainValidatorsListResponse","href":"/sdk/reference/interfaces/IChainValidatorsListResponse","docId":"sdk/reference/interfaces/IChainValidatorsListResponse"},{"type":"link","label":"IChoice","href":"/sdk/reference/interfaces/IChoice","docId":"sdk/reference/interfaces/IChoice"},{"type":"link","label":"IElectionCreateResponse","href":"/sdk/reference/interfaces/IElectionCreateResponse","docId":"sdk/reference/interfaces/IElectionCreateResponse"},{"type":"link","label":"IElectionInfoResponse","href":"/sdk/reference/interfaces/IElectionInfoResponse","docId":"sdk/reference/interfaces/IElectionInfoResponse"},{"type":"link","label":"IElectionKeysResponse","href":"/sdk/reference/interfaces/IElectionKeysResponse","docId":"sdk/reference/interfaces/IElectionKeysResponse"},{"type":"link","label":"IElectionListFilter","href":"/sdk/reference/interfaces/IElectionListFilter","docId":"sdk/reference/interfaces/IElectionListFilter"},{"type":"link","label":"IElectionListResponse","href":"/sdk/reference/interfaces/IElectionListResponse","docId":"sdk/reference/interfaces/IElectionListResponse"},{"type":"link","label":"IElectionMode","href":"/sdk/reference/interfaces/IElectionMode","docId":"sdk/reference/interfaces/IElectionMode"},{"type":"link","label":"IElectionNextIdResponse","href":"/sdk/reference/interfaces/IElectionNextIdResponse","docId":"sdk/reference/interfaces/IElectionNextIdResponse"},{"type":"link","label":"IElectionParameters","href":"/sdk/reference/interfaces/IElectionParameters","docId":"sdk/reference/interfaces/IElectionParameters"},{"type":"link","label":"IElectionSummary","href":"/sdk/reference/interfaces/IElectionSummary","docId":"sdk/reference/interfaces/IElectionSummary"},{"type":"link","label":"IElectionType","href":"/sdk/reference/interfaces/IElectionType","docId":"sdk/reference/interfaces/IElectionType"},{"type":"link","label":"IElectionVote","href":"/sdk/reference/interfaces/IElectionVote","docId":"sdk/reference/interfaces/IElectionVote"},{"type":"link","label":"IElectionVoteListResponse","href":"/sdk/reference/interfaces/IElectionVoteListResponse","docId":"sdk/reference/interfaces/IElectionVoteListResponse"},{"type":"link","label":"IEncryptionKey","href":"/sdk/reference/interfaces/IEncryptionKey","docId":"sdk/reference/interfaces/IEncryptionKey"},{"type":"link","label":"IInvalidElectionParameters","href":"/sdk/reference/interfaces/IInvalidElectionParameters","docId":"sdk/reference/interfaces/IInvalidElectionParameters"},{"type":"link","label":"IMultiChoiceElectionParameters","href":"/sdk/reference/interfaces/IMultiChoiceElectionParameters","docId":"sdk/reference/interfaces/IMultiChoiceElectionParameters"},{"type":"link","label":"IPublishedElectionParameters","href":"/sdk/reference/interfaces/IPublishedElectionParameters","docId":"sdk/reference/interfaces/IPublishedElectionParameters"},{"type":"link","label":"IQuestion","href":"/sdk/reference/interfaces/IQuestion","docId":"sdk/reference/interfaces/IQuestion"},{"type":"link","label":"ITallyMode","href":"/sdk/reference/interfaces/ITallyMode","docId":"sdk/reference/interfaces/ITallyMode"},{"type":"link","label":"IVoteInfoResponse","href":"/sdk/reference/interfaces/IVoteInfoResponse","docId":"sdk/reference/interfaces/IVoteInfoResponse"},{"type":"link","label":"IVoteMode","href":"/sdk/reference/interfaces/IVoteMode","docId":"sdk/reference/interfaces/IVoteMode"},{"type":"link","label":"IVoteSubmitResponse","href":"/sdk/reference/interfaces/IVoteSubmitResponse","docId":"sdk/reference/interfaces/IVoteSubmitResponse"},{"type":"link","label":"IVoteType","href":"/sdk/reference/interfaces/IVoteType","docId":"sdk/reference/interfaces/IVoteType"},{"type":"link","label":"MintTokensTx","href":"/sdk/reference/interfaces/MintTokensTx","docId":"sdk/reference/interfaces/MintTokensTx"},{"type":"link","label":"NewProcessTx","href":"/sdk/reference/interfaces/NewProcessTx","docId":"sdk/reference/interfaces/NewProcessTx"},{"type":"link","label":"Process","href":"/sdk/reference/interfaces/Process","docId":"sdk/reference/interfaces/Process"},{"type":"link","label":"Proof","href":"/sdk/reference/interfaces/Proof","docId":"sdk/reference/interfaces/Proof"},{"type":"link","label":"RegisterKeyTx","href":"/sdk/reference/interfaces/RegisterKeyTx","docId":"sdk/reference/interfaces/RegisterKeyTx"},{"type":"link","label":"SendTokensTx","href":"/sdk/reference/interfaces/SendTokensTx","docId":"sdk/reference/interfaces/SendTokensTx"},{"type":"link","label":"ServiceProperties","href":"/sdk/reference/interfaces/ServiceProperties","docId":"sdk/reference/interfaces/ServiceProperties"},{"type":"link","label":"SetAccountTx","href":"/sdk/reference/interfaces/SetAccountTx","docId":"sdk/reference/interfaces/SetAccountTx"},{"type":"link","label":"SetProcessTx","href":"/sdk/reference/interfaces/SetProcessTx","docId":"sdk/reference/interfaces/SetProcessTx"},{"type":"link","label":"SetTransactionCostsTx","href":"/sdk/reference/interfaces/SetTransactionCostsTx","docId":"sdk/reference/interfaces/SetTransactionCostsTx"},{"type":"link","label":"Tx","href":"/sdk/reference/interfaces/Tx","docId":"sdk/reference/interfaces/Tx"},{"type":"link","label":"VoteEnvelope","href":"/sdk/reference/interfaces/VoteEnvelope","docId":"sdk/reference/interfaces/VoteEnvelope"}]},{"type":"link","label":"Modules","href":"/sdk/reference/modules","docId":"sdk/reference/modules"},{"type":"link","label":"Changelog","href":"/sdk/reference/changelog","docId":"sdk/reference/changelog"}]}],"href":"/sdk/"},{"type":"category","label":"UI Components","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Organization components","href":"/ui-components/Organization","docId":"ui-components/Organization"},{"type":"link","label":"Election components","href":"/ui-components/Election","docId":"ui-components/Election"}],"href":"/ui-components/"},{"type":"category","label":"Vocdoni API","items":[{"type":"category","label":"Chain","items":[{"type":"link","label":"Estimate block to date","href":"/vocdoni-api/estimate-block-to-date","className":"api-method get","docId":"vocdoni-api/estimate-block-to-date"},{"type":"link","label":"Get block (by hash)","href":"/vocdoni-api/get-block-by-hash","className":"api-method get","docId":"vocdoni-api/get-block-by-hash"},{"type":"link","label":"Get block (by height)","href":"/vocdoni-api/get-block-by-height","className":"api-method get","docId":"vocdoni-api/get-block-by-height"},{"type":"link","label":"Transactions in a block","href":"/vocdoni-api/transactions-in-a-block","className":"api-method get","docId":"vocdoni-api/transactions-in-a-block"},{"type":"link","label":"Estimate date to block","href":"/vocdoni-api/estimate-date-to-block","className":"api-method get","docId":"vocdoni-api/estimate-date-to-block"},{"type":"link","label":"Vochain information","href":"/vocdoni-api/vochain-information","className":"api-method get","docId":"vocdoni-api/vochain-information"},{"type":"link","label":"Circuit info","href":"/vocdoni-api/circuit-info","className":"api-method get","docId":"vocdoni-api/circuit-info"},{"type":"link","label":"Price factors information","href":"/vocdoni-api/price-factors-information","className":"api-method get","docId":"vocdoni-api/price-factors-information"},{"type":"link","label":"Count organizations","href":"/vocdoni-api/count-organizations","className":"api-method get","docId":"vocdoni-api/count-organizations"},{"type":"link","label":"List organizations (filtered)","href":"/vocdoni-api/list-organizations-filtered","className":"api-method post","docId":"vocdoni-api/list-organizations-filtered"},{"type":"link","label":"List organizations","href":"/vocdoni-api/list-organizations","className":"api-method get","docId":"vocdoni-api/list-organizations"},{"type":"link","label":"Submit transaction","href":"/vocdoni-api/submit-transaction","className":"api-method post","docId":"vocdoni-api/submit-transaction"},{"type":"link","label":"Transaction costs","href":"/vocdoni-api/transaction-costs","className":"api-method get","docId":"vocdoni-api/transaction-costs"},{"type":"link","label":"Transactions count","href":"/vocdoni-api/transactions-count","className":"api-method get","docId":"vocdoni-api/transactions-count"},{"type":"link","label":"List Transactions","href":"/vocdoni-api/list-transactions","className":"api-method get","docId":"vocdoni-api/list-transactions"},{"type":"link","label":"Transaction by index","href":"/vocdoni-api/transaction-by-index","className":"api-method get","docId":"vocdoni-api/transaction-by-index"},{"type":"link","label":"Transaction by hash","href":"/vocdoni-api/transaction-by-hash","className":"api-method get","docId":"vocdoni-api/transaction-by-hash"},{"type":"link","label":"Transaction by block height and index","href":"/vocdoni-api/transaction-by-block-height-and-index","className":"api-method get","docId":"vocdoni-api/transaction-by-block-height-and-index"},{"type":"link","label":"List validators","href":"/vocdoni-api/list-validators","className":"api-method get","docId":"vocdoni-api/list-validators"}],"collapsed":true,"collapsible":true,"href":"/vocdoni-api/chain"},{"type":"category","label":"Accounts","items":[{"type":"link","label":"Set account","href":"/vocdoni-api/set-account","className":"api-method post","docId":"vocdoni-api/set-account"},{"type":"link","label":"Total number of accounts","href":"/vocdoni-api/total-number-of-accounts","className":"api-method get","docId":"vocdoni-api/total-number-of-accounts"},{"type":"link","label":"List of the existing accounts","href":"/vocdoni-api/list-of-the-existing-accounts","className":"api-method get","docId":"vocdoni-api/list-of-the-existing-accounts"},{"type":"link","label":"List account token fees","href":"/vocdoni-api/list-account-token-fees","className":"api-method get","docId":"vocdoni-api/list-account-token-fees"},{"type":"link","label":"Total number of sent and received transactions","href":"/vocdoni-api/total-number-of-sent-and-received-transactions","className":"api-method get","docId":"vocdoni-api/total-number-of-sent-and-received-transactions"},{"type":"link","label":"List account received and sent token transfers","href":"/vocdoni-api/list-account-received-and-sent-token-transfers","className":"api-method get","docId":"vocdoni-api/list-account-received-and-sent-token-transfers"},{"type":"link","label":"Get account","href":"/vocdoni-api/get-account","className":"api-method get","docId":"vocdoni-api/get-account"},{"type":"link","label":"Get account","href":"/vocdoni-api/get-account","className":"api-method get","docId":"vocdoni-api/get-account"},{"type":"link","label":"Count organization elections","href":"/vocdoni-api/count-organization-elections","className":"api-method get","docId":"vocdoni-api/count-organization-elections"},{"type":"link","label":"List organization elections","href":"/vocdoni-api/list-organization-elections","className":"api-method get","docId":"vocdoni-api/list-organization-elections"},{"type":"link","label":"List organization elections by status","href":"/vocdoni-api/list-organization-elections-by-status","className":"api-method get","docId":"vocdoni-api/list-organization-elections-by-status"},{"type":"link","label":"List all token fees","href":"/vocdoni-api/list-all-token-fees","className":"api-method get","docId":"vocdoni-api/list-all-token-fees"},{"type":"link","label":"List all token fees by reference","href":"/vocdoni-api/list-all-token-fees-by-reference","className":"api-method get","docId":"vocdoni-api/list-all-token-fees-by-reference"},{"type":"link","label":"List all token fees by type","href":"/vocdoni-api/list-all-token-fees-by-type","className":"api-method get","docId":"vocdoni-api/list-all-token-fees-by-type"}],"collapsed":true,"collapsible":true,"href":"/vocdoni-api/accounts"},{"type":"category","label":"Elections","items":[{"type":"link","label":"Create election","href":"/vocdoni-api/create-election","className":"api-method post","docId":"vocdoni-api/create-election"},{"type":"link","label":"List elections (filtered)","href":"/vocdoni-api/list-elections-filtered","className":"api-method post","docId":"vocdoni-api/list-elections-filtered"},{"type":"link","label":"Get next election ID","href":"/vocdoni-api/get-next-election-id","className":"api-method post","docId":"vocdoni-api/get-next-election-id"},{"type":"link","label":"List elections","href":"/vocdoni-api/list-elections","className":"api-method get","docId":"vocdoni-api/list-elections"},{"type":"link","label":"Compute election price","href":"/vocdoni-api/compute-election-price","className":"api-method post","docId":"vocdoni-api/compute-election-price"},{"type":"link","label":"Election information","href":"/vocdoni-api/election-information","className":"api-method get","docId":"vocdoni-api/election-information"},{"type":"link","label":"List encryption keys","href":"/vocdoni-api/list-encryption-keys","className":"api-method get","docId":"vocdoni-api/list-encryption-keys"},{"type":"link","label":"Election results","href":"/vocdoni-api/election-results","className":"api-method get","docId":"vocdoni-api/election-results"},{"type":"link","label":"Count election votes","href":"/vocdoni-api/count-election-votes","className":"api-method get","docId":"vocdoni-api/count-election-votes"},{"type":"link","label":"List election votes","href":"/vocdoni-api/list-election-votes","className":"api-method get","docId":"vocdoni-api/list-election-votes"},{"type":"link","label":"Compute IPFS CIDv1 of file","href":"/vocdoni-api/compute-ipfs-ci-dv-1-of-file","className":"api-method post","docId":"vocdoni-api/compute-ipfs-ci-dv-1-of-file"}],"collapsed":true,"collapsible":true,"href":"/vocdoni-api/elections"},{"type":"category","label":"Censuses","items":[{"type":"link","label":"Export census database","href":"/vocdoni-api/export-census-database","className":"api-method get","docId":"vocdoni-api/export-census-database"},{"type":"link","label":"Import census database","href":"/vocdoni-api/import-census-database","className":"api-method post","docId":"vocdoni-api/import-census-database"},{"type":"link","label":"List all census references","href":"/vocdoni-api/list-all-census-references","className":"api-method get","docId":"vocdoni-api/list-all-census-references"},{"type":"link","label":"Delete census","href":"/vocdoni-api/delete-census","className":"api-method delete","docId":"vocdoni-api/delete-census"},{"type":"link","label":"Export census","href":"/vocdoni-api/export-census","className":"api-method get","docId":"vocdoni-api/export-census"},{"type":"link","label":"Import census","href":"/vocdoni-api/import-census","className":"api-method post","docId":"vocdoni-api/import-census"},{"type":"link","label":"Add participants to census","href":"/vocdoni-api/add-participants-to-census","className":"api-method post","docId":"vocdoni-api/add-participants-to-census"},{"type":"link","label":"Prove key to census","href":"/vocdoni-api/prove-key-to-census","className":"api-method get","docId":"vocdoni-api/prove-key-to-census"},{"type":"link","label":"Publish census","href":"/vocdoni-api/publish-census","className":"api-method post","docId":"vocdoni-api/publish-census"},{"type":"link","label":"Publish census at root","href":"/vocdoni-api/publish-census-at-root","className":"api-method post","docId":"vocdoni-api/publish-census-at-root"},{"type":"link","label":"Census Merkle Root","href":"/vocdoni-api/census-merkle-root","className":"api-method get","docId":"vocdoni-api/census-merkle-root"},{"type":"link","label":"Census size","href":"/vocdoni-api/census-size","className":"api-method get","docId":"vocdoni-api/census-size"},{"type":"link","label":"Get type of census","href":"/vocdoni-api/get-type-of-census","className":"api-method get","docId":"vocdoni-api/get-type-of-census"},{"type":"link","label":"Verify merkle proof","href":"/vocdoni-api/verify-merkle-proof","className":"api-method post","docId":"vocdoni-api/verify-merkle-proof"},{"type":"link","label":"Census total weight","href":"/vocdoni-api/census-total-weight","className":"api-method get","docId":"vocdoni-api/census-total-weight"},{"type":"link","label":"Create a new census","href":"/vocdoni-api/create-a-new-census","className":"api-method post","docId":"vocdoni-api/create-a-new-census"}],"collapsed":true,"collapsible":true,"href":"/vocdoni-api/censuses"},{"type":"category","label":"Votes","items":[{"type":"link","label":"Submit a vote","href":"/vocdoni-api/submit-a-vote","className":"api-method post","docId":"vocdoni-api/submit-a-vote"},{"type":"link","label":"Verify vote","href":"/vocdoni-api/verify-vote","className":"api-method get","docId":"vocdoni-api/verify-vote"},{"type":"link","label":"Get vote","href":"/vocdoni-api/get-vote","className":"api-method get","docId":"vocdoni-api/get-vote"}],"collapsed":true,"collapsible":true,"href":"/vocdoni-api/votes"},{"type":"category","label":"Wallet","items":[{"type":"link","label":"Add account","href":"/vocdoni-api/add-account","className":"api-method post","docId":"vocdoni-api/add-account"},{"type":"link","label":"Set wallet account","href":"/vocdoni-api/set-wallet-account","className":"api-method get","docId":"vocdoni-api/set-wallet-account"},{"type":"link","label":"Create election for wallet","href":"/vocdoni-api/create-election-for-wallet","className":"api-method post","docId":"vocdoni-api/create-election-for-wallet"},{"type":"link","label":"Transfer tokens","href":"/vocdoni-api/transfer-tokens","className":"api-method get","docId":"vocdoni-api/transfer-tokens"}],"collapsed":true,"collapsible":true,"href":"/vocdoni-api/wallet"},{"type":"category","label":"SIK","items":[{"type":"link","label":"List of valid SIK roots","href":"/vocdoni-api/list-of-valid-sik-roots","className":"api-method get","docId":"vocdoni-api/list-of-valid-sik-roots"},{"type":"link","label":"List of valid SIK roots","href":"/vocdoni-api/list-of-valid-sik-roots","className":"api-method get","docId":"vocdoni-api/list-of-valid-sik-roots"},{"type":"link","label":"Returns if the address provided has a valid SIK","href":"/vocdoni-api/returns-if-the-address-provided-has-a-valid-sik","className":"api-method get","docId":"vocdoni-api/returns-if-the-address-provided-has-a-valid-sik"}],"collapsed":true,"collapsible":true,"href":"/vocdoni-api/sik"},{"type":"category","label":"Indexer","items":[{"type":"link","label":"Exports the indexer database","href":"/vocdoni-api/exports-the-indexer-database","className":"api-method get","docId":"vocdoni-api/exports-the-indexer-database"}],"collapsed":true,"collapsible":true}],"collapsed":true,"collapsible":true,"href":"/vocdoni-api/vocdoni-api"}]},"docs":{"intro":{"id":"intro","title":"Getting Started","description":"Vocdoni is the most open, secure, and universally verifiable voting protocol, used by hundreds of organizations worldwide. The core of our stack is a powerful decentralized backend, including blockchain, P2P gateway, and distributed file storage components.","sidebar":"defaultSidebar"},"protocol/anonymity/anonymity":{"id":"protocol/anonymity/anonymity","title":"Anonymous Voting","description":"- Anonymous voting is a type of voting process where the users can vote without revealing their identity, by proving that they are accepted as valid voters. Currently we have 2 types of anonymous voting schemes:","sidebar":"defaultSidebar"},"protocol/anonymity/blind-signatures":{"id":"protocol/anonymity/blind-signatures","title":"CSP Blind Signatures","description":"The current approach by Vocdoni regarding determining the eligibility of a potential voter is to use a Census Merkle Tree. All voter public keys must be known in advance and aggregated together into a hash tree to compute a Merkle root. Then each voter needs to fetch their own Merkle proof to demonstrate their eligibility on a public ledger. The Merkle proof can be anonymized using a zk-SNARK so that the public ledger will verify the SNARK proof instead.","sidebar":"defaultSidebar"},"protocol/anonymity/on-chain":{"id":"protocol/anonymity/on-chain","title":"On-Chain Census Anonymity","description":"On-chain cenuses derive their contents from a public set of holders of a given token (or set of tokens) on the Ethereum blockchain. This information is turned into a census by generating a Merkle Proof on that set of data. This Merkle Proof is similar to that used for a typical off-chain tree census, and the same sort of ZK Census Proof can be used to compute voter validation anonymously.","sidebar":"defaultSidebar"},"protocol/anonymity/zk-census-proof":{"id":"protocol/anonymity/zk-census-proof","title":"Off-Chain Tree ZK Census Proof","description":"This document is divided in two sections:","sidebar":"defaultSidebar"},"protocol/ballot-protocol":{"id":"protocol/ballot-protocol","title":"Ballot Protocol","description":"Ballot protocol","sidebar":"defaultSidebar"},"protocol/census/census":{"id":"protocol/census/census","title":"The Census","description":"In Vocdoni, a census of identities can be represented in one of three ways. For Ethereum-based processes, in which eligible voters are represented by Ethereum addresses holding a specific token, an on-chain] (ERC-20) census is used. In cases where a central authority wants to manually validate each voter at the time of voting, [off-chain credential service provider is used. For all other voting processes (organizations that are not represented as DAOs), an off-chain tree census is used.","sidebar":"defaultSidebar"},"protocol/census/off-chain-csp":{"id":"protocol/census/off-chain-csp","title":"Off-Chain CSP Census","description":"A census approach based on Credential Service Providers (CSPs) allows organizations to validate users manually and based off of any arbitrary criteria. Rather than a static census published before-hand, CSP census allows each user to be evaluated for voting eligibility individually, throughout the duration of the voting process.","sidebar":"defaultSidebar"},"protocol/census/off-chain-tree":{"id":"protocol/census/off-chain-tree","title":"Off-Chain Tree Census","description":"The census itself is represented as a binary Merkle Tree, where the leaves of the tree contain the public keys of all eligible voters, hashed.","sidebar":"defaultSidebar"},"protocol/census/on-chain":{"id":"protocol/census/on-chain","title":"On-Chain Census","description":"There are two types of census origins: Those who depend on a list of public keys maintained off-chain and those dependent on the status of the Ethereum blockchain at a given point in time.","sidebar":"defaultSidebar"},"protocol/data-schemes/data-schemes":{"id":"protocol/data-schemes/data-schemes","title":"Data Schemes","description":"When it comes to voting processes, there are two main types of data storage at the protocol-level: protocol-level data stored on the Vochain and readable metadata like election descriptions stored on IPFS.","sidebar":"defaultSidebar"},"protocol/data-schemes/election":{"id":"protocol/data-schemes/election","title":"Election Metadata","description":"Election metadata provides the human-readable data associated with an election.","sidebar":"defaultSidebar"},"protocol/data-schemes/organization":{"id":"protocol/data-schemes/organization","title":"Organization Metadata","description":"The metadata of an organization provides human readable content, featuring names, descriptions, images, the list of available processes and more.","sidebar":"defaultSidebar"},"protocol/data-schemes/vote":{"id":"protocol/data-schemes/vote","title":"Vote Data","description":"Vote Envelope","sidebar":"defaultSidebar"},"protocol/index":{"id":"protocol/index","title":"Vocdoni Protocol","description":"1. Introduction","sidebar":"defaultSidebar"},"sdk/index":{"id":"sdk/index","title":"Vocdoni SDK","description":"The Vocdoni SDK is a convenient way to interact with the Vocdoni Protocol through the API, allowing anyone to create, manage and participate in voting processes and collective decision-making. The SDK is the primary mode by which developers should interface with Vocdoni - if you think the SDK is missing functionality you need, please get in touch.","sidebar":"defaultSidebar"},"sdk/integration-details/census-types/census-types":{"id":"sdk/integration-details/census-types/census-types","title":"Census Types","description":"A census is a list of voters who are eligible to vote in a given election. There are multiple ways to define a census with Vocdoni, each with different privacy and verifiability considerations. The census types are defined at a protocol level and include on-chain, off-chain Merkle tree, and off-chain Credential Service Provider.","sidebar":"defaultSidebar"},"sdk/integration-details/census-types/off-chain-csp":{"id":"sdk/integration-details/census-types/off-chain-csp","title":"Off-chain Credential Service Provider","description":"A Credential Service Provider is an external component that serves as a validator for the identities of voters. An example of this could be a service set up by a municipal government that validates if a given voter is registered, or a forum that validates if a given voter has an active account. With this type of census, voters show proof of registry and receive a cryptographic package from the CSP allowing them to cast a vote.","sidebar":"defaultSidebar"},"sdk/integration-details/census-types/off-chain-tree":{"id":"sdk/integration-details/census-types/off-chain-tree","title":"Off-chain Merkle Tree","description":"This is the most basic census type, is the default when creating an election, and is the one used in the SDK tutorial. In this scheme, the census is essentially a basic list of voter, with some behind-the-scenes cryptography. With an off-train tree census, voters are added as wallet addresses using census.add().","sidebar":"defaultSidebar"},"sdk/integration-details/census-types/on-chain/complex-census":{"id":"sdk/integration-details/census-types/on-chain/complex-census","title":"Complex Census","description":"The census3 service makes it easy to create a census based off of the balance holders of a token taken to represent an organization. It is possible, however, to create a token-based census with more complex logic, incorporating balance information from multiple tokens at once.","sidebar":"defaultSidebar"},"sdk/integration-details/census-types/on-chain/on-chain":{"id":"sdk/integration-details/census-types/on-chain/on-chain","title":"On-chain Token-Based Census","description":"An on-chain census is one whose voters are defined by holding tokens on the Ethereum blockchain. Currently the following token types are supported:","sidebar":"defaultSidebar"},"sdk/integration-details/integration-details":{"id":"sdk/integration-details/integration-details","title":"Integration Details","description":"The tutorial covers the basics, but here are some details you\'ll need to consider when integrating the Vocdoni SDK into your application.","sidebar":"defaultSidebar"},"sdk/integration-details/vocdoni-tokens":{"id":"sdk/integration-details/vocdoni-tokens","title":"Vocdoni Tokens","description":"Behind-the-scenes, Vocdoni is powered by a custom blockchain. This component provides universal verifiability, but it also introduces some complexity. In order to distribute workload and verify transactions, our blockchain uses a digital \\"currency\\" of Vocdoni tokens that have no real-world value but help with load-balancing and spam reduction. Actions that update data on the blockchain, such as creating an election, incur a \\"cost.\\" Integrators are responsible for ensuring that accounts creating elections have a sufficient balance of tokens.","sidebar":"defaultSidebar"},"sdk/integration-details/voting-types/approval":{"id":"sdk/integration-details/voting-types/approval","title":"Approval Voting (Multiple Choice)","description":"An election with Approval voting is a voting system where voters are allowed to indicate their support for multiple","sidebar":"defaultSidebar"},"sdk/integration-details/voting-types/quadratic":{"id":"sdk/integration-details/voting-types/quadratic","title":"Quadratic voting","description":"Quadratic voting is a voting mechanism that allows individuals to express their preferences on different issues with","sidebar":"defaultSidebar"},"sdk/integration-details/voting-types/ranked":{"id":"sdk/integration-details/voting-types/ranked","title":"Ranked Voting","description":"Ranked voting, also known as preferential voting or ranked-choice voting (RCV), is an electoral system where voters rank","sidebar":"defaultSidebar"},"sdk/integration-details/voting-types/single-choice":{"id":"sdk/integration-details/voting-types/single-choice","title":"Single Choice Voting","description":"An election with a single-choice result, also known as First-past-the-post voting (FPTP or FPP) or informally called","sidebar":"defaultSidebar"},"sdk/integration-details/voting-types/voting-types":{"id":"sdk/integration-details/voting-types/voting-types","title":"Voting Types","description":"In this section, we will provide a brief overview of the different types of voting supported by the Vocdoni protocol and","sidebar":"defaultSidebar"},"sdk/integration-details/voting-types/weighted":{"id":"sdk/integration-details/voting-types/weighted","title":"Weighted voting","description":"Weighted voting is a voting system where each voter is assigned a specific weight or value that reflects their relative influence or importance in the decision-making process.","sidebar":"defaultSidebar"},"sdk/reference/changelog":{"id":"sdk/reference/changelog","title":"Changelog","description":"All notable changes to this project will be documented in this file.","sidebar":"defaultSidebar"},"sdk/reference/classes/Account":{"id":"sdk/reference/classes/Account","title":"Account","description":"@vocdoni/sdk / Exports / Account","sidebar":"defaultSidebar"},"sdk/reference/classes/AccountAPI":{"id":"sdk/reference/classes/AccountAPI","title":"AccountAPI","description":"@vocdoni/sdk / Exports / AccountAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/AccountService":{"id":"sdk/reference/classes/AccountService","title":"AccountService","description":"@vocdoni/sdk / Exports / AccountService","sidebar":"defaultSidebar"},"sdk/reference/classes/AnonymousService":{"id":"sdk/reference/classes/AnonymousService","title":"AnonymousService","description":"@vocdoni/sdk / Exports / AnonymousService","sidebar":"defaultSidebar"},"sdk/reference/classes/AnonymousVote":{"id":"sdk/reference/classes/AnonymousVote","title":"AnonymousVote","description":"@vocdoni/sdk / Exports / AnonymousVote","sidebar":"defaultSidebar"},"sdk/reference/classes/ApprovalElection":{"id":"sdk/reference/classes/ApprovalElection","title":"ApprovalElection","description":"@vocdoni/sdk / Exports / ApprovalElection","sidebar":"defaultSidebar"},"sdk/reference/classes/ArchivedElection":{"id":"sdk/reference/classes/ArchivedElection","title":"ArchivedElection","description":"@vocdoni/sdk / Exports / ArchivedElection","sidebar":"defaultSidebar"},"sdk/reference/classes/BudgetElection":{"id":"sdk/reference/classes/BudgetElection","title":"BudgetElection","description":"@vocdoni/sdk / Exports / BudgetElection","sidebar":"defaultSidebar"},"sdk/reference/classes/Census":{"id":"sdk/reference/classes/Census","title":"Census","description":"@vocdoni/sdk / Exports / Census","sidebar":"defaultSidebar"},"sdk/reference/classes/Census3CensusAPI":{"id":"sdk/reference/classes/Census3CensusAPI","title":"Census3CensusAPI","description":"@vocdoni/sdk / Exports / Census3CensusAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/Census3ServiceAPI":{"id":"sdk/reference/classes/Census3ServiceAPI","title":"Census3ServiceAPI","description":"@vocdoni/sdk / Exports / Census3ServiceAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/Census3StrategyAPI":{"id":"sdk/reference/classes/Census3StrategyAPI","title":"Census3StrategyAPI","description":"@vocdoni/sdk / Exports / Census3StrategyAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/Census3TokenAPI":{"id":"sdk/reference/classes/Census3TokenAPI","title":"Census3TokenAPI","description":"@vocdoni/sdk / Exports / Census3TokenAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/CensusAPI":{"id":"sdk/reference/classes/CensusAPI","title":"CensusAPI","description":"@vocdoni/sdk / Exports / CensusAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/CensusService":{"id":"sdk/reference/classes/CensusService","title":"CensusService","description":"@vocdoni/sdk / Exports / CensusService","sidebar":"defaultSidebar"},"sdk/reference/classes/ChainAPI":{"id":"sdk/reference/classes/ChainAPI","title":"ChainAPI","description":"@vocdoni/sdk / Exports / ChainAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/ChainService":{"id":"sdk/reference/classes/ChainService","title":"ChainService","description":"@vocdoni/sdk / Exports / ChainService","sidebar":"defaultSidebar"},"sdk/reference/classes/CspCensus":{"id":"sdk/reference/classes/CspCensus","title":"CspCensus","description":"@vocdoni/sdk / Exports / CspCensus","sidebar":"defaultSidebar"},"sdk/reference/classes/CspService":{"id":"sdk/reference/classes/CspService","title":"CspService","description":"@vocdoni/sdk / Exports / CspService","sidebar":"defaultSidebar"},"sdk/reference/classes/CspVote":{"id":"sdk/reference/classes/CspVote","title":"CspVote","description":"@vocdoni/sdk / Exports / CspVote","sidebar":"defaultSidebar"},"sdk/reference/classes/Election":{"id":"sdk/reference/classes/Election","title":"Election","description":"@vocdoni/sdk / Exports / Election","sidebar":"defaultSidebar"},"sdk/reference/classes/ElectionAPI":{"id":"sdk/reference/classes/ElectionAPI","title":"ElectionAPI","description":"@vocdoni/sdk / Exports / ElectionAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/ElectionService":{"id":"sdk/reference/classes/ElectionService","title":"ElectionService","description":"@vocdoni/sdk / Exports / ElectionService","sidebar":"defaultSidebar"},"sdk/reference/classes/FaucetAPI":{"id":"sdk/reference/classes/FaucetAPI","title":"FaucetAPI","description":"@vocdoni/sdk / Exports / FaucetAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/FaucetService":{"id":"sdk/reference/classes/FaucetService","title":"FaucetService","description":"@vocdoni/sdk / Exports / FaucetService","sidebar":"defaultSidebar"},"sdk/reference/classes/FileAPI":{"id":"sdk/reference/classes/FileAPI","title":"FileAPI","description":"@vocdoni/sdk / Exports / FileAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/FileService":{"id":"sdk/reference/classes/FileService","title":"FileService","description":"@vocdoni/sdk / Exports / FileService","sidebar":"defaultSidebar"},"sdk/reference/classes/InvalidElection":{"id":"sdk/reference/classes/InvalidElection","title":"InvalidElection","description":"@vocdoni/sdk / Exports / InvalidElection","sidebar":"defaultSidebar"},"sdk/reference/classes/MultiChoiceElection":{"id":"sdk/reference/classes/MultiChoiceElection","title":"MultiChoiceElection","description":"@vocdoni/sdk / Exports / MultiChoiceElection","sidebar":"defaultSidebar"},"sdk/reference/classes/OffchainCensus":{"id":"sdk/reference/classes/OffchainCensus","title":"OffchainCensus","description":"@vocdoni/sdk / Exports / OffchainCensus","sidebar":"defaultSidebar"},"sdk/reference/classes/PlainCensus":{"id":"sdk/reference/classes/PlainCensus","title":"PlainCensus","description":"@vocdoni/sdk / Exports / PlainCensus","sidebar":"defaultSidebar"},"sdk/reference/classes/PublishedCensus":{"id":"sdk/reference/classes/PublishedCensus","title":"PublishedCensus","description":"@vocdoni/sdk / Exports / PublishedCensus","sidebar":"defaultSidebar"},"sdk/reference/classes/PublishedElection":{"id":"sdk/reference/classes/PublishedElection","title":"PublishedElection","description":"@vocdoni/sdk / Exports / PublishedElection","sidebar":"defaultSidebar"},"sdk/reference/classes/Service":{"id":"sdk/reference/classes/Service","title":"Service","description":"@vocdoni/sdk / Exports / Service","sidebar":"defaultSidebar"},"sdk/reference/classes/TokenCensus":{"id":"sdk/reference/classes/TokenCensus","title":"TokenCensus","description":"@vocdoni/sdk / Exports / TokenCensus","sidebar":"defaultSidebar"},"sdk/reference/classes/UnpublishedElection":{"id":"sdk/reference/classes/UnpublishedElection","title":"UnpublishedElection","description":"@vocdoni/sdk / Exports / UnpublishedElection","sidebar":"defaultSidebar"},"sdk/reference/classes/VocdoniCensus3Client":{"id":"sdk/reference/classes/VocdoniCensus3Client","title":"VocdoniCensus3Client","description":"@vocdoni/sdk / Exports / VocdoniCensus3Client","sidebar":"defaultSidebar"},"sdk/reference/classes/VocdoniSDKClient":{"id":"sdk/reference/classes/VocdoniSDKClient","title":"VocdoniSDKClient","description":"@vocdoni/sdk / Exports / VocdoniSDKClient","sidebar":"defaultSidebar"},"sdk/reference/classes/Vote":{"id":"sdk/reference/classes/Vote","title":"Vote","description":"@vocdoni/sdk / Exports / Vote","sidebar":"defaultSidebar"},"sdk/reference/classes/VoteAPI":{"id":"sdk/reference/classes/VoteAPI","title":"VoteAPI","description":"@vocdoni/sdk / Exports / VoteAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/VoteService":{"id":"sdk/reference/classes/VoteService","title":"VoteService","description":"@vocdoni/sdk / Exports / VoteService","sidebar":"defaultSidebar"},"sdk/reference/classes/WalletAPI":{"id":"sdk/reference/classes/WalletAPI","title":"WalletAPI","description":"@vocdoni/sdk / Exports / WalletAPI","sidebar":"defaultSidebar"},"sdk/reference/classes/WeightedCensus":{"id":"sdk/reference/classes/WeightedCensus","title":"WeightedCensus","description":"@vocdoni/sdk / Exports / WeightedCensus","sidebar":"defaultSidebar"},"sdk/reference/enums/CensusOrigin":{"id":"sdk/reference/enums/CensusOrigin","title":"CensusOrigin","description":"@vocdoni/sdk / Exports / CensusOrigin","sidebar":"defaultSidebar"},"sdk/reference/enums/CensusType":{"id":"sdk/reference/enums/CensusType","title":"CensusType","description":"@vocdoni/sdk / Exports / CensusType","sidebar":"defaultSidebar"},"sdk/reference/enums/CensusTypeEnum":{"id":"sdk/reference/enums/CensusTypeEnum","title":"CensusTypeEnum","description":"@vocdoni/sdk / Exports / CensusTypeEnum","sidebar":"defaultSidebar"},"sdk/reference/enums/CspProofType":{"id":"sdk/reference/enums/CspProofType","title":"CspProofType","description":"@vocdoni/sdk / Exports / CspProofType","sidebar":"defaultSidebar"},"sdk/reference/enums/ElectionCreationSteps":{"id":"sdk/reference/enums/ElectionCreationSteps","title":"ElectionCreationSteps","description":"@vocdoni/sdk / Exports / ElectionCreationSteps","sidebar":"defaultSidebar"},"sdk/reference/enums/ElectionResultsTypeNames":{"id":"sdk/reference/enums/ElectionResultsTypeNames","title":"ElectionResultsTypeNames","description":"@vocdoni/sdk / Exports / ElectionResultsTypeNames","sidebar":"defaultSidebar"},"sdk/reference/enums/ElectionStatus":{"id":"sdk/reference/enums/ElectionStatus","title":"ElectionStatus","description":"@vocdoni/sdk / Exports / ElectionStatus","sidebar":"defaultSidebar"},"sdk/reference/enums/ElectionStatusReady":{"id":"sdk/reference/enums/ElectionStatusReady","title":"ElectionStatusReady","description":"@vocdoni/sdk / Exports / ElectionStatusReady","sidebar":"defaultSidebar"},"sdk/reference/enums/EnvOptions":{"id":"sdk/reference/enums/EnvOptions","title":"EnvOptions","description":"@vocdoni/sdk / Exports / EnvOptions","sidebar":"defaultSidebar"},"sdk/reference/enums/TransactionType":{"id":"sdk/reference/enums/TransactionType","title":"TransactionType","description":"@vocdoni/sdk / Exports / TransactionType","sidebar":"defaultSidebar"},"sdk/reference/enums/TxType":{"id":"sdk/reference/enums/TxType","title":"TxType","description":"@vocdoni/sdk / Exports / TxType","sidebar":"defaultSidebar"},"sdk/reference/enums/VoteSteps":{"id":"sdk/reference/enums/VoteSteps","title":"VoteSteps","description":"@vocdoni/sdk / Exports / VoteSteps","sidebar":"defaultSidebar"},"sdk/reference/interfaces/AccountMetadata":{"id":"sdk/reference/interfaces/AccountMetadata","title":"AccountMetadata","description":"@vocdoni/sdk / Exports / AccountMetadata","sidebar":"defaultSidebar"},"sdk/reference/interfaces/AdminTx":{"id":"sdk/reference/interfaces/AdminTx","title":"AdminTx","description":"@vocdoni/sdk / Exports / AdminTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/CircuitInputs":{"id":"sdk/reference/interfaces/CircuitInputs","title":"CircuitInputs","description":"@vocdoni/sdk / Exports / CircuitInputs","sidebar":"defaultSidebar"},"sdk/reference/interfaces/CollectFaucetTx":{"id":"sdk/reference/interfaces/CollectFaucetTx","title":"CollectFaucetTx","description":"@vocdoni/sdk / Exports / CollectFaucetTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ElectionMetadata":{"id":"sdk/reference/interfaces/ElectionMetadata","title":"ElectionMetadata","description":"@vocdoni/sdk / Exports / ElectionMetadata","sidebar":"defaultSidebar"},"sdk/reference/interfaces/FetchElectionsParameters":{"id":"sdk/reference/interfaces/FetchElectionsParameters","title":"FetchElectionsParameters","description":"@vocdoni/sdk / Exports / FetchElectionsParameters","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IAccount":{"id":"sdk/reference/interfaces/IAccount","title":"IAccount","description":"@vocdoni/sdk / Exports / IAccount","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IAccountsCountResponse":{"id":"sdk/reference/interfaces/IAccountsCountResponse","title":"IAccountsCountResponse","description":"@vocdoni/sdk / Exports / IAccountsCountResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IAccountsListResponse":{"id":"sdk/reference/interfaces/IAccountsListResponse","title":"IAccountsListResponse","description":"@vocdoni/sdk / Exports / IAccountsListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IAccountTransfersCountResponse":{"id":"sdk/reference/interfaces/IAccountTransfersCountResponse","title":"IAccountTransfersCountResponse","description":"@vocdoni/sdk / Exports / IAccountTransfersCountResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IApprovalElectionParameters":{"id":"sdk/reference/interfaces/IApprovalElectionParameters","title":"IApprovalElectionParameters","description":"@vocdoni/sdk / Exports / IApprovalElectionParameters","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IBlockTransactionsResponse":{"id":"sdk/reference/interfaces/IBlockTransactionsResponse","title":"IBlockTransactionsResponse","description":"@vocdoni/sdk / Exports / IBlockTransactionsResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IBudgetElectionParametersInfo":{"id":"sdk/reference/interfaces/IBudgetElectionParametersInfo","title":"IBudgetElectionParametersInfo","description":"@vocdoni/sdk / Exports / IBudgetElectionParametersInfo","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IBudgetElectionParametersWithBudget":{"id":"sdk/reference/interfaces/IBudgetElectionParametersWithBudget","title":"IBudgetElectionParametersWithBudget","description":"@vocdoni/sdk / Exports / IBudgetElectionParametersWithBudget","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight":{"id":"sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight","title":"IBudgetElectionParametersWithCensusWeight","description":"@vocdoni/sdk / Exports / IBudgetElectionParametersWithCensusWeight","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus":{"id":"sdk/reference/interfaces/ICensus","title":"ICensus","description":"@vocdoni/sdk / Exports / ICensus","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3CensusListResponse":{"id":"sdk/reference/interfaces/ICensus3CensusListResponse","title":"ICensus3CensusListResponse","description":"@vocdoni/sdk / Exports / ICensus3CensusListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3CensusQueueResponse":{"id":"sdk/reference/interfaces/ICensus3CensusQueueResponse","title":"ICensus3CensusQueueResponse","description":"@vocdoni/sdk / Exports / ICensus3CensusQueueResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3CensusResponse":{"id":"sdk/reference/interfaces/ICensus3CensusResponse","title":"ICensus3CensusResponse","description":"@vocdoni/sdk / Exports / ICensus3CensusResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3ServiceInfoResponse":{"id":"sdk/reference/interfaces/ICensus3ServiceInfoResponse","title":"ICensus3ServiceInfoResponse","description":"@vocdoni/sdk / Exports / ICensus3ServiceInfoResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategiesListResponse":{"id":"sdk/reference/interfaces/ICensus3StrategiesListResponse","title":"ICensus3StrategiesListResponse","description":"@vocdoni/sdk / Exports / ICensus3StrategiesListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated":{"id":"sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated","title":"ICensus3StrategiesListResponsePaginated","description":"@vocdoni/sdk / Exports / ICensus3StrategiesListResponsePaginated","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategiesOperator":{"id":"sdk/reference/interfaces/ICensus3StrategiesOperator","title":"ICensus3StrategiesOperator","description":"@vocdoni/sdk / Exports / ICensus3StrategiesOperator","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse":{"id":"sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse","title":"ICensus3StrategiesOperatorsResponse","description":"@vocdoni/sdk / Exports / ICensus3StrategiesOperatorsResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategyCreateResponse":{"id":"sdk/reference/interfaces/ICensus3StrategyCreateResponse","title":"ICensus3StrategyCreateResponse","description":"@vocdoni/sdk / Exports / ICensus3StrategyCreateResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse":{"id":"sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse","title":"ICensus3StrategyEstimationQueueResponse","description":"@vocdoni/sdk / Exports / ICensus3StrategyEstimationQueueResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategyHoldersResponse":{"id":"sdk/reference/interfaces/ICensus3StrategyHoldersResponse","title":"ICensus3StrategyHoldersResponse","description":"@vocdoni/sdk / Exports / ICensus3StrategyHoldersResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated":{"id":"sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated","title":"ICensus3StrategyHoldersResponsePaginated","description":"@vocdoni/sdk / Exports / ICensus3StrategyHoldersResponsePaginated","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategyImportQueueResponse":{"id":"sdk/reference/interfaces/ICensus3StrategyImportQueueResponse","title":"ICensus3StrategyImportQueueResponse","description":"@vocdoni/sdk / Exports / ICensus3StrategyImportQueueResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3StrategyToken":{"id":"sdk/reference/interfaces/ICensus3StrategyToken","title":"ICensus3StrategyToken","description":"@vocdoni/sdk / Exports / ICensus3StrategyToken","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3SupportedChain":{"id":"sdk/reference/interfaces/ICensus3SupportedChain","title":"ICensus3SupportedChain","description":"@vocdoni/sdk / Exports / ICensus3SupportedChain","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3TokenHolderResponse":{"id":"sdk/reference/interfaces/ICensus3TokenHolderResponse","title":"ICensus3TokenHolderResponse","description":"@vocdoni/sdk / Exports / ICensus3TokenHolderResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3TokenListResponse":{"id":"sdk/reference/interfaces/ICensus3TokenListResponse","title":"ICensus3TokenListResponse","description":"@vocdoni/sdk / Exports / ICensus3TokenListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3TokenListResponsePaginated":{"id":"sdk/reference/interfaces/ICensus3TokenListResponsePaginated","title":"ICensus3TokenListResponsePaginated","description":"@vocdoni/sdk / Exports / ICensus3TokenListResponsePaginated","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3TokenTypesResponse":{"id":"sdk/reference/interfaces/ICensus3TokenTypesResponse","title":"ICensus3TokenTypesResponse","description":"@vocdoni/sdk / Exports / ICensus3TokenTypesResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3ValidatePredicateChild":{"id":"sdk/reference/interfaces/ICensus3ValidatePredicateChild","title":"ICensus3ValidatePredicateChild","description":"@vocdoni/sdk / Exports / ICensus3ValidatePredicateChild","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3ValidatePredicateResponse":{"id":"sdk/reference/interfaces/ICensus3ValidatePredicateResponse","title":"ICensus3ValidatePredicateResponse","description":"@vocdoni/sdk / Exports / ICensus3ValidatePredicateResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensus3ValidatePredicateToken":{"id":"sdk/reference/interfaces/ICensus3ValidatePredicateToken","title":"ICensus3ValidatePredicateToken","description":"@vocdoni/sdk / Exports / ICensus3ValidatePredicateToken","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensusExportResponse":{"id":"sdk/reference/interfaces/ICensusExportResponse","title":"ICensusExportResponse","description":"@vocdoni/sdk / Exports / ICensusExportResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensusImportResponse":{"id":"sdk/reference/interfaces/ICensusImportResponse","title":"ICensusImportResponse","description":"@vocdoni/sdk / Exports / ICensusImportResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensusParticipant":{"id":"sdk/reference/interfaces/ICensusParticipant","title":"ICensusParticipant","description":"@vocdoni/sdk / Exports / ICensusParticipant","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensusProofResponse":{"id":"sdk/reference/interfaces/ICensusProofResponse","title":"ICensusProofResponse","description":"@vocdoni/sdk / Exports / ICensusProofResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ICensusPublishResponse":{"id":"sdk/reference/interfaces/ICensusPublishResponse","title":"ICensusPublishResponse","description":"@vocdoni/sdk / Exports / ICensusPublishResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainBlockInfoResponse":{"id":"sdk/reference/interfaces/IChainBlockInfoResponse","title":"IChainBlockInfoResponse","description":"@vocdoni/sdk / Exports / IChainBlockInfoResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainGetCircuitResponse":{"id":"sdk/reference/interfaces/IChainGetCircuitResponse","title":"IChainGetCircuitResponse","description":"@vocdoni/sdk / Exports / IChainGetCircuitResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainGetCostsResponse":{"id":"sdk/reference/interfaces/IChainGetCostsResponse","title":"IChainGetCostsResponse","description":"@vocdoni/sdk / Exports / IChainGetCostsResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainGetInfoResponse":{"id":"sdk/reference/interfaces/IChainGetInfoResponse","title":"IChainGetInfoResponse","description":"@vocdoni/sdk / Exports / IChainGetInfoResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainOrganizationCountResponse":{"id":"sdk/reference/interfaces/IChainOrganizationCountResponse","title":"IChainOrganizationCountResponse","description":"@vocdoni/sdk / Exports / IChainOrganizationCountResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainOrganizationListResponse":{"id":"sdk/reference/interfaces/IChainOrganizationListResponse","title":"IChainOrganizationListResponse","description":"@vocdoni/sdk / Exports / IChainOrganizationListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainOrganizationResponse":{"id":"sdk/reference/interfaces/IChainOrganizationResponse","title":"IChainOrganizationResponse","description":"@vocdoni/sdk / Exports / IChainOrganizationResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainSubmitTxResponse":{"id":"sdk/reference/interfaces/IChainSubmitTxResponse","title":"IChainSubmitTxResponse","description":"@vocdoni/sdk / Exports / IChainSubmitTxResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainTxCountResponse":{"id":"sdk/reference/interfaces/IChainTxCountResponse","title":"IChainTxCountResponse","description":"@vocdoni/sdk / Exports / IChainTxCountResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainTxListResponse":{"id":"sdk/reference/interfaces/IChainTxListResponse","title":"IChainTxListResponse","description":"@vocdoni/sdk / Exports / IChainTxListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainTxReference":{"id":"sdk/reference/interfaces/IChainTxReference","title":"IChainTxReference","description":"@vocdoni/sdk / Exports / IChainTxReference","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainValidator":{"id":"sdk/reference/interfaces/IChainValidator","title":"IChainValidator","description":"@vocdoni/sdk / Exports / IChainValidator","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChainValidatorsListResponse":{"id":"sdk/reference/interfaces/IChainValidatorsListResponse","title":"IChainValidatorsListResponse","description":"@vocdoni/sdk / Exports / IChainValidatorsListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IChoice":{"id":"sdk/reference/interfaces/IChoice","title":"IChoice","description":"@vocdoni/sdk / Exports / IChoice","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionCreateResponse":{"id":"sdk/reference/interfaces/IElectionCreateResponse","title":"IElectionCreateResponse","description":"@vocdoni/sdk / Exports / IElectionCreateResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionInfoResponse":{"id":"sdk/reference/interfaces/IElectionInfoResponse","title":"IElectionInfoResponse","description":"@vocdoni/sdk / Exports / IElectionInfoResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionKeysResponse":{"id":"sdk/reference/interfaces/IElectionKeysResponse","title":"IElectionKeysResponse","description":"@vocdoni/sdk / Exports / IElectionKeysResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionListFilter":{"id":"sdk/reference/interfaces/IElectionListFilter","title":"IElectionListFilter","description":"@vocdoni/sdk / Exports / IElectionListFilter","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionListResponse":{"id":"sdk/reference/interfaces/IElectionListResponse","title":"IElectionListResponse","description":"@vocdoni/sdk / Exports / IElectionListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionMode":{"id":"sdk/reference/interfaces/IElectionMode","title":"IElectionMode","description":"@vocdoni/sdk / Exports / IElectionMode","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionNextIdResponse":{"id":"sdk/reference/interfaces/IElectionNextIdResponse","title":"IElectionNextIdResponse","description":"@vocdoni/sdk / Exports / IElectionNextIdResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionParameters":{"id":"sdk/reference/interfaces/IElectionParameters","title":"IElectionParameters","description":"@vocdoni/sdk / Exports / IElectionParameters","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionSummary":{"id":"sdk/reference/interfaces/IElectionSummary","title":"IElectionSummary","description":"@vocdoni/sdk / Exports / IElectionSummary","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionType":{"id":"sdk/reference/interfaces/IElectionType","title":"IElectionType","description":"@vocdoni/sdk / Exports / IElectionType","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionVote":{"id":"sdk/reference/interfaces/IElectionVote","title":"IElectionVote","description":"@vocdoni/sdk / Exports / IElectionVote","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IElectionVoteListResponse":{"id":"sdk/reference/interfaces/IElectionVoteListResponse","title":"IElectionVoteListResponse","description":"@vocdoni/sdk / Exports / IElectionVoteListResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IEncryptionKey":{"id":"sdk/reference/interfaces/IEncryptionKey","title":"IEncryptionKey","description":"@vocdoni/sdk / Exports / IEncryptionKey","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IInvalidElectionParameters":{"id":"sdk/reference/interfaces/IInvalidElectionParameters","title":"IInvalidElectionParameters","description":"@vocdoni/sdk / Exports / IInvalidElectionParameters","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IMultiChoiceElectionParameters":{"id":"sdk/reference/interfaces/IMultiChoiceElectionParameters","title":"IMultiChoiceElectionParameters","description":"@vocdoni/sdk / Exports / IMultiChoiceElectionParameters","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IPublishedElectionParameters":{"id":"sdk/reference/interfaces/IPublishedElectionParameters","title":"IPublishedElectionParameters","description":"@vocdoni/sdk / Exports / IPublishedElectionParameters","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IQuestion":{"id":"sdk/reference/interfaces/IQuestion","title":"IQuestion","description":"@vocdoni/sdk / Exports / IQuestion","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ITallyMode":{"id":"sdk/reference/interfaces/ITallyMode","title":"ITallyMode","description":"@vocdoni/sdk / Exports / ITallyMode","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IVoteInfoResponse":{"id":"sdk/reference/interfaces/IVoteInfoResponse","title":"IVoteInfoResponse","description":"@vocdoni/sdk / Exports / IVoteInfoResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IVoteMode":{"id":"sdk/reference/interfaces/IVoteMode","title":"IVoteMode","description":"@vocdoni/sdk / Exports / IVoteMode","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IVoteSubmitResponse":{"id":"sdk/reference/interfaces/IVoteSubmitResponse","title":"IVoteSubmitResponse","description":"@vocdoni/sdk / Exports / IVoteSubmitResponse","sidebar":"defaultSidebar"},"sdk/reference/interfaces/IVoteType":{"id":"sdk/reference/interfaces/IVoteType","title":"IVoteType","description":"@vocdoni/sdk / Exports / IVoteType","sidebar":"defaultSidebar"},"sdk/reference/interfaces/MintTokensTx":{"id":"sdk/reference/interfaces/MintTokensTx","title":"MintTokensTx","description":"@vocdoni/sdk / Exports / MintTokensTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/NewProcessTx":{"id":"sdk/reference/interfaces/NewProcessTx","title":"NewProcessTx","description":"@vocdoni/sdk / Exports / NewProcessTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/Process":{"id":"sdk/reference/interfaces/Process","title":"Process","description":"@vocdoni/sdk / Exports / Process","sidebar":"defaultSidebar"},"sdk/reference/interfaces/Proof":{"id":"sdk/reference/interfaces/Proof","title":"Proof","description":"@vocdoni/sdk / Exports / Proof","sidebar":"defaultSidebar"},"sdk/reference/interfaces/RegisterKeyTx":{"id":"sdk/reference/interfaces/RegisterKeyTx","title":"RegisterKeyTx","description":"@vocdoni/sdk / Exports / RegisterKeyTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/SendTokensTx":{"id":"sdk/reference/interfaces/SendTokensTx","title":"SendTokensTx","description":"@vocdoni/sdk / Exports / SendTokensTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/ServiceProperties":{"id":"sdk/reference/interfaces/ServiceProperties","title":"ServiceProperties","description":"@vocdoni/sdk / Exports / ServiceProperties","sidebar":"defaultSidebar"},"sdk/reference/interfaces/SetAccountTx":{"id":"sdk/reference/interfaces/SetAccountTx","title":"SetAccountTx","description":"@vocdoni/sdk / Exports / SetAccountTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/SetProcessTx":{"id":"sdk/reference/interfaces/SetProcessTx","title":"SetProcessTx","description":"@vocdoni/sdk / Exports / SetProcessTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/SetTransactionCostsTx":{"id":"sdk/reference/interfaces/SetTransactionCostsTx","title":"SetTransactionCostsTx","description":"@vocdoni/sdk / Exports / SetTransactionCostsTx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/Tx":{"id":"sdk/reference/interfaces/Tx","title":"Tx","description":"@vocdoni/sdk / Exports / Tx","sidebar":"defaultSidebar"},"sdk/reference/interfaces/VoteEnvelope":{"id":"sdk/reference/interfaces/VoteEnvelope","title":"VoteEnvelope","description":"@vocdoni/sdk / Exports / VoteEnvelope","sidebar":"defaultSidebar"},"sdk/reference/modules":{"id":"sdk/reference/modules","title":"modules","description":"@vocdoni/sdk / Exports","sidebar":"defaultSidebar"},"sdk/tutorial":{"id":"sdk/tutorial","title":"SDK Tutorial","description":"This tutorial will show you how to get your environment set up, start using the SDK, and create and vote in an election. We will be using typescript.","sidebar":"defaultSidebar"},"ui-components/Election":{"id":"ui-components/Election","title":"Election components","description":"Vocdoni Chakra components for Elections","sidebar":"defaultSidebar"},"ui-components/index":{"id":"ui-components/index","title":"UI Components","description":"Vocdoni Chakra components","sidebar":"defaultSidebar"},"ui-components/Organization":{"id":"ui-components/Organization","title":"Organization components","description":"Vocdoni Chakra components for Organizations","sidebar":"defaultSidebar"},"vocdoni-api/accounts":{"id":"vocdoni-api/accounts","title":"Accounts","description":"Accounts","sidebar":"defaultSidebar"},"vocdoni-api/add-account":{"id":"vocdoni-api/add-account","title":"Add account","description":"Add a new account to the local store. It returns a token used to manage this account on the future.","sidebar":"defaultSidebar"},"vocdoni-api/add-participants-to-census":{"id":"vocdoni-api/add-participants-to-census","title":"Add participants to census","description":"Add list of public key/address with its weight to an unpublished census and returns the resulting","sidebar":"defaultSidebar"},"vocdoni-api/census-merkle-root":{"id":"vocdoni-api/census-merkle-root","title":"Census Merkle Root","description":"Get census [Merkle Tree root](https://docs.vocdoni.io/architecture/census/off-chain-tree.html) hash, used to identify the census at specific snapshot.\\n\\n- Bearer token not required","sidebar":"defaultSidebar"},"vocdoni-api/census-size":{"id":"vocdoni-api/census-size","title":"Census size","description":"Total number of keys added to the census. Size as integer","sidebar":"defaultSidebar"},"vocdoni-api/census-total-weight":{"id":"vocdoni-api/census-total-weight","title":"Census total weight","description":"It sums all weights added to the census. Weight is a stringified bigInt","sidebar":"defaultSidebar"},"vocdoni-api/censuses":{"id":"vocdoni-api/censuses","title":"Censuses","description":"Censuses","sidebar":"defaultSidebar"},"vocdoni-api/chain":{"id":"vocdoni-api/chain","title":"Chain","description":"Chain","sidebar":"defaultSidebar"},"vocdoni-api/circuit-info":{"id":"vocdoni-api/circuit-info","title":"Circuit info","description":"Returns the circuit configuration according to the current circuit","sidebar":"defaultSidebar"},"vocdoni-api/compute-election-price":{"id":"vocdoni-api/compute-election-price","title":"Compute election price","description":"Helper endpoint to get the election price.","sidebar":"defaultSidebar"},"vocdoni-api/compute-ipfs-ci-dv-1-of-file":{"id":"vocdoni-api/compute-ipfs-ci-dv-1-of-file","title":"Compute IPFS CIDv1 of file","description":"Helper endpoint to get the IPFS CIDv1 hash of a file","sidebar":"defaultSidebar"},"vocdoni-api/count-election-votes":{"id":"vocdoni-api/count-election-votes","title":"Count election votes","description":"Get the number of votes for an election","sidebar":"defaultSidebar"},"vocdoni-api/count-organization-elections":{"id":"vocdoni-api/count-organization-elections","title":"Count organization elections","description":"Returns the number of elections for an organization","sidebar":"defaultSidebar"},"vocdoni-api/count-organizations":{"id":"vocdoni-api/count-organizations","title":"Count organizations","description":"Return the number of organizations","sidebar":"defaultSidebar"},"vocdoni-api/create-a-new-census":{"id":"vocdoni-api/create-a-new-census","title":"Create a new census","description":"Create a new census on the backend side. The census is still unpublished until [publish](publish-census) is called.","sidebar":"defaultSidebar"},"vocdoni-api/create-election":{"id":"vocdoni-api/create-election","title":"Create election","description":"It creates an election on the Vochain.","sidebar":"defaultSidebar"},"vocdoni-api/create-election-for-wallet":{"id":"vocdoni-api/create-election-for-wallet","title":"Create election for wallet","description":"Creates an election. Requires the bearer token of the account you want to create the election.","sidebar":"defaultSidebar"},"vocdoni-api/delete-census":{"id":"vocdoni-api/delete-census","title":"Delete census","description":"Delete unpublished census (not on the storage yet). See [publish census](census-publish)\\n","sidebar":"defaultSidebar"},"vocdoni-api/election-information":{"id":"vocdoni-api/election-information","title":"Election information","description":"Get full election information","sidebar":"defaultSidebar"},"vocdoni-api/election-results":{"id":"vocdoni-api/election-results","title":"Election results","description":"Returns a given election consensus results and useful information about the results. Results represented with BigInt strings.","sidebar":"defaultSidebar"},"vocdoni-api/elections":{"id":"vocdoni-api/elections","title":"Elections","description":"Elections","sidebar":"defaultSidebar"},"vocdoni-api/estimate-block-to-date":{"id":"vocdoni-api/estimate-block-to-date","title":"Estimate block to date","description":"Returns the estimated timestamp for the block height provided","sidebar":"defaultSidebar"},"vocdoni-api/estimate-date-to-block":{"id":"vocdoni-api/estimate-date-to-block","title":"Estimate date to block","description":"Returns the estimated block height for the timestamp provided","sidebar":"defaultSidebar"},"vocdoni-api/export-census":{"id":"vocdoni-api/export-census","title":"Export census","description":"Export census to JSON format. Requires Bearer token","sidebar":"defaultSidebar"},"vocdoni-api/export-census-database":{"id":"vocdoni-api/export-census-database","title":"Export census database","description":"Export the whole census database to a JSON file. Requires Admin Bearer token.","sidebar":"defaultSidebar"},"vocdoni-api/exports-the-indexer-database":{"id":"vocdoni-api/exports-the-indexer-database","title":"Exports the indexer database","description":"Exports the indexer SQL database in raw format","sidebar":"defaultSidebar"},"vocdoni-api/get-account":{"id":"vocdoni-api/get-account","title":"Get account","description":"Get account information by its address or public key. The `infoURI` parameter contain where account metadata is uploaded (like avatar, name...). It return also an already parsed \'metadata\' object from this infoUri.","sidebar":"defaultSidebar"},"vocdoni-api/get-block-by-hash":{"id":"vocdoni-api/get-block-by-hash","title":"Get block (by hash)","description":"Returns the block from the given hash","sidebar":"defaultSidebar"},"vocdoni-api/get-block-by-height":{"id":"vocdoni-api/get-block-by-height","title":"Get block (by height)","description":"Returns the full block information at the given height","sidebar":"defaultSidebar"},"vocdoni-api/get-next-election-id":{"id":"vocdoni-api/get-next-election-id","title":"Get next election ID","description":"nextElectionIDHandler","sidebar":"defaultSidebar"},"vocdoni-api/get-type-of-census":{"id":"vocdoni-api/get-type-of-census","title":"Get type of census","description":"Get the census type","sidebar":"defaultSidebar"},"vocdoni-api/get-vote":{"id":"vocdoni-api/get-vote","title":"Get vote","description":"Get the content of an existing Vote. If is an encrypted election it return the `encryptionKeys` indexes and the package will be codified.","sidebar":"defaultSidebar"},"vocdoni-api/import-census":{"id":"vocdoni-api/import-census","title":"Import census","description":"Import census from JSON previously exported using [`/censuses/{censusId}/export`](census-export). Requires Bearer token","sidebar":"defaultSidebar"},"vocdoni-api/import-census-database":{"id":"vocdoni-api/import-census-database","title":"Import census database","description":"Import the whole census database from a JSON file.","sidebar":"defaultSidebar"},"vocdoni-api/list-account-received-and-sent-token-transfers":{"id":"vocdoni-api/list-account-received-and-sent-token-transfers","title":"List account received and sent token transfers","description":"Returns the token transfers for an account. A transfer is a token transference from one account to other (excepting the burn address).","sidebar":"defaultSidebar"},"vocdoni-api/list-account-token-fees":{"id":"vocdoni-api/list-account-token-fees","title":"List account token fees","description":"Returns the token fees for an account. A spending is an amount of tokens burnt from one account for executing transactions.","sidebar":"defaultSidebar"},"vocdoni-api/list-all-census-references":{"id":"vocdoni-api/list-all-census-references","title":"List all census references","description":"List all census references. Requires Admin Bearer token.","sidebar":"defaultSidebar"},"vocdoni-api/list-all-token-fees":{"id":"vocdoni-api/list-all-token-fees","title":"List all token fees","description":"Returns the token fees list ordered by date. A spending is an amount of tokens burnt from one account for executing transactions.","sidebar":"defaultSidebar"},"vocdoni-api/list-all-token-fees-by-reference":{"id":"vocdoni-api/list-all-token-fees-by-reference","title":"List all token fees by reference","description":"Returns the token fees list filtered by reference and ordered by date. A spending is an amount of tokens burnt from one account for executing transactions.","sidebar":"defaultSidebar"},"vocdoni-api/list-all-token-fees-by-type":{"id":"vocdoni-api/list-all-token-fees-by-type","title":"List all token fees by type","description":"Returns the token fees list filtered by type and ordered by date. A spending is an amount of tokens burnt from one account for executing transactions.","sidebar":"defaultSidebar"},"vocdoni-api/list-election-votes":{"id":"vocdoni-api/list-election-votes","title":"List election votes","description":"Returns the list of voteIDs for an election (paginated)","sidebar":"defaultSidebar"},"vocdoni-api/list-elections":{"id":"vocdoni-api/list-elections","title":"List elections","description":"Get a list of elections summaries.","sidebar":"defaultSidebar"},"vocdoni-api/list-elections-filtered":{"id":"vocdoni-api/list-elections-filtered","title":"List elections (filtered)","description":"Return a filtered elections list, the available filters have to be sent on the request body. Available are:","sidebar":"defaultSidebar"},"vocdoni-api/list-encryption-keys":{"id":"vocdoni-api/list-encryption-keys","title":"List encryption keys","description":"Returns the list of public/private encryption keys","sidebar":"defaultSidebar"},"vocdoni-api/list-of-the-existing-accounts":{"id":"vocdoni-api/list-of-the-existing-accounts","title":"List of the existing accounts","description":"Returns information (address, balance and nonce) of the existing accounts","sidebar":"defaultSidebar"},"vocdoni-api/list-of-valid-sik-roots":{"id":"vocdoni-api/list-of-valid-sik-roots","title":"List of valid SIK roots","description":"Returns the list of currently valid roots of the merkle tree where the vochain account SIK\'s are stored.","sidebar":"defaultSidebar"},"vocdoni-api/list-organization-elections":{"id":"vocdoni-api/list-organization-elections","title":"List organization elections","description":"List the elections of an organization","sidebar":"defaultSidebar"},"vocdoni-api/list-organization-elections-by-status":{"id":"vocdoni-api/list-organization-elections-by-status","title":"List organization elections by status","description":"List the elections of an organization by status","sidebar":"defaultSidebar"},"vocdoni-api/list-organizations":{"id":"vocdoni-api/list-organizations","title":"List organizations","description":"An **Organizations** is an account with `infoUri` that contains organization associated metadata.","sidebar":"defaultSidebar"},"vocdoni-api/list-organizations-filtered":{"id":"vocdoni-api/list-organizations-filtered","title":"List organizations (filtered)","description":"Returns a list of organizations filtered by its partial id, paginated by the given page","sidebar":"defaultSidebar"},"vocdoni-api/list-transactions":{"id":"vocdoni-api/list-transactions","title":"List Transactions","description":"To get full transaction information use [/chain/transaction/{blockHeight}/{txIndex}](transaction-by-block-index).\\nWhere transactionIndex is the index of the transaction on the containing block.","sidebar":"defaultSidebar"},"vocdoni-api/list-validators":{"id":"vocdoni-api/list-validators","title":"List validators","description":"Returns the list of validators","sidebar":"defaultSidebar"},"vocdoni-api/price-factors-information":{"id":"vocdoni-api/price-factors-information","title":"Price factors information","description":"Package electionprice provides a mechanism for calculating the price of an election based on its characteristics.","sidebar":"defaultSidebar"},"vocdoni-api/prove-key-to-census":{"id":"vocdoni-api/prove-key-to-census","title":"Prove key to census","description":"Prove the key and weight belong to the census root hash.","sidebar":"defaultSidebar"},"vocdoni-api/publish-census":{"id":"vocdoni-api/publish-census","title":"Publish census","description":"Register a census to the storage (IPFS in our case). After this, the census can\'t be edited.","sidebar":"defaultSidebar"},"vocdoni-api/publish-census-at-root":{"id":"vocdoni-api/publish-census-at-root","title":"Publish census at root","description":"Register a census to the storage (IPFS in our case). After this, the census can\'t be edited.","sidebar":"defaultSidebar"},"vocdoni-api/returns-if-the-address-provided-has-a-valid-sik":{"id":"vocdoni-api/returns-if-the-address-provided-has-a-valid-sik","title":"Returns if the address provided has a valid SIK","description":"Returns if the address provided, associated to an a registered account or not, has a valid SIK already registered or not.","sidebar":"defaultSidebar"},"vocdoni-api/set-account":{"id":"vocdoni-api/set-account","title":"Set account","description":"It register an account to the blockchain including IPFS metadata upload.","sidebar":"defaultSidebar"},"vocdoni-api/set-wallet-account":{"id":"vocdoni-api/set-wallet-account","title":"Set wallet account","description":"Set a new account. Needed the bearer token associated the account.","sidebar":"defaultSidebar"},"vocdoni-api/sik":{"id":"vocdoni-api/sik","title":"SIK","description":"SIK","sidebar":"defaultSidebar"},"vocdoni-api/submit-a-vote":{"id":"vocdoni-api/submit-a-vote","title":"Submit a vote","description":"Submit a vote using a protobuf signed transaction. The corresponding result are the vote id and transaction hash where the vote is registered.","sidebar":"defaultSidebar"},"vocdoni-api/submit-transaction":{"id":"vocdoni-api/submit-transaction","title":"Submit transaction","description":"It submit a transaction. Depending of transaction type will return different kinds of responses:","sidebar":"defaultSidebar"},"vocdoni-api/total-number-of-accounts":{"id":"vocdoni-api/total-number-of-accounts","title":"Total number of accounts","description":"Returns the count of total number of existing accounts","sidebar":"defaultSidebar"},"vocdoni-api/total-number-of-sent-and-received-transactions":{"id":"vocdoni-api/total-number-of-sent-and-received-transactions","title":"Total number of sent and received transactions","description":"Returns the count of total number of sent and received transactions for an account. A transaction is a token transfer from one account to another existing account","sidebar":"defaultSidebar"},"vocdoni-api/transaction-by-block-height-and-index":{"id":"vocdoni-api/transaction-by-block-height-and-index","title":"Transaction by block height and index","description":"Get transaction full information by block height and index. It returns JSON transaction protobuf encoded. Depending of transaction type will return different types of objects. Current transaction types can be found calling `/chain/transactions/cost`","sidebar":"defaultSidebar"},"vocdoni-api/transaction-by-hash":{"id":"vocdoni-api/transaction-by-hash","title":"Transaction by hash","description":"Using transaction hash it return the `block` and `index` containing that contains the transaction. After, you could use this `block` and `index` to retrieve transaction full info using [transaction by block and index](transaction-by-block-index)","sidebar":"defaultSidebar"},"vocdoni-api/transaction-by-index":{"id":"vocdoni-api/transaction-by-index","title":"Transaction by index","description":"Get transaction by its index. This is not transaction reference (hash), and neither the block height and block index. The transaction index is an incremental counter for each transaction. You could use the transaction `block` and `index` to retrieve full info using [transaction by block and index](transaction-by-block-index).","sidebar":"defaultSidebar"},"vocdoni-api/transaction-costs":{"id":"vocdoni-api/transaction-costs","title":"Transaction costs","description":"Returns the list of transactions and its cost","sidebar":"defaultSidebar"},"vocdoni-api/transactions-count":{"id":"vocdoni-api/transactions-count","title":"Transactions count","description":"Returns the number of transactions","sidebar":"defaultSidebar"},"vocdoni-api/transactions-in-a-block":{"id":"vocdoni-api/transactions-in-a-block","title":"Transactions in a block","description":"Given a block returns the list of transactions for that block","sidebar":"defaultSidebar"},"vocdoni-api/transfer-tokens":{"id":"vocdoni-api/transfer-tokens","title":"Transfer tokens","description":"Transfer balance to another account. Needed the bearer token associated the account.","sidebar":"defaultSidebar"},"vocdoni-api/verify-merkle-proof":{"id":"vocdoni-api/verify-merkle-proof","title":"Verify merkle proof","description":"Verify that a previously obtained Merkle proof for a key, acquired via [/censuses/{censusId}/proof/{publicKey}](prove-key-to-census) is still correct.","sidebar":"defaultSidebar"},"vocdoni-api/verify-vote":{"id":"vocdoni-api/verify-vote","title":"Verify vote","description":"Check if vote is registered on the blockchain on specific election. Just return Ok status code","sidebar":"defaultSidebar"},"vocdoni-api/vocdoni-api":{"id":"vocdoni-api/vocdoni-api","title":"Vocdoni API","description":"The Vocdoni API is a REST API that substitutes the previous RPCs in order to make it easier for developers/integrators to build on top of the voting protocol. This API facilitates creating votings using Vocdoni, without the hassle of learning a complex blockchain platform, allowing to perform all the features that enable the voting protocol such as creating an account, entity, voting process, census & vote, abstracting as much as possible the complexity and offering simple and straightforward methods to perform those actions.","sidebar":"defaultSidebar"},"vocdoni-api/vochain-information":{"id":"vocdoni-api/vochain-information","title":"Vochain information","description":"Return basic Vocdoni Blockchain (Vochain) information like blockTime, chainId, current height...","sidebar":"defaultSidebar"},"vocdoni-api/votes":{"id":"vocdoni-api/votes","title":"Votes","description":"Votes","sidebar":"defaultSidebar"},"vocdoni-api/wallet":{"id":"vocdoni-api/wallet","title":"Wallet","description":"Wallet","sidebar":"defaultSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/93908748.36ec483d.js b/assets/js/93908748.ae843d75.js similarity index 60% rename from assets/js/93908748.36ec483d.js rename to assets/js/93908748.ae843d75.js index b23ad7a80..e7a9c4566 100644 --- a/assets/js/93908748.36ec483d.js +++ b/assets/js/93908748.ae843d75.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4805],{3905:(e,n,r)=>{r.d(n,{Zo:()=>p,kt:()=>f});var t=r(67294);function o(e,n,r){return n in e?Object.defineProperty(e,n,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[n]=r,e}function s(e,n){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(e);n&&(t=t.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),r.push.apply(r,t)}return r}function a(e){for(var n=1;n=0||(o[r]=e[r]);return o}(e,n);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var c=t.createContext({}),l=function(e){var n=t.useContext(c),r=n;return e&&(r="function"==typeof e?e(n):a(a({},n),e)),r},p=function(e){var n=l(e.components);return t.createElement(c.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return t.createElement(t.Fragment,{},n)}},d=t.forwardRef((function(e,n){var r=e.components,o=e.mdxType,s=e.originalType,c=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),d=l(r),f=o,k=d["".concat(c,".").concat(f)]||d[f]||u[f]||s;return r?t.createElement(k,a(a({ref:n},p),{},{components:r})):t.createElement(k,a({ref:n},p))}));function f(e,n){var r=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var s=r.length,a=new Array(s);a[0]=d;var i={};for(var c in n)hasOwnProperty.call(n,c)&&(i[c]=n[c]);i.originalType=e,i.mdxType="string"==typeof e?e:o,a[1]=i;for(var l=2;l{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>i,toc:()=>l});var t=r(87462),o=(r(67294),r(3905));const s={},a=void 0,i={unversionedId:"sdk/reference/interfaces/ICensus3TokenHolderResponse",id:"sdk/reference/interfaces/ICensus3TokenHolderResponse",title:"ICensus3TokenHolderResponse",description:"@vocdoni/sdk / Exports / ICensus3TokenHolderResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3TokenHolderResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3TokenHolderResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenHolderResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3SupportedChain",permalink:"/sdk/reference/interfaces/ICensus3SupportedChain"},next:{title:"ICensus3TokenListResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenListResponse"}},c={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"balance",id:"balance",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:l};function u(e){let{components:n,...r}=e;return(0,o.kt)("wrapper",(0,t.Z)({},p,r,{components:n,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3TokenHolderResponse"),(0,o.kt)("h1",{id:"interface-icensus3tokenholderresponse"},"Interface: ICensus3TokenHolderResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3TokenHolderResponse#balance"},"balance"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"balance"},"balance"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"balance"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The balance of the holder"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/token.ts#L117"},"api/census3/token.ts:117")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4805],{3905:(e,n,r)=>{r.d(n,{Zo:()=>p,kt:()=>f});var t=r(67294);function o(e,n,r){return n in e?Object.defineProperty(e,n,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[n]=r,e}function s(e,n){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(e);n&&(t=t.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),r.push.apply(r,t)}return r}function a(e){for(var n=1;n=0||(o[r]=e[r]);return o}(e,n);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=t.createContext({}),c=function(e){var n=t.useContext(l),r=n;return e&&(r="function"==typeof e?e(n):a(a({},n),e)),r},p=function(e){var n=c(e.components);return t.createElement(l.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return t.createElement(t.Fragment,{},n)}},d=t.forwardRef((function(e,n){var r=e.components,o=e.mdxType,s=e.originalType,l=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),d=c(r),f=o,k=d["".concat(l,".").concat(f)]||d[f]||u[f]||s;return r?t.createElement(k,a(a({ref:n},p),{},{components:r})):t.createElement(k,a({ref:n},p))}));function f(e,n){var r=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var s=r.length,a=new Array(s);a[0]=d;var i={};for(var l in n)hasOwnProperty.call(n,l)&&(i[l]=n[l]);i.originalType=e,i.mdxType="string"==typeof e?e:o,a[1]=i;for(var c=2;c{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>i,toc:()=>c});var t=r(87462),o=(r(67294),r(3905));const s={},a=void 0,i={unversionedId:"sdk/reference/interfaces/ICensus3TokenHolderResponse",id:"sdk/reference/interfaces/ICensus3TokenHolderResponse",title:"ICensus3TokenHolderResponse",description:"@vocdoni/sdk / Exports / ICensus3TokenHolderResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3TokenHolderResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3TokenHolderResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenHolderResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3SupportedChain",permalink:"/sdk/reference/interfaces/ICensus3SupportedChain"},next:{title:"ICensus3TokenListResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenListResponse"}},l={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"balance",id:"balance",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:c};function u(e){let{components:n,...r}=e;return(0,o.kt)("wrapper",(0,t.Z)({},p,r,{components:n,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3TokenHolderResponse"),(0,o.kt)("h1",{id:"interface-icensus3tokenholderresponse"},"Interface: ICensus3TokenHolderResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"ICensus3TokenHolderResponse#balance"},"balance"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"balance"},"balance"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"balance"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The balance of the holder"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/token.ts#L117"},"api/census3/token.ts:117")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/94050a54.958517fd.js b/assets/js/94050a54.958517fd.js new file mode 100644 index 000000000..0a857a751 --- /dev/null +++ b/assets/js/94050a54.958517fd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8180],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>d});var n=r(67294);function s(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t=0||(s[r]=e[r]);return s}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(s[r]=e[r])}return s}var p=n.createContext({}),c=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},l=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,s=e.mdxType,o=e.originalType,p=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),f=c(r),d=s,m=f["".concat(p,".").concat(d)]||f[d]||u[d]||o;return r?n.createElement(m,a(a({ref:t},l),{},{components:r})):n.createElement(m,a({ref:t},l))}));function d(e,t){var r=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var o=r.length,a=new Array(o);a[0]=f;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i.mdxType="string"==typeof e?e:s,a[1]=i;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var n=r(87462),s=(r(67294),r(3905));const o={},a=void 0,i={unversionedId:"sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse",id:"sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse",title:"ICensus3StrategiesOperatorsResponse",description:"@vocdoni/sdk / Exports / ICensus3StrategiesOperatorsResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategiesOperator",permalink:"/sdk/reference/interfaces/ICensus3StrategiesOperator"},next:{title:"ICensus3StrategyCreateResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyCreateResponse"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"operators",id:"operators",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:c};function u(e){let{components:t,...r}=e;return(0,s.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3StrategiesOperatorsResponse"),(0,s.kt)("h1",{id:"interface-icensus3strategiesoperatorsresponse"},"Interface: ICensus3StrategiesOperatorsResponse"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus3StrategiesOperatorsResponse#operators"},"operators"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"operators"},"operators"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"operators"),": ",(0,s.kt)("a",{parentName:"p",href:"ICensus3StrategiesOperator"},(0,s.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesOperator")),"[]"),(0,s.kt)("p",null,"The list of supported operators"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L235"},"api/census3/strategy.ts:235")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/94050a54.9a3b4697.js b/assets/js/94050a54.9a3b4697.js deleted file mode 100644 index 46bcf888a..000000000 --- a/assets/js/94050a54.9a3b4697.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8180],{3905:(e,r,t)=>{t.d(r,{Zo:()=>l,kt:()=>d});var n=t(67294);function s(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function o(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function a(e){for(var r=1;r=0||(s[t]=e[t]);return s}(e,r);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(s[t]=e[t])}return s}var p=n.createContext({}),c=function(e){var r=n.useContext(p),t=r;return e&&(t="function"==typeof e?e(r):a(a({},r),e)),t},l=function(e){var r=c(e.components);return n.createElement(p.Provider,{value:r},e.children)},u={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},f=n.forwardRef((function(e,r){var t=e.components,s=e.mdxType,o=e.originalType,p=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),f=c(t),d=s,m=f["".concat(p,".").concat(d)]||f[d]||u[d]||o;return t?n.createElement(m,a(a({ref:r},l),{},{components:t})):n.createElement(m,a({ref:r},l))}));function d(e,r){var t=arguments,s=r&&r.mdxType;if("string"==typeof e||s){var o=t.length,a=new Array(o);a[0]=f;var i={};for(var p in r)hasOwnProperty.call(r,p)&&(i[p]=r[p]);i.originalType=e,i.mdxType="string"==typeof e?e:s,a[1]=i;for(var c=2;c{t.r(r),t.d(r,{assets:()=>p,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var n=t(87462),s=(t(67294),t(3905));const o={},a=void 0,i={unversionedId:"sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse",id:"sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse",title:"ICensus3StrategiesOperatorsResponse",description:"@vocdoni/sdk / Exports / ICensus3StrategiesOperatorsResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategiesOperator",permalink:"/sdk/reference/interfaces/ICensus3StrategiesOperator"},next:{title:"ICensus3StrategyCreateResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyCreateResponse"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"operators",id:"operators",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:c};function u(e){let{components:r,...t}=e;return(0,s.kt)("wrapper",(0,n.Z)({},l,t,{components:r,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3StrategiesOperatorsResponse"),(0,s.kt)("h1",{id:"interface-icensus3strategiesoperatorsresponse"},"Interface: ICensus3StrategiesOperatorsResponse"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse#operators"},"operators"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"operators"},"operators"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"operators"),": ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategiesOperator"},(0,s.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesOperator")),"[]"),(0,s.kt)("p",null,"The list of supported operators"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L235"},"api/census3/strategy.ts:235")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/945f0be5.00e7e5be.js b/assets/js/945f0be5.00e7e5be.js deleted file mode 100644 index 4251f837e..000000000 --- a/assets/js/945f0be5.00e7e5be.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5104],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>u});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=a.createContext({}),p=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},o=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),m=p(n),u=r,N=m["".concat(s,".").concat(u)]||m[u]||k[u]||i;return n?a.createElement(N,l(l({ref:t},o),{},{components:n})):a.createElement(N,l({ref:t},o))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>d,toc:()=>p});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,d={unversionedId:"sdk/reference/classes/Census3TokenAPI",id:"sdk/reference/classes/Census3TokenAPI",title:"Census3TokenAPI",description:"@vocdoni/sdk / Exports / Census3TokenAPI",source:"@site/docs/sdk/reference/classes/Census3TokenAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Census3TokenAPI",permalink:"/sdk/reference/classes/Census3TokenAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Census3StrategyAPI",permalink:"/sdk/reference/classes/Census3StrategyAPI"},next:{title:"CensusAPI",permalink:"/sdk/reference/classes/CensusAPI"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"holder",id:"holder",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"list",id:"list",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"serializePagination",id:"serializepagination",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"token",id:"token",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"types",id:"types",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4}],o={toc:p};function k(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / Census3TokenAPI"),(0,r.kt)("h1",{id:"class-census3tokenapi"},"Class: Census3TokenAPI"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"Census3API")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Census3TokenAPI"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3TokenAPI#constructor"},"constructor"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3TokenAPI#create"},"create")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3TokenAPI#holder"},"holder")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3TokenAPI#isapierror"},"isApiError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3TokenAPI#isundefinederror"},"isUndefinedError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3TokenAPI#list"},"list")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3TokenAPI#serializepagination"},"serializePagination")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3TokenAPI#token"},"token")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3TokenAPI#types"},"types"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new Census3TokenAPI"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census3TokenAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3TokenAPI"))),(0,r.kt)("p",null,"Cannot be constructed."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census3TokenAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3TokenAPI"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"Census3API.constructor"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/token.ts#L138"},"api/census3/token.ts:138")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"create"},"create"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"create"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"tags?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Triggers a new scan for the provided token."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The token address")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"type")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The type of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chain id of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The tags assigned for the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"promised IFileCIDResponse"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/token.ts#L229"},"api/census3/token.ts:229")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"holder"},"holder"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"holder"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"tokenId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"holderId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3TokenHolderResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3TokenHolderResponse")),">"),(0,r.kt)("p",null,"Returns if the holder ID is already registered in the database as a holder of the token ID and chain ID provided."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokenId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chain identifier of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"holderId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the holder")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3TokenHolderResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3TokenHolderResponse")),">"),(0,r.kt)("p",null,"The balance of holder"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/token.ts#L199"},"api/census3/token.ts:199")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isapierror"},"isApiError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"Census3API.isApiError"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/api.ts#L101"},"api/census3/api.ts:101")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"Census3API.isUndefinedError"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L64"},"api/api.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"list"},"list"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"list"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pagination?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3TokenListResponsePaginated")),">"),(0,r.kt)("p",null,"Fetches list of already added tokens"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pagination?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Census3Pagination")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Pagination options")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3TokenListResponsePaginated")),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/token.ts#L149"},"api/census3/token.ts:149")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"serializepagination"},"serializePagination"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"serializePagination"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"pagination?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pagination?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Census3Pagination"))))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,"Census3API.serializePagination"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/api.ts#L92"},"api/census3/api.ts:92")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"token"},"token"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"token"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"tokenId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3token"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Token")),">"),(0,r.kt)("p",null,"Fetch the full token information"),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokenId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chain identifier of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3token"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Token")),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/token.ts#L178"},"api/census3/token.ts:178")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"types"},"types"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"types"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3TokenTypesResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3TokenTypesResponse")),">"),(0,r.kt)("p",null,"Fetches list of tokens types"),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3TokenTypesResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3TokenTypesResponse")),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/token.ts#L162"},"api/census3/token.ts:162")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/945f0be5.289ade11.js b/assets/js/945f0be5.289ade11.js new file mode 100644 index 000000000..cd1fbc303 --- /dev/null +++ b/assets/js/945f0be5.289ade11.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5104],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),o=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=o(e.components);return a.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),m=o(n),u=r,N=m["".concat(p,".").concat(u)]||m[u]||k[u]||i;return n?a.createElement(N,l(l({ref:t},s),{},{components:n})):a.createElement(N,l({ref:t},s))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,d={unversionedId:"sdk/reference/classes/Census3TokenAPI",id:"sdk/reference/classes/Census3TokenAPI",title:"Census3TokenAPI",description:"@vocdoni/sdk / Exports / Census3TokenAPI",source:"@site/docs/sdk/reference/classes/Census3TokenAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Census3TokenAPI",permalink:"/sdk/reference/classes/Census3TokenAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Census3StrategyAPI",permalink:"/sdk/reference/classes/Census3StrategyAPI"},next:{title:"CensusAPI",permalink:"/sdk/reference/classes/CensusAPI"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"holder",id:"holder",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"list",id:"list",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"serializePagination",id:"serializepagination",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"token",id:"token",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"types",id:"types",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4}],s={toc:o};function k(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / Census3TokenAPI"),(0,r.kt)("h1",{id:"class-census3tokenapi"},"Class: Census3TokenAPI"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"Census3API")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Census3TokenAPI"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3TokenAPI#constructor"},"constructor"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3TokenAPI#create"},"create")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3TokenAPI#holder"},"holder")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3TokenAPI#isapierror"},"isApiError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3TokenAPI#isundefinederror"},"isUndefinedError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3TokenAPI#list"},"list")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3TokenAPI#serializepagination"},"serializePagination")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3TokenAPI#token"},"token")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3TokenAPI#types"},"types"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new Census3TokenAPI"),"(): ",(0,r.kt)("a",{parentName:"p",href:"Census3TokenAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3TokenAPI"))),(0,r.kt)("p",null,"Cannot be constructed."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"Census3TokenAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3TokenAPI"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"Census3API.constructor"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/token.ts#L138"},"api/census3/token.ts:138")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"create"},"create"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"create"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"tags?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Triggers a new scan for the provided token."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The token address")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"type")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The type of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chain id of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The tags assigned for the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"promised IFileCIDResponse"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/token.ts#L229"},"api/census3/token.ts:229")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"holder"},"holder"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"holder"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"tokenId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"holderId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3TokenHolderResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3TokenHolderResponse")),">"),(0,r.kt)("p",null,"Returns if the holder ID is already registered in the database as a holder of the token ID and chain ID provided."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokenId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chain identifier of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"holderId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the holder")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3TokenHolderResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3TokenHolderResponse")),">"),(0,r.kt)("p",null,"The balance of holder"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/token.ts#L199"},"api/census3/token.ts:199")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isapierror"},"isApiError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"Census3API.isApiError"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/api.ts#L101"},"api/census3/api.ts:101")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"Census3API.isUndefinedError"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L64"},"api/api.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"list"},"list"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"list"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pagination?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3TokenListResponsePaginated"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3TokenListResponsePaginated")),">"),(0,r.kt)("p",null,"Fetches list of already added tokens"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pagination?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Census3Pagination")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Pagination options")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3TokenListResponsePaginated"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3TokenListResponsePaginated")),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/token.ts#L149"},"api/census3/token.ts:149")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"serializepagination"},"serializePagination"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"serializePagination"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"pagination?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pagination?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Census3Pagination"))))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,"Census3API.serializePagination"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/api.ts#L92"},"api/census3/api.ts:92")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"token"},"token"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"token"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"tokenId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#census3token"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Token")),">"),(0,r.kt)("p",null,"Fetch the full token information"),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokenId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chain identifier of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#census3token"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Token")),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/token.ts#L178"},"api/census3/token.ts:178")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"types"},"types"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"types"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3TokenTypesResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3TokenTypesResponse")),">"),(0,r.kt)("p",null,"Fetches list of tokens types"),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3TokenTypesResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3TokenTypesResponse")),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/token.ts#L162"},"api/census3/token.ts:162")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9611c1ba.9e4d4e4a.js b/assets/js/9611c1ba.8bc05671.js similarity index 51% rename from assets/js/9611c1ba.9e4d4e4a.js rename to assets/js/9611c1ba.8bc05671.js index 65ac66455..55d8b2a26 100644 --- a/assets/js/9611c1ba.9e4d4e4a.js +++ b/assets/js/9611c1ba.8bc05671.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6567],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),c=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),d=c(n),m=i,f=d["".concat(s,".").concat(m)]||d[m]||u[m]||a;return n?r.createElement(f,l(l({ref:t},p),{},{components:n})):r.createElement(f,l({ref:t},p))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=d;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>c});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/enums/ElectionResultsTypeNames",id:"sdk/reference/enums/ElectionResultsTypeNames",title:"ElectionResultsTypeNames",description:"@vocdoni/sdk / Exports / ElectionResultsTypeNames",source:"@site/docs/sdk/reference/enums/ElectionResultsTypeNames.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/ElectionResultsTypeNames",permalink:"/sdk/reference/enums/ElectionResultsTypeNames",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ElectionCreationSteps",permalink:"/sdk/reference/enums/ElectionCreationSteps"},next:{title:"ElectionStatus",permalink:"/sdk/reference/enums/ElectionStatus"}},s={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"APPROVAL",id:"approval",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"BUDGET",id:"budget",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"MULTIPLE_CHOICE",id:"multiple_choice",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"SINGLE_CHOICE_MULTIQUESTION",id:"single_choice_multiquestion",level:3},{value:"Defined in",id:"defined-in-3",level:4}],p={toc:c};function u(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ElectionResultsTypeNames"),(0,i.kt)("h1",{id:"enumeration-electionresultstypenames"},"Enumeration: ElectionResultsTypeNames"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionResultsTypeNames#approval"},"APPROVAL")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionResultsTypeNames#budget"},"BUDGET")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionResultsTypeNames#multiple_choice"},"MULTIPLE","_","CHOICE")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionResultsTypeNames#single_choice_multiquestion"},"SINGLE","_","CHOICE","_","MULTIQUESTION"))),(0,i.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,i.kt)("h3",{id:"approval"},"APPROVAL"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"APPROVAL")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"approval"')),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L41"},"types/metadata/election.ts:41")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"budget"},"BUDGET"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"BUDGET")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"budget-based"')),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L40"},"types/metadata/election.ts:40")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"multiple_choice"},"MULTIPLE","_","CHOICE"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"MULTIPLE","_","CHOICE")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"multiple-choice"')),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L39"},"types/metadata/election.ts:39")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"single_choice_multiquestion"},"SINGLE","_","CHOICE","_","MULTIQUESTION"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SINGLE","_","CHOICE","_","MULTIQUESTION")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"single-choice-multiquestion"')),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L38"},"types/metadata/election.ts:38")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6567],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>d});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),c=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),m=c(n),d=i,f=m["".concat(s,".").concat(d)]||m[d]||u[d]||a;return n?r.createElement(f,l(l({ref:t},p),{},{components:n})):r.createElement(f,l({ref:t},p))}));function d(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=m;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>c});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/enums/ElectionResultsTypeNames",id:"sdk/reference/enums/ElectionResultsTypeNames",title:"ElectionResultsTypeNames",description:"@vocdoni/sdk / Exports / ElectionResultsTypeNames",source:"@site/docs/sdk/reference/enums/ElectionResultsTypeNames.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/ElectionResultsTypeNames",permalink:"/sdk/reference/enums/ElectionResultsTypeNames",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ElectionCreationSteps",permalink:"/sdk/reference/enums/ElectionCreationSteps"},next:{title:"ElectionStatus",permalink:"/sdk/reference/enums/ElectionStatus"}},s={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"APPROVAL",id:"approval",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"BUDGET",id:"budget",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"MULTIPLE_CHOICE",id:"multiple_choice",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"SINGLE_CHOICE_MULTIQUESTION",id:"single_choice_multiquestion",level:3},{value:"Defined in",id:"defined-in-3",level:4}],p={toc:c};function u(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ElectionResultsTypeNames"),(0,i.kt)("h1",{id:"enumeration-electionresultstypenames"},"Enumeration: ElectionResultsTypeNames"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionResultsTypeNames#approval"},"APPROVAL")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionResultsTypeNames#budget"},"BUDGET")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionResultsTypeNames#multiple_choice"},"MULTIPLE","_","CHOICE")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionResultsTypeNames#single_choice_multiquestion"},"SINGLE","_","CHOICE","_","MULTIQUESTION"))),(0,i.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,i.kt)("h3",{id:"approval"},"APPROVAL"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"APPROVAL")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"approval"')),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L41"},"types/metadata/election.ts:41")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"budget"},"BUDGET"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"BUDGET")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"budget-based"')),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L40"},"types/metadata/election.ts:40")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"multiple_choice"},"MULTIPLE","_","CHOICE"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"MULTIPLE","_","CHOICE")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"multiple-choice"')),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L39"},"types/metadata/election.ts:39")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"single_choice_multiquestion"},"SINGLE","_","CHOICE","_","MULTIQUESTION"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SINGLE","_","CHOICE","_","MULTIQUESTION")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"single-choice-multiquestion"')),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L38"},"types/metadata/election.ts:38")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9728e091.c0cb931b.js b/assets/js/9728e091.c0cb931b.js new file mode 100644 index 000000000..675fdfa64 --- /dev/null +++ b/assets/js/9728e091.c0cb931b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5470],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>f});var r=n(67294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var c=r.createContext({}),l=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=l(e.components);return r.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},p=r.forwardRef((function(e,t){var n=e.components,s=e.mdxType,a=e.originalType,c=e.parentName,u=o(e,["components","mdxType","originalType","parentName"]),p=l(n),f=s,h=p["".concat(c,".").concat(f)]||p[f]||d[f]||a;return n?r.createElement(h,i(i({ref:t},u),{},{components:n})):r.createElement(h,i({ref:t},u))}));function f(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var a=n.length,i=new Array(a);i[0]=p;var o={};for(var c in t)hasOwnProperty.call(t,c)&&(o[c]=t[c]);o.originalType=e,o.mdxType="string"==typeof e?e:s,i[1]=o;for(var l=2;l{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var r=n(87462),s=(n(67294),n(3905));const a={},i="Off-chain Merkle Tree",o={unversionedId:"sdk/integration-details/census-types/off-chain-tree",id:"sdk/integration-details/census-types/off-chain-tree",title:"Off-chain Merkle Tree",description:"This is the most basic census type, is the default when creating an election, and is the one used in the SDK tutorial. In this scheme, the census is essentially a basic list of voter, with some behind-the-scenes cryptography. With an off-train tree census, voters are added as wallet addresses using census.add().",source:"@site/docs/sdk/integration-details/census-types/off-chain-tree.md",sourceDirName:"sdk/integration-details/census-types",slug:"/sdk/integration-details/census-types/off-chain-tree",permalink:"/sdk/integration-details/census-types/off-chain-tree",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Off-chain Credential Service Provider",permalink:"/sdk/integration-details/census-types/off-chain-csp"},next:{title:"On-chain Token-Based Census",permalink:"/sdk/integration-details/census-types/on-chain/"}},c={},l=[{value:"Anonymity",id:"anonymity",level:2}],u={toc:l};function d(e){let{components:t,...n}=e;return(0,s.kt)("wrapper",(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("h1",{id:"off-chain-merkle-tree"},"Off-chain Merkle Tree"),(0,s.kt)("p",null,"This is the most basic census type, is the default when creating an election, and is the one used in the SDK tutorial. In this scheme, the census is essentially a basic list of voter, with some behind-the-scenes cryptography. With an off-train tree census, voters are added as wallet addresses using ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PlainCensus#add"},(0,s.kt)("inlineCode",{parentName:"a"},"census.add()")),". "),(0,s.kt)("p",null,"This is the census type used in the ",(0,s.kt)("a",{parentName:"p",href:"/sdk/tutorial"},"SDK Tutorial"),". Follow along or look at the tutorial code for basic usage of the Merkle tree census."),(0,s.kt)("p",null,"Off-chain tree census can be created as ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PlainCensus"},(0,s.kt)("inlineCode",{parentName:"a"},"PlainCensus"))," or ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/WeightedCensus"},(0,s.kt)("inlineCode",{parentName:"a"},"WeightedCensus")),". If a weighted census is used, voters can be assigned a weight which proportionally determines the power of their vote: "),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js"},"weightedCensus.add([\n {\n key: address1,\n weight: BigInt(1),\n },\n {\n key: address2,\n // This voter will have 100x the vote power as voter1. This is not a very equitable election.\n weight: BigInt(100),\n },\n ]);\n")),(0,s.kt)("h2",{id:"anonymity"},"Anonymity"),(0,s.kt)("p",null,"Complete cryptographic anonymity is possible alongside universal verifiability with anonymous Merkle tree-based censuses. This is possible due to a cutting-edge technology called zk-SNARKs. The protocol-level design is detailed ",(0,s.kt)("a",{parentName:"p",href:"/protocol/anonymity/zk-census-proof"},"here"),"."),(0,s.kt)("p",null,"For an anonymous off-chain tree election, the election must be created with the option "),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-ts"},"electionType: {\n anonymous: true\n}\n")),(0,s.kt)("p",null,"In this case, votes must also be cast as ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/AnonymousVote"},(0,s.kt)("inlineCode",{parentName:"a"},"AnonymousVote")),"s. The cryptography needed for anonymous voting is very different from typical voting, but this is all handled by the SDK without any other changes needed."))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/999cbc12.0d09713f.js b/assets/js/999cbc12.0d09713f.js deleted file mode 100644 index fd48ea92a..000000000 --- a/assets/js/999cbc12.0d09713f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2600],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=r.createContext({}),p=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},s=function(e){var t=p(e.components);return r.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,c=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),f=p(n),u=i,k=f["".concat(c,".").concat(u)]||f[u]||d[u]||o;return n?r.createElement(k,a(a({ref:t},s),{},{components:n})):r.createElement(k,a({ref:t},s))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,a=new Array(o);a[0]=f;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l.mdxType="string"==typeof e?e:i,a[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var r=n(87462),i=(n(67294),n(3905));const o={},a=void 0,l={unversionedId:"sdk/reference/interfaces/IElectionVote",id:"sdk/reference/interfaces/IElectionVote",title:"IElectionVote",description:"@vocdoni/sdk / Exports / IElectionVote",source:"@site/docs/sdk/reference/interfaces/IElectionVote.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionVote",permalink:"/sdk/reference/interfaces/IElectionVote",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionType",permalink:"/sdk/reference/interfaces/IElectionType"},next:{title:"IElectionVoteListResponse",permalink:"/sdk/reference/interfaces/IElectionVoteListResponse"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"blockHeight",id:"blockheight",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"transactionIndex",id:"transactionindex",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"txHash",id:"txhash",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"voteID",id:"voteid",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"voterID",id:"voterid",level:3},{value:"Defined in",id:"defined-in-4",level:4}],s={toc:p};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IElectionVote"),(0,i.kt)("h1",{id:"interface-ielectionvote"},"Interface: IElectionVote"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionVote#blockheight"},"blockHeight")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionVote#transactionindex"},"transactionIndex")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionVote#txhash"},"txHash")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionVote#voteid"},"voteID")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionVote#voterid"},"voterID"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"blockheight"},"blockHeight"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"blockHeight"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Block containing the vote transaction"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L303"},"api/election.ts:303")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"transactionindex"},"transactionIndex"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"transactionIndex"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Transaction number on the block"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L308"},"api/election.ts:308")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"txhash"},"txHash"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"txHash"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Containing transaction hash"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L288"},"api/election.ts:288")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"voteid"},"voteID"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"voteID"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Vote unique identifier also known as vote nullifier"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L293"},"api/election.ts:293")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"voterid"},"voterID"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"voterID"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Account that emit the vote"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L298"},"api/election.ts:298")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/999cbc12.bed006ad.js b/assets/js/999cbc12.bed006ad.js new file mode 100644 index 000000000..af5a7b5d2 --- /dev/null +++ b/assets/js/999cbc12.bed006ad.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2600],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>f});var i=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function a(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=i.createContext({}),p=function(e){var t=i.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},s=function(e){var t=p(e.components);return i.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},u=i.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,c=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),u=p(n),f=r,k=u["".concat(c,".").concat(f)]||u[f]||d[f]||o;return n?i.createElement(k,a(a({ref:t},s),{},{components:n})):i.createElement(k,a({ref:t},s))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,a=new Array(o);a[0]=u;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l.mdxType="string"==typeof e?e:r,a[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var i=n(87462),r=(n(67294),n(3905));const o={},a=void 0,l={unversionedId:"sdk/reference/interfaces/IElectionVote",id:"sdk/reference/interfaces/IElectionVote",title:"IElectionVote",description:"@vocdoni/sdk / Exports / IElectionVote",source:"@site/docs/sdk/reference/interfaces/IElectionVote.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionVote",permalink:"/sdk/reference/interfaces/IElectionVote",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionType",permalink:"/sdk/reference/interfaces/IElectionType"},next:{title:"IElectionVoteListResponse",permalink:"/sdk/reference/interfaces/IElectionVoteListResponse"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"blockHeight",id:"blockheight",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"transactionIndex",id:"transactionindex",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"txHash",id:"txhash",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"voteID",id:"voteid",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"voterID",id:"voterid",level:3},{value:"Defined in",id:"defined-in-4",level:4}],s={toc:p};function d(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,i.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IElectionVote"),(0,r.kt)("h1",{id:"interface-ielectionvote"},"Interface: IElectionVote"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IElectionVote#blockheight"},"blockHeight")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IElectionVote#transactionindex"},"transactionIndex")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IElectionVote#txhash"},"txHash")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IElectionVote#voteid"},"voteID")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IElectionVote#voterid"},"voterID"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"blockheight"},"blockHeight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"blockHeight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Block containing the vote transaction"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L303"},"api/election.ts:303")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"transactionindex"},"transactionIndex"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"transactionIndex"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Transaction number on the block"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L308"},"api/election.ts:308")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"txhash"},"txHash"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"txHash"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Containing transaction hash"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L288"},"api/election.ts:288")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"voteid"},"voteID"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"voteID"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Vote unique identifier also known as vote nullifier"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L293"},"api/election.ts:293")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"voterid"},"voterID"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"voterID"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Account that emit the vote"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L298"},"api/election.ts:298")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9f384d53.46f015a8.js b/assets/js/9f384d53.46f015a8.js deleted file mode 100644 index 4d4e63ff7..000000000 --- a/assets/js/9f384d53.46f015a8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5058],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>u});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),d=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),f=d(n),u=a,k=f["".concat(p,".").concat(u)]||f[u]||s[u]||i;return n?r.createElement(k,o(o({ref:t},c),{},{components:n})):r.createElement(k,o({ref:t},c))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=f;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:a,o[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var r=n(87462),a=(n(67294),n(3905));const i={},o=void 0,l={unversionedId:"sdk/reference/interfaces/IChainValidator",id:"sdk/reference/interfaces/IChainValidator",title:"IChainValidator",description:"@vocdoni/sdk / Exports / IChainValidator",source:"@site/docs/sdk/reference/interfaces/IChainValidator.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainValidator",permalink:"/sdk/reference/interfaces/IChainValidator",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainTxReference",permalink:"/sdk/reference/interfaces/IChainTxReference"},next:{title:"IChainValidatorsListResponse",permalink:"/sdk/reference/interfaces/IChainValidatorsListResponse"}},p={},d=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"address",id:"address",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"power",id:"power",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"pubKey",id:"pubkey",level:3},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:d};function s(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IChainValidator"),(0,a.kt)("h1",{id:"interface-ichainvalidator"},"Interface: IChainValidator"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainValidator#address"},"address")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainValidator#name"},"name")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainValidator#power"},"power")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainValidator#pubkey"},"pubKey"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"address"},"address"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"address"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Validator address"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L339"},"api/chain.ts:339")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Validator name reference. Could be empty."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L344"},"api/chain.ts:344")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"power"},"power"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"power"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"Current power of the validator"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L329"},"api/chain.ts:329")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"pubkey"},"pubKey"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"pubKey"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Validator public key"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L334"},"api/chain.ts:334")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9f384d53.f592f0ac.js b/assets/js/9f384d53.f592f0ac.js new file mode 100644 index 000000000..640ed9726 --- /dev/null +++ b/assets/js/9f384d53.f592f0ac.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5058],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>f});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),d=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},s=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),u=d(n),f=a,k=u["".concat(p,".").concat(f)]||u[f]||c[f]||i;return n?r.createElement(k,o(o({ref:t},s),{},{components:n})):r.createElement(k,o({ref:t},s))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:a,o[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var r=n(87462),a=(n(67294),n(3905));const i={},o=void 0,l={unversionedId:"sdk/reference/interfaces/IChainValidator",id:"sdk/reference/interfaces/IChainValidator",title:"IChainValidator",description:"@vocdoni/sdk / Exports / IChainValidator",source:"@site/docs/sdk/reference/interfaces/IChainValidator.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainValidator",permalink:"/sdk/reference/interfaces/IChainValidator",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainTxReference",permalink:"/sdk/reference/interfaces/IChainTxReference"},next:{title:"IChainValidatorsListResponse",permalink:"/sdk/reference/interfaces/IChainValidatorsListResponse"}},p={},d=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"address",id:"address",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"power",id:"power",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"pubKey",id:"pubkey",level:3},{value:"Defined in",id:"defined-in-3",level:4}],s={toc:d};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IChainValidator"),(0,a.kt)("h1",{id:"interface-ichainvalidator"},"Interface: IChainValidator"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainValidator#address"},"address")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainValidator#name"},"name")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainValidator#power"},"power")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainValidator#pubkey"},"pubKey"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"address"},"address"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"address"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Validator address"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L339"},"api/chain.ts:339")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Validator name reference. Could be empty."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L344"},"api/chain.ts:344")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"power"},"power"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"power"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"Current power of the validator"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L329"},"api/chain.ts:329")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"pubkey"},"pubKey"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"pubKey"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Validator public key"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L334"},"api/chain.ts:334")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9f9eec24.3c8a7479.js b/assets/js/9f9eec24.c297719e.js similarity index 81% rename from assets/js/9f9eec24.3c8a7479.js rename to assets/js/9f9eec24.c297719e.js index cd01793c8..714340bfe 100644 --- a/assets/js/9f9eec24.3c8a7479.js +++ b/assets/js/9f9eec24.c297719e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1094],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>u});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),c=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),f=c(r),u=a,v=f["".concat(l,".").concat(u)]||f[u]||d[u]||i;return r?n.createElement(v,o(o({ref:t},p),{},{components:r})):n.createElement(v,o({ref:t},p))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=f;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var n=r(87462),a=(r(67294),r(3905));const i={},o=void 0,s={unversionedId:"sdk/reference/interfaces/IChainValidatorsListResponse",id:"sdk/reference/interfaces/IChainValidatorsListResponse",title:"IChainValidatorsListResponse",description:"@vocdoni/sdk / Exports / IChainValidatorsListResponse",source:"@site/docs/sdk/reference/interfaces/IChainValidatorsListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainValidatorsListResponse",permalink:"/sdk/reference/interfaces/IChainValidatorsListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainValidator",permalink:"/sdk/reference/interfaces/IChainValidator"},next:{title:"IChoice",permalink:"/sdk/reference/interfaces/IChoice"}},l={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"validators",id:"validators",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:c};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IChainValidatorsListResponse"),(0,a.kt)("h1",{id:"interface-ichainvalidatorslistresponse"},"Interface: IChainValidatorsListResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainValidatorsListResponse#validators"},"validators"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"validators"},"validators"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"validators"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainValidator"},(0,a.kt)("inlineCode",{parentName:"a"},"IChainValidator")),"[]"),(0,a.kt)("p",null,"The list of validators"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L351"},"api/chain.ts:351")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1094],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>u});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),c=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),f=c(r),u=a,v=f["".concat(l,".").concat(u)]||f[u]||d[u]||i;return r?n.createElement(v,o(o({ref:t},p),{},{components:r})):n.createElement(v,o({ref:t},p))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=f;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var n=r(87462),a=(r(67294),r(3905));const i={},o=void 0,s={unversionedId:"sdk/reference/interfaces/IChainValidatorsListResponse",id:"sdk/reference/interfaces/IChainValidatorsListResponse",title:"IChainValidatorsListResponse",description:"@vocdoni/sdk / Exports / IChainValidatorsListResponse",source:"@site/docs/sdk/reference/interfaces/IChainValidatorsListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainValidatorsListResponse",permalink:"/sdk/reference/interfaces/IChainValidatorsListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainValidator",permalink:"/sdk/reference/interfaces/IChainValidator"},next:{title:"IChoice",permalink:"/sdk/reference/interfaces/IChoice"}},l={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"validators",id:"validators",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:c};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IChainValidatorsListResponse"),(0,a.kt)("h1",{id:"interface-ichainvalidatorslistresponse"},"Interface: IChainValidatorsListResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainValidatorsListResponse#validators"},"validators"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"validators"},"validators"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"validators"),": ",(0,a.kt)("a",{parentName:"p",href:"IChainValidator"},(0,a.kt)("inlineCode",{parentName:"a"},"IChainValidator")),"[]"),(0,a.kt)("p",null,"The list of validators"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L351"},"api/chain.ts:351")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a217fb3c.4ca27e4b.js b/assets/js/a217fb3c.4ca27e4b.js deleted file mode 100644 index eb0450cfb..000000000 --- a/assets/js/a217fb3c.4ca27e4b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6386],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>o});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),p=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},u=function(e){var t=p(e.components);return a.createElement(d.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),c=p(n),o=r,m=c["".concat(d,".").concat(o)]||c[o]||k[o]||i;return n?a.createElement(m,s(s({ref:t},u),{},{components:n})):a.createElement(m,s({ref:t},u))}));function o(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,s=new Array(i);s[0]=c;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l.mdxType="string"==typeof e?e:r,s[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>s,default:()=>k,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var a=n(87462),r=(n(67294),n(3905));const i={},s=void 0,l={unversionedId:"sdk/reference/classes/WeightedCensus",id:"sdk/reference/classes/WeightedCensus",title:"WeightedCensus",description:"@vocdoni/sdk / Exports / WeightedCensus",source:"@site/docs/sdk/reference/classes/WeightedCensus.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/WeightedCensus",permalink:"/sdk/reference/classes/WeightedCensus",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"WalletAPI",permalink:"/sdk/reference/classes/WalletAPI"},next:{title:"CensusOrigin",permalink:"/sdk/reference/enums/CensusOrigin"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_censusId",id:"_censusid",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_censusURI",id:"_censusuri",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_type",id:"_type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"censusId",id:"censusid",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isPublished",id:"ispublished",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"participants",id:"participants",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"type",id:"type",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"weight",id:"weight",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Methods",id:"methods-1",level:2},{value:"add",id:"add",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"addParticipants",id:"addparticipants",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"checkParticipant",id:"checkparticipant",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"remove",id:"remove",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"removeParticipant",id:"removeparticipant",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"censusTypeFromCensusOrigin",id:"censustypefromcensusorigin",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-22",level:4}],u={toc:p};function k(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / WeightedCensus"),(0,r.kt)("h1",{id:"class-weightedcensus"},"Class: WeightedCensus"),(0,r.kt)("p",null,"Represents a weighted census"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"WeightedCensus"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#_censusid"},"_","censusId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#_censusuri"},"_","censusURI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#_type"},"_","type"))),(0,r.kt)("h3",{id:"accessors"},"Accessors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#censusid"},"censusId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#censusuri"},"censusURI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#ispublished"},"isPublished")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#participants"},"participants")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#size"},"size")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#type"},"type")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#weight"},"weight"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#add"},"add")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#addparticipants"},"addParticipants")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#checkparticipant"},"checkParticipant")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#remove"},"remove")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#removeparticipant"},"removeParticipant")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new WeightedCensus"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/WeightedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"WeightedCensus"))),(0,r.kt)("p",null,"Constructs a weighted census"),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/WeightedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"WeightedCensus"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#constructor"},"constructor")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/weighted.ts#L10"},"types/census/weighted.ts:10")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"_censusid"},"_","censusId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","censusId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#_censusid"},"_censusId")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L12"},"types/census/census.ts:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_censusuri"},"_","censusURI"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","censusURI"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#_censusuri"},"_censusURI")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L13"},"types/census/census.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_type"},"_","type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","type"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#_type"},"_type")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L14"},"types/census/census.ts:14")),(0,r.kt)("h2",{id:"accessors-1"},"Accessors"),(0,r.kt)("h3",{id:"censusid"},"censusId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"censusId"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.censusId"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L35"},"types/census/census.ts:35")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"censusId"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.censusId"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L39"},"types/census/census.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censusuri"},"censusURI"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"censusURI"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.censusURI"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L43"},"types/census/census.ts:43")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"censusURI"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.censusURI"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L47"},"types/census/census.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ispublished"},"isPublished"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"isPublished"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.isPublished"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L75"},"types/census/census.ts:75")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"participants"},"participants"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"participants"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]"),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]"),(0,r.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.participants"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L45"},"types/census/offchain.ts:45")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"participants"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.participants"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L49"},"types/census/offchain.ts:49")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"size"},"size"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"size"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.size"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L59"},"types/census/census.ts:59")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"size"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.size"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L63"},"types/census/census.ts:63")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"type"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.type"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L51"},"types/census/census.ts:51")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"type"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType")))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.type"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L55"},"types/census/census.ts:55")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"weight"},"weight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"weight"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"bigint")),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"bigint")),(0,r.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.weight"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L67"},"types/census/census.ts:67")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"weight"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.weight"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L71"},"types/census/census.ts:71")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"add"},"add"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"add"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participants")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/weighted.ts#L14"},"types/census/weighted.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"addparticipants"},"addParticipants"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addParticipants"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participants")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#addparticipants"},"addParticipants")),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L25"},"types/census/offchain.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"checkparticipant"},"checkParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"participant"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participant")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")))))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))),(0,r.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#checkparticipant"},"checkParticipant")),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L35"},"types/census/offchain.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"remove"},"remove"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"remove"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/weighted.ts#L18"},"types/census/weighted.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removeparticipant"},"removeParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#removeparticipant"},"removeParticipant")),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L41"},"types/census/offchain.ts:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censustypefromcensusorigin"},"censusTypeFromCensusOrigin"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"censusTypeFromCensusOrigin"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusOrigin"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusOrigin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin")),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L81"},"types/census/census.ts:81")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a217fb3c.5ed525a5.js b/assets/js/a217fb3c.5ed525a5.js new file mode 100644 index 000000000..878c8b4dd --- /dev/null +++ b/assets/js/a217fb3c.5ed525a5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6386],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),p=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},u=function(e){var t=p(e.components);return a.createElement(d.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},o=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),o=p(n),m=r,c=o["".concat(d,".").concat(m)]||o[m]||k[m]||i;return n?a.createElement(c,s(s({ref:t},u),{},{components:n})):a.createElement(c,s({ref:t},u))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,s=new Array(i);s[0]=o;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l.mdxType="string"==typeof e?e:r,s[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>s,default:()=>k,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var a=n(87462),r=(n(67294),n(3905));const i={},s=void 0,l={unversionedId:"sdk/reference/classes/WeightedCensus",id:"sdk/reference/classes/WeightedCensus",title:"WeightedCensus",description:"@vocdoni/sdk / Exports / WeightedCensus",source:"@site/docs/sdk/reference/classes/WeightedCensus.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/WeightedCensus",permalink:"/sdk/reference/classes/WeightedCensus",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"WalletAPI",permalink:"/sdk/reference/classes/WalletAPI"},next:{title:"CensusOrigin",permalink:"/sdk/reference/enums/CensusOrigin"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_censusId",id:"_censusid",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_censusURI",id:"_censusuri",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_type",id:"_type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"censusId",id:"censusid",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isPublished",id:"ispublished",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"participants",id:"participants",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"type",id:"type",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"weight",id:"weight",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Methods",id:"methods-1",level:2},{value:"add",id:"add",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"addParticipants",id:"addparticipants",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"checkParticipant",id:"checkparticipant",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"remove",id:"remove",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"removeParticipant",id:"removeparticipant",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"censusTypeFromCensusOrigin",id:"censustypefromcensusorigin",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-22",level:4}],u={toc:p};function k(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / WeightedCensus"),(0,r.kt)("h1",{id:"class-weightedcensus"},"Class: WeightedCensus"),(0,r.kt)("p",null,"Represents a weighted census"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"OffchainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"WeightedCensus"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"WeightedCensus#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#_censusid"},"_","censusId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#_censusuri"},"_","censusURI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WeightedCensus#_type"},"_","type"))),(0,r.kt)("h3",{id:"accessors"},"Accessors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"WeightedCensus#censusid"},"censusId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"WeightedCensus#censusuri"},"censusURI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"WeightedCensus#ispublished"},"isPublished")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"WeightedCensus#participants"},"participants")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"WeightedCensus#size"},"size")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"WeightedCensus#type"},"type")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"WeightedCensus#weight"},"weight"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"WeightedCensus#add"},"add")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"WeightedCensus#addparticipants"},"addParticipants")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"WeightedCensus#checkparticipant"},"checkParticipant")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"WeightedCensus#remove"},"remove")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"WeightedCensus#removeparticipant"},"removeParticipant")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"WeightedCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new WeightedCensus"),"(): ",(0,r.kt)("a",{parentName:"p",href:"WeightedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"WeightedCensus"))),(0,r.kt)("p",null,"Constructs a weighted census"),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"WeightedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"WeightedCensus"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"OffchainCensus#constructor"},"constructor")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/weighted.ts#L10"},"types/census/weighted.ts:10")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"_censusid"},"_","censusId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","censusId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#_censusid"},"_censusId")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L12"},"types/census/census.ts:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_censusuri"},"_","censusURI"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","censusURI"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#_censusuri"},"_censusURI")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L13"},"types/census/census.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_type"},"_","type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","type"),": ",(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#_type"},"_type")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L14"},"types/census/census.ts:14")),(0,r.kt)("h2",{id:"accessors-1"},"Accessors"),(0,r.kt)("h3",{id:"censusid"},"censusId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"censusId"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.censusId"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L35"},"types/census/census.ts:35")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"censusId"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.censusId"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L39"},"types/census/census.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censusuri"},"censusURI"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"censusURI"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.censusURI"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L43"},"types/census/census.ts:43")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"censusURI"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.censusURI"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L47"},"types/census/census.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ispublished"},"isPublished"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"isPublished"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.isPublished"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L75"},"types/census/census.ts:75")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"participants"},"participants"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"participants"),"(): ",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]"),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]"),(0,r.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.participants"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L45"},"types/census/offchain.ts:45")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"participants"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.participants"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L49"},"types/census/offchain.ts:49")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"size"},"size"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"size"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.size"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L59"},"types/census/census.ts:59")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"size"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.size"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L63"},"types/census/census.ts:63")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"type"),"(): ",(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.type"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L51"},"types/census/census.ts:51")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"type"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType")))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.type"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L55"},"types/census/census.ts:55")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"weight"},"weight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"weight"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"bigint")),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"bigint")),(0,r.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.weight"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L67"},"types/census/census.ts:67")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"weight"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.weight"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L71"},"types/census/census.ts:71")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"add"},"add"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"add"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participants")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/weighted.ts#L14"},"types/census/weighted.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"addparticipants"},"addParticipants"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addParticipants"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participants")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"OffchainCensus#addparticipants"},"addParticipants")),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L25"},"types/census/offchain.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"checkparticipant"},"checkParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"participant"),"): ",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participant")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")))))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))),(0,r.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"OffchainCensus#checkparticipant"},"checkParticipant")),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L35"},"types/census/offchain.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"remove"},"remove"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"remove"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/weighted.ts#L18"},"types/census/weighted.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removeparticipant"},"removeParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"OffchainCensus#removeparticipant"},"removeParticipant")),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L41"},"types/census/offchain.ts:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censustypefromcensusorigin"},"censusTypeFromCensusOrigin"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"censusTypeFromCensusOrigin"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusOrigin"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusOrigin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"OffchainCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin")),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L81"},"types/census/census.ts:81")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a2cbb706.0acbcf3f.js b/assets/js/a2cbb706.0acbcf3f.js new file mode 100644 index 000000000..12c37180c --- /dev/null +++ b/assets/js/a2cbb706.0acbcf3f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1966],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=a.createContext({}),p=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),m=p(n),k=r,h=m["".concat(s,".").concat(k)]||m[k]||c[k]||i;return n?a.createElement(h,l(l({ref:t},d),{},{components:n})):a.createElement(h,l({ref:t},d))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:r,l[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,o={unversionedId:"sdk/reference/classes/ChainService",id:"sdk/reference/classes/ChainService",title:"ChainService",description:"@vocdoni/sdk / Exports / ChainService",source:"@site/docs/sdk/reference/classes/ChainService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/ChainService",permalink:"/sdk/reference/classes/ChainService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ChainAPI",permalink:"/sdk/reference/classes/ChainAPI"},next:{title:"CspCensus",permalink:"/sdk/reference/classes/CspCensus"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"chainCosts",id:"chaincosts",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"chainData",id:"chaindata",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"txWait",id:"txwait",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Methods",id:"methods-1",level:2},{value:"dateToBlock",id:"datetoblock",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"fetchChainCosts",id:"fetchchaincosts",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetchChainData",id:"fetchchaindata",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"submitTx",id:"submittx",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"txInfo",id:"txinfo",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"waitForTransaction",id:"waitfortransaction",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-10",level:4}],d={toc:p};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ChainService"),(0,r.kt)("h1",{id:"class-chainservice"},"Class: ChainService"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"Service"},(0,r.kt)("inlineCode",{parentName:"a"},"Service"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"ChainService"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"ChainServiceProperties"))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainService#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainService#chaincosts"},"chainCosts")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainService#chaindata"},"chainData")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainService#txwait"},"txWait")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainService#url"},"url"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainService#datetoblock"},"dateToBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainService#fetchchaincosts"},"fetchChainCosts")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainService#fetchchaindata"},"fetchChainData")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainService#submittx"},"submitTx")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainService#txinfo"},"txInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainService#waitfortransaction"},"waitForTransaction"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new ChainService"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,r.kt)("a",{parentName:"p",href:"ChainService"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainService"))),(0,r.kt)("p",null,"Instantiate the chain service."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"ChainServiceParameters"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"ChainService"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainService"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,r.kt)("a",{parentName:"p",href:"Service#constructor"},"constructor")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/chain.ts#L47"},"services/chain.ts:47")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"chaincosts"},"chainCosts"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"chainCosts"),": ",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainGetCostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCostsResponse"))),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,"ChainServiceProperties.chainCosts"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/chain.ts#L38"},"services/chain.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"chaindata"},"chainData"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"chainData"),": ",(0,r.kt)("a",{parentName:"p",href:"../modules#chaindata"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainData"))),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,"ChainServiceProperties.chainData"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/chain.ts#L39"},"services/chain.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"txwait"},"txWait"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"txWait"),": ",(0,r.kt)("a",{parentName:"p",href:"../modules#txwaitoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"TxWaitOptions"))),(0,r.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,r.kt)("p",null,"ChainServiceProperties.txWait"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/chain.ts#L40"},"services/chain.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"url"},"url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,r.kt)("a",{parentName:"p",href:"Service#url"},"url")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/service.ts#L6"},"services/service.ts:6")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"datetoblock"},"dateToBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dateToBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"date"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"Returns the block number for a given date."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"date")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Date")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The date which we want to retrieve the block number from")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"The block number"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/chain.ts#L114"},"services/chain.ts:114")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchchaincosts"},"fetchChainCosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchChainCosts"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainGetCostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCostsResponse")),">"),(0,r.kt)("p",null,"Fetches blockchain costs information if needed."),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainGetCostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCostsResponse")),">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/chain.ts#L74"},"services/chain.ts:74")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchchaindata"},"fetchChainData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchChainData"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#chaindata"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainData")),">"),(0,r.kt)("p",null,"Fetches blockchain information if needed."),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#chaindata"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainData")),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/chain.ts#L57"},"services/chain.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"submittx"},"submitTx"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"submitTx"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Submits a transaction to the blockchain"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The transaction data payload")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The transaction hash"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/chain.ts#L92"},"services/chain.ts:92")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"txinfo"},"txInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"txInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"txHash"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainTxReference"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainTxReference")),">"),(0,r.kt)("p",null,"Fetches information about a transaction from the blockchain."),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"txHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The transaction hash which we want to retrieve the info from")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainTxReference"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainTxReference")),">"),(0,r.kt)("p",null,"The chain transaction"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/chain.ts#L103"},"services/chain.ts:103")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"waitfortransaction"},"waitForTransaction"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"waitForTransaction"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"tx"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"wait?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"attempts?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"A convenience method to wait for a transaction to be executed. It will\nloop trying to get the transaction information, and will retry every time\nit fails."),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Transaction to wait for")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wait?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The delay in milliseconds between tries")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"attempts?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The attempts to try before failing")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/chain.ts#L129"},"services/chain.ts:129")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a2cbb706.3ef27a35.js b/assets/js/a2cbb706.3ef27a35.js deleted file mode 100644 index 943941869..000000000 --- a/assets/js/a2cbb706.3ef27a35.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1966],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),d=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=d(e.components);return a.createElement(o.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),k=d(n),m=r,h=k["".concat(o,".").concat(m)]||k[m]||c[m]||i;return n?a.createElement(h,l(l({ref:t},p),{},{components:n})):a.createElement(h,l({ref:t},p))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=k;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s.mdxType="string"==typeof e?e:r,l[1]=s;for(var d=2;d{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,s={unversionedId:"sdk/reference/classes/ChainService",id:"sdk/reference/classes/ChainService",title:"ChainService",description:"@vocdoni/sdk / Exports / ChainService",source:"@site/docs/sdk/reference/classes/ChainService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/ChainService",permalink:"/sdk/reference/classes/ChainService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ChainAPI",permalink:"/sdk/reference/classes/ChainAPI"},next:{title:"CspCensus",permalink:"/sdk/reference/classes/CspCensus"}},o={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"chainCosts",id:"chaincosts",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"chainData",id:"chaindata",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"txWait",id:"txwait",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Methods",id:"methods-1",level:2},{value:"dateToBlock",id:"datetoblock",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"fetchChainCosts",id:"fetchchaincosts",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetchChainData",id:"fetchchaindata",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"submitTx",id:"submittx",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"txInfo",id:"txinfo",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"waitForTransaction",id:"waitfortransaction",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-10",level:4}],p={toc:d};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ChainService"),(0,r.kt)("h1",{id:"class-chainservice"},"Class: ChainService"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},(0,r.kt)("inlineCode",{parentName:"a"},"Service"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"ChainService"))))),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"ChainServiceProperties"))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainService#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainService#chaincosts"},"chainCosts")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainService#chaindata"},"chainData")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainService#txwait"},"txWait")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainService#url"},"url"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainService#datetoblock"},"dateToBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainService#fetchchaincosts"},"fetchChainCosts")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainService#fetchchaindata"},"fetchChainData")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainService#submittx"},"submitTx")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainService#txinfo"},"txInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainService#waitfortransaction"},"waitForTransaction"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new ChainService"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ChainService"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainService"))),(0,r.kt)("p",null,"Instantiate the chain service."),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"ChainServiceParameters"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ChainService"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainService"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#constructor"},"constructor")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/chain.ts#L47"},"services/chain.ts:47")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"chaincosts"},"chainCosts"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"chainCosts"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainGetCostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCostsResponse"))),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,"ChainServiceProperties.chainCosts"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/chain.ts#L38"},"services/chain.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"chaindata"},"chainData"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"chainData"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#chaindata"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainData"))),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,"ChainServiceProperties.chainData"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/chain.ts#L39"},"services/chain.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"txwait"},"txWait"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"txWait"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#txwaitoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"TxWaitOptions"))),(0,r.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,r.kt)("p",null,"ChainServiceProperties.txWait"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/chain.ts#L40"},"services/chain.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"url"},"url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#url"},"url")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/service.ts#L6"},"services/service.ts:6")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"datetoblock"},"dateToBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dateToBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"date"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"Returns the block number for a given date."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"date")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Date")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The date which we want to retrieve the block number from")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"The block number"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/chain.ts#L114"},"services/chain.ts:114")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchchaincosts"},"fetchChainCosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchChainCosts"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainGetCostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCostsResponse")),">"),(0,r.kt)("p",null,"Fetches blockchain costs information if needed."),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainGetCostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCostsResponse")),">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/chain.ts#L74"},"services/chain.ts:74")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchchaindata"},"fetchChainData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchChainData"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#chaindata"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainData")),">"),(0,r.kt)("p",null,"Fetches blockchain information if needed."),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#chaindata"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainData")),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/chain.ts#L57"},"services/chain.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"submittx"},"submitTx"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"submitTx"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Submits a transaction to the blockchain"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The transaction data payload")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The transaction hash"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/chain.ts#L92"},"services/chain.ts:92")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"txinfo"},"txInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"txInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"txHash"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainTxReference"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainTxReference")),">"),(0,r.kt)("p",null,"Fetches information about a transaction from the blockchain."),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"txHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The transaction hash which we want to retrieve the info from")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainTxReference"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainTxReference")),">"),(0,r.kt)("p",null,"The chain transaction"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/chain.ts#L103"},"services/chain.ts:103")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"waitfortransaction"},"waitForTransaction"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"waitForTransaction"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"tx"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"wait?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"attempts?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"A convenience method to wait for a transaction to be executed. It will\nloop trying to get the transaction information, and will retry every time\nit fails."),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Transaction to wait for")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wait?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The delay in milliseconds between tries")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"attempts?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The attempts to try before failing")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/chain.ts#L129"},"services/chain.ts:129")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a674c74b.5afdb9d0.js b/assets/js/a674c74b.5afdb9d0.js new file mode 100644 index 000000000..3e93fbc92 --- /dev/null +++ b/assets/js/a674c74b.5afdb9d0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6412],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),d=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},u=function(e){var t=d(e.components);return a.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},o=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),o=d(n),m=r,c=o["".concat(p,".").concat(m)]||o[m]||k[m]||i;return n?a.createElement(c,s(s({ref:t},u),{},{components:n})):a.createElement(c,s({ref:t},u))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,s=new Array(i);s[0]=o;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:r,s[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>k,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var a=n(87462),r=(n(67294),n(3905));const i={},s=void 0,l={unversionedId:"sdk/reference/classes/PlainCensus",id:"sdk/reference/classes/PlainCensus",title:"PlainCensus",description:"@vocdoni/sdk / Exports / PlainCensus",source:"@site/docs/sdk/reference/classes/PlainCensus.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/PlainCensus",permalink:"/sdk/reference/classes/PlainCensus",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"OffchainCensus",permalink:"/sdk/reference/classes/OffchainCensus"},next:{title:"PublishedCensus",permalink:"/sdk/reference/classes/PublishedCensus"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_censusId",id:"_censusid",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_censusURI",id:"_censusuri",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_type",id:"_type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"censusId",id:"censusid",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isPublished",id:"ispublished",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"participants",id:"participants",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"type",id:"type",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"weight",id:"weight",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Methods",id:"methods-1",level:2},{value:"add",id:"add",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"addParticipants",id:"addparticipants",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"checkParticipant",id:"checkparticipant",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"remove",id:"remove",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"removeParticipant",id:"removeparticipant",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"censusTypeFromCensusOrigin",id:"censustypefromcensusorigin",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-22",level:4}],u={toc:d};function k(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / PlainCensus"),(0,r.kt)("h1",{id:"class-plaincensus"},"Class: PlainCensus"),(0,r.kt)("p",null,"Represents a plain census"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"OffchainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"PlainCensus"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"PlainCensus#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#_censusid"},"_","censusId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#_censusuri"},"_","censusURI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#_type"},"_","type"))),(0,r.kt)("h3",{id:"accessors"},"Accessors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"PlainCensus#censusid"},"censusId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"PlainCensus#censusuri"},"censusURI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"PlainCensus#ispublished"},"isPublished")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"PlainCensus#participants"},"participants")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"PlainCensus#size"},"size")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"PlainCensus#type"},"type")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"PlainCensus#weight"},"weight"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"PlainCensus#add"},"add")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"PlainCensus#addparticipants"},"addParticipants")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"PlainCensus#checkparticipant"},"checkParticipant")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"PlainCensus#remove"},"remove")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"PlainCensus#removeparticipant"},"removeParticipant")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"PlainCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new PlainCensus"),"(): ",(0,r.kt)("a",{parentName:"p",href:"PlainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PlainCensus"))),(0,r.kt)("p",null,"Constructs a plain census"),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"PlainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PlainCensus"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"OffchainCensus#constructor"},"constructor")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/plain.ts#L10"},"types/census/plain.ts:10")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"_censusid"},"_","censusId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","censusId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#_censusid"},"_censusId")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L12"},"types/census/census.ts:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_censusuri"},"_","censusURI"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","censusURI"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#_censusuri"},"_censusURI")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L13"},"types/census/census.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_type"},"_","type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","type"),": ",(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#_type"},"_type")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L14"},"types/census/census.ts:14")),(0,r.kt)("h2",{id:"accessors-1"},"Accessors"),(0,r.kt)("h3",{id:"censusid"},"censusId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"censusId"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.censusId"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L35"},"types/census/census.ts:35")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"censusId"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.censusId"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L39"},"types/census/census.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censusuri"},"censusURI"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"censusURI"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.censusURI"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L43"},"types/census/census.ts:43")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"censusURI"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.censusURI"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L47"},"types/census/census.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ispublished"},"isPublished"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"isPublished"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.isPublished"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L75"},"types/census/census.ts:75")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"participants"},"participants"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"participants"),"(): ",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]"),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]"),(0,r.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.participants"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L45"},"types/census/offchain.ts:45")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"participants"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.participants"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L49"},"types/census/offchain.ts:49")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"size"},"size"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"size"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.size"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L59"},"types/census/census.ts:59")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"size"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.size"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L63"},"types/census/census.ts:63")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"type"),"(): ",(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.type"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L51"},"types/census/census.ts:51")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"type"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType")))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.type"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L55"},"types/census/census.ts:55")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"weight"},"weight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"weight"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"bigint")),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"bigint")),(0,r.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.weight"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L67"},"types/census/census.ts:67")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"weight"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.weight"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L71"},"types/census/census.ts:71")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"add"},"add"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"add"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participants")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/plain.ts#L14"},"types/census/plain.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"addparticipants"},"addParticipants"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addParticipants"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participants")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"OffchainCensus#addparticipants"},"addParticipants")),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L25"},"types/census/offchain.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"checkparticipant"},"checkParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"participant"),"): ",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participant")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")))))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))),(0,r.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"OffchainCensus#checkparticipant"},"checkParticipant")),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L35"},"types/census/offchain.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"remove"},"remove"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"remove"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/plain.ts#L30"},"types/census/plain.ts:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removeparticipant"},"removeParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"OffchainCensus#removeparticipant"},"removeParticipant")),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L41"},"types/census/offchain.ts:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censustypefromcensusorigin"},"censusTypeFromCensusOrigin"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"censusTypeFromCensusOrigin"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusOrigin"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusOrigin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"OffchainCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin")),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L81"},"types/census/census.ts:81")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a674c74b.e6fef682.js b/assets/js/a674c74b.e6fef682.js deleted file mode 100644 index fabf7dd6f..000000000 --- a/assets/js/a674c74b.e6fef682.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6412],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>o});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),p=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},u=function(e){var t=p(e.components);return a.createElement(d.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),c=p(n),o=r,m=c["".concat(d,".").concat(o)]||c[o]||k[o]||i;return n?a.createElement(m,s(s({ref:t},u),{},{components:n})):a.createElement(m,s({ref:t},u))}));function o(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,s=new Array(i);s[0]=c;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l.mdxType="string"==typeof e?e:r,s[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>s,default:()=>k,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var a=n(87462),r=(n(67294),n(3905));const i={},s=void 0,l={unversionedId:"sdk/reference/classes/PlainCensus",id:"sdk/reference/classes/PlainCensus",title:"PlainCensus",description:"@vocdoni/sdk / Exports / PlainCensus",source:"@site/docs/sdk/reference/classes/PlainCensus.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/PlainCensus",permalink:"/sdk/reference/classes/PlainCensus",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"OffchainCensus",permalink:"/sdk/reference/classes/OffchainCensus"},next:{title:"PublishedCensus",permalink:"/sdk/reference/classes/PublishedCensus"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_censusId",id:"_censusid",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_censusURI",id:"_censusuri",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_type",id:"_type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"censusId",id:"censusid",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isPublished",id:"ispublished",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"participants",id:"participants",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"type",id:"type",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"weight",id:"weight",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Methods",id:"methods-1",level:2},{value:"add",id:"add",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"addParticipants",id:"addparticipants",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"checkParticipant",id:"checkparticipant",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"remove",id:"remove",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"removeParticipant",id:"removeparticipant",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"censusTypeFromCensusOrigin",id:"censustypefromcensusorigin",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-22",level:4}],u={toc:p};function k(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / PlainCensus"),(0,r.kt)("h1",{id:"class-plaincensus"},"Class: PlainCensus"),(0,r.kt)("p",null,"Represents a plain census"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"PlainCensus"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#_censusid"},"_","censusId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#_censusuri"},"_","censusURI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#_type"},"_","type"))),(0,r.kt)("h3",{id:"accessors"},"Accessors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#censusid"},"censusId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#censusuri"},"censusURI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#ispublished"},"isPublished")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#participants"},"participants")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#size"},"size")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#type"},"type")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#weight"},"weight"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#add"},"add")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#addparticipants"},"addParticipants")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#checkparticipant"},"checkParticipant")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#remove"},"remove")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#removeparticipant"},"removeParticipant")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PlainCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new PlainCensus"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PlainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PlainCensus"))),(0,r.kt)("p",null,"Constructs a plain census"),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PlainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PlainCensus"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#constructor"},"constructor")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/plain.ts#L10"},"types/census/plain.ts:10")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"_censusid"},"_","censusId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","censusId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#_censusid"},"_censusId")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L12"},"types/census/census.ts:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_censusuri"},"_","censusURI"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","censusURI"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#_censusuri"},"_censusURI")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L13"},"types/census/census.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_type"},"_","type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","type"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#_type"},"_type")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L14"},"types/census/census.ts:14")),(0,r.kt)("h2",{id:"accessors-1"},"Accessors"),(0,r.kt)("h3",{id:"censusid"},"censusId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"censusId"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.censusId"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L35"},"types/census/census.ts:35")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"censusId"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.censusId"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L39"},"types/census/census.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censusuri"},"censusURI"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"censusURI"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.censusURI"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L43"},"types/census/census.ts:43")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"censusURI"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.censusURI"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L47"},"types/census/census.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ispublished"},"isPublished"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"isPublished"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.isPublished"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L75"},"types/census/census.ts:75")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"participants"},"participants"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"participants"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]"),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]"),(0,r.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.participants"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L45"},"types/census/offchain.ts:45")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"participants"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.participants"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L49"},"types/census/offchain.ts:49")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"size"},"size"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"size"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.size"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L59"},"types/census/census.ts:59")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"size"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.size"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L63"},"types/census/census.ts:63")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"type"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.type"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L51"},"types/census/census.ts:51")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"type"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType")))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.type"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L55"},"types/census/census.ts:55")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"weight"},"weight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"weight"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"bigint")),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"bigint")),(0,r.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.weight"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L67"},"types/census/census.ts:67")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"weight"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,r.kt)("p",null,"OffchainCensus.weight"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L71"},"types/census/census.ts:71")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"add"},"add"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"add"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participants")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/plain.ts#L14"},"types/census/plain.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"addparticipants"},"addParticipants"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addParticipants"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participants")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#addparticipants"},"addParticipants")),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L25"},"types/census/offchain.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"checkparticipant"},"checkParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"participant"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participant")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")))))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))),(0,r.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#checkparticipant"},"checkParticipant")),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L35"},"types/census/offchain.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"remove"},"remove"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"remove"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/plain.ts#L30"},"types/census/plain.ts:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removeparticipant"},"removeParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#removeparticipant"},"removeParticipant")),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L41"},"types/census/offchain.ts:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censustypefromcensusorigin"},"censusTypeFromCensusOrigin"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"censusTypeFromCensusOrigin"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusOrigin"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusOrigin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},"OffchainCensus"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin")),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L81"},"types/census/census.ts:81")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a7835d3e.b1d09002.js b/assets/js/a7835d3e.b1d09002.js deleted file mode 100644 index bf85f1f7a..000000000 --- a/assets/js/a7835d3e.b1d09002.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6723],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),k=p(n),m=a,c=k["".concat(s,".").concat(m)]||k[m]||u[m]||i;return n?r.createElement(c,o(o({ref:t},d),{},{components:n})):r.createElement(c,o({ref:t},d))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=k;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:a,o[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const i={},o=void 0,l={unversionedId:"sdk/reference/classes/AnonymousVote",id:"sdk/reference/classes/AnonymousVote",title:"AnonymousVote",description:"@vocdoni/sdk / Exports / AnonymousVote",source:"@site/docs/sdk/reference/classes/AnonymousVote.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/AnonymousVote",permalink:"/sdk/reference/classes/AnonymousVote",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"AnonymousService",permalink:"/sdk/reference/classes/AnonymousService"},next:{title:"ApprovalElection",permalink:"/sdk/reference/classes/ApprovalElection"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_password",id:"_password",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"_signature",id:"_signature",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"password",id:"password",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"signature",id:"signature",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"votes",id:"votes",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-8",level:4}],d={toc:p};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / AnonymousVote"),(0,a.kt)("h1",{id:"class-anonymousvote"},"Class: AnonymousVote"),(0,a.kt)("p",null,"Represents a vote"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"AnonymousVote"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousVote#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousVote#_password"},"_","password")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousVote#_signature"},"_","signature"))),(0,a.kt)("h3",{id:"accessors"},"Accessors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousVote#password"},"password")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousVote#signature"},"signature")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousVote#votes"},"votes"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new AnonymousVote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"votes"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"signature?"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"password?"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/AnonymousVote"},(0,a.kt)("inlineCode",{parentName:"a"},"AnonymousVote"))),(0,a.kt)("p",null,"Constructs a csp vote"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"votes")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(",(0,a.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"bigint"),")[]"),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"undefined")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The list of votes values")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"signature?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"undefined")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The signature of the payload")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"password")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"'0'")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The password of the anonymous vote")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/AnonymousVote"},(0,a.kt)("inlineCode",{parentName:"a"},"AnonymousVote"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Vote"},"Vote"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Vote#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/anonymous.ts#L14"},"types/vote/anonymous.ts:14")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"_password"},"_","password"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","password"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/anonymous.ts#L4"},"types/vote/anonymous.ts:4")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_signature"},"_","signature"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","signature"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/anonymous.ts#L5"},"types/vote/anonymous.ts:5")),(0,a.kt)("h2",{id:"accessors-1"},"Accessors"),(0,a.kt)("h3",{id:"password"},"password"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"password"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/anonymous.ts#L20"},"types/vote/anonymous.ts:20")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"password"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/anonymous.ts#L24"},"types/vote/anonymous.ts:24")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"signature"},"signature"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"signature"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/anonymous.ts#L28"},"types/vote/anonymous.ts:28")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"signature"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/anonymous.ts#L32"},"types/vote/anonymous.ts:32")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votes"},"votes"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"votes"),"(): (",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint"),")[]"),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,"(",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint"),")[]"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Vote.votes"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/vote.ts#L16"},"types/vote/vote.ts:16")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"votes"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(",(0,a.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"bigint"),")[]")))),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Vote.votes"),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/vote.ts#L20"},"types/vote/vote.ts:20")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a7835d3e.d49d700c.js b/assets/js/a7835d3e.d49d700c.js new file mode 100644 index 000000000..56b033654 --- /dev/null +++ b/assets/js/a7835d3e.d49d700c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6723],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=p(n),k=a,c=m["".concat(s,".").concat(k)]||m[k]||u[k]||i;return n?r.createElement(c,o(o({ref:t},d),{},{components:n})):r.createElement(c,o({ref:t},d))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:a,o[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const i={},o=void 0,l={unversionedId:"sdk/reference/classes/AnonymousVote",id:"sdk/reference/classes/AnonymousVote",title:"AnonymousVote",description:"@vocdoni/sdk / Exports / AnonymousVote",source:"@site/docs/sdk/reference/classes/AnonymousVote.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/AnonymousVote",permalink:"/sdk/reference/classes/AnonymousVote",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"AnonymousService",permalink:"/sdk/reference/classes/AnonymousService"},next:{title:"ApprovalElection",permalink:"/sdk/reference/classes/ApprovalElection"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_password",id:"_password",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"_signature",id:"_signature",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"password",id:"password",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"signature",id:"signature",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"votes",id:"votes",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-8",level:4}],d={toc:p};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / AnonymousVote"),(0,a.kt)("h1",{id:"class-anonymousvote"},"Class: AnonymousVote"),(0,a.kt)("p",null,"Represents a vote"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"AnonymousVote"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"AnonymousVote#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousVote#_password"},"_","password")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/AnonymousVote#_signature"},"_","signature"))),(0,a.kt)("h3",{id:"accessors"},"Accessors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"AnonymousVote#password"},"password")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"AnonymousVote#signature"},"signature")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"AnonymousVote#votes"},"votes"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new AnonymousVote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"votes"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"signature?"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"password?"),"): ",(0,a.kt)("a",{parentName:"p",href:"AnonymousVote"},(0,a.kt)("inlineCode",{parentName:"a"},"AnonymousVote"))),(0,a.kt)("p",null,"Constructs a csp vote"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"votes")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(",(0,a.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"bigint"),")[]"),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"undefined")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The list of votes values")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"signature?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"undefined")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The signature of the payload")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"password")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"'0'")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The password of the anonymous vote")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"AnonymousVote"},(0,a.kt)("inlineCode",{parentName:"a"},"AnonymousVote"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Vote"},"Vote"),".",(0,a.kt)("a",{parentName:"p",href:"Vote#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/anonymous.ts#L14"},"types/vote/anonymous.ts:14")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"_password"},"_","password"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","password"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/anonymous.ts#L4"},"types/vote/anonymous.ts:4")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_signature"},"_","signature"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","signature"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/anonymous.ts#L5"},"types/vote/anonymous.ts:5")),(0,a.kt)("h2",{id:"accessors-1"},"Accessors"),(0,a.kt)("h3",{id:"password"},"password"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"password"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/anonymous.ts#L20"},"types/vote/anonymous.ts:20")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"password"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/anonymous.ts#L24"},"types/vote/anonymous.ts:24")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"signature"},"signature"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"signature"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/anonymous.ts#L28"},"types/vote/anonymous.ts:28")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"signature"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/anonymous.ts#L32"},"types/vote/anonymous.ts:32")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votes"},"votes"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"votes"),"(): (",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint"),")[]"),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,"(",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint"),")[]"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Vote.votes"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/vote.ts#L16"},"types/vote/vote.ts:16")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"votes"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(",(0,a.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"bigint"),")[]")))),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Vote.votes"),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/vote.ts#L20"},"types/vote/vote.ts:20")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a7c28e13.efafb069.js b/assets/js/a7c28e13.efafb069.js new file mode 100644 index 000000000..8a004f5b4 --- /dev/null +++ b/assets/js/a7c28e13.efafb069.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7862],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),p=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},d=function(e){var t=p(e.components);return a.createElement(o.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=p(n),k=r,m=u["".concat(o,".").concat(k)]||u[k]||c[k]||i;return n?a.createElement(m,s(s({ref:t},d),{},{components:n})):a.createElement(m,s({ref:t},d))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,s=new Array(i);s[0]=u;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l.mdxType="string"==typeof e?e:r,s[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>s,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var a=n(87462),r=(n(67294),n(3905));const i={},s="Census Types",l={unversionedId:"sdk/integration-details/census-types/census-types",id:"sdk/integration-details/census-types/census-types",title:"Census Types",description:"A census is a list of voters who are eligible to vote in a given election. There are multiple ways to define a census with Vocdoni, each with different privacy and verifiability considerations. The census types are defined at a protocol level and include on-chain, off-chain Merkle tree, and off-chain Credential Service Provider.",source:"@site/docs/sdk/integration-details/census-types/census-types.md",sourceDirName:"sdk/integration-details/census-types",slug:"/sdk/integration-details/census-types/",permalink:"/sdk/integration-details/census-types/",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Integration Details",permalink:"/sdk/integration-details/"},next:{title:"Off-chain Credential Service Provider",permalink:"/sdk/integration-details/census-types/off-chain-csp"}},o={},p=[],d={toc:p};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"census-types"},"Census Types"),(0,r.kt)("p",null,"A census is a list of voters who are eligible to vote in a given election. There are multiple ways to define a census with Vocdoni, each with different privacy and verifiability considerations. The ",(0,r.kt)("a",{parentName:"p",href:"/protocol/census"},"census types")," are defined at a protocol level and include ",(0,r.kt)("a",{parentName:"p",href:"/sdk/integration-details/census-types/on-chain"},"on-chain"),", ",(0,r.kt)("a",{parentName:"p",href:"/sdk/integration-details/census-types/off-chain-tree"},"off-chain Merkle tree"),", and ",(0,r.kt)("a",{parentName:"p",href:"/sdk/integration-details/census-types/off-chain-csp"},"off-chain Credential Service Provider"),". "),(0,r.kt)("p",null,"The census type is selected from the SDK by using a ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,r.kt)("inlineCode",{parentName:"a"},"census"))," of that type when creating an election. The SDK ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#hierarchy"},"census types")," correspond to the three protocol-level census types according to the following table:"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"SDK Census Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Protocol Type"),(0,r.kt)("th",{parentName:"tr",align:null},"weighted"),(0,r.kt)("th",{parentName:"tr",align:null},"anonymous"),(0,r.kt)("th",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"th",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("th",{parentName:"tr",align:null}))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/CSPCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"CSPCensus"))),(0,r.kt)("td",{parentName:"tr",align:null},"Off-chain CSP"),(0,r.kt)("td",{parentName:"tr",align:null},"no"),(0,r.kt)("td",{parentName:"tr",align:null},"optional"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"CSP")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/PublishedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))," -> ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/TokenCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"TokenCensus"))),(0,r.kt)("td",{parentName:"tr",align:null},"On-chain"),(0,r.kt)("td",{parentName:"tr",align:null},"yes"),(0,r.kt)("td",{parentName:"tr",align:null},"no"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"WEIGHTED")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/PublishedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))," -> ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/TokenCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"TokenCensus"))),(0,r.kt)("td",{parentName:"tr",align:null},"On-chain"),(0,r.kt)("td",{parentName:"tr",align:null},"yes"),(0,r.kt)("td",{parentName:"tr",align:null},"yes"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"ANONYMOUS")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/OffchainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))," -> ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/PlainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PlainCensus"))),(0,r.kt)("td",{parentName:"tr",align:null},"Off-chain tree"),(0,r.kt)("td",{parentName:"tr",align:null},"no"),(0,r.kt)("td",{parentName:"tr",align:null},"no"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"WEIGHTED")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/OffchainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))," -> ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/PlainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PlainCensus"))),(0,r.kt)("td",{parentName:"tr",align:null},"Off-chain tree"),(0,r.kt)("td",{parentName:"tr",align:null},"no"),(0,r.kt)("td",{parentName:"tr",align:null},"yes"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"WEIGHTED")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/OffchainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))," -> ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/WeightedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"WeightedCensus"))),(0,r.kt)("td",{parentName:"tr",align:null},"Off-chain tree"),(0,r.kt)("td",{parentName:"tr",align:null},"yes"),(0,r.kt)("td",{parentName:"tr",align:null},"no"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"ANONYMOUS")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/OffchainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))," -> ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/WeightedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"WeightedCensus"))),(0,r.kt)("td",{parentName:"tr",align:null},"Off-chain tree"),(0,r.kt)("td",{parentName:"tr",align:null},"yes"),(0,r.kt)("td",{parentName:"tr",align:null},"yes"),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"ANONYMOUS")),(0,r.kt)("td",{parentName:"tr",align:null})))),(0,r.kt)("admonition",{type:"note"},(0,r.kt)("p",{parentName:"admonition"},"A weighted census is one where some voters' votes have more power than others, set by a ",(0,r.kt)("inlineCode",{parentName:"p"},"weight")," value. ",(0,r.kt)("inlineCode",{parentName:"p"},"PlainCensus")," is described by a ",(0,r.kt)("inlineCode",{parentName:"p"},"WEIGHTED")," ",(0,r.kt)("inlineCode",{parentName:"p"},"CensusType")," because it technically is a weighted census, with every weight set to ",(0,r.kt)("inlineCode",{parentName:"p"},"1"),".")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a87232fc.2883a381.js b/assets/js/a87232fc.2883a381.js deleted file mode 100644 index 6e0b4b11b..000000000 --- a/assets/js/a87232fc.2883a381.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7347],{3905:(e,n,t)=>{t.d(n,{Zo:()=>l,kt:()=>f});var r=t(67294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function s(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var p=r.createContext({}),c=function(e){var n=r.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):s(s({},n),e)),t},l=function(e){var n=c(e.components);return r.createElement(p.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,a=e.originalType,p=e.parentName,l=o(e,["components","mdxType","originalType","parentName"]),d=c(t),f=i,h=d["".concat(p,".").concat(f)]||d[f]||u[f]||a;return t?r.createElement(h,s(s({ref:n},l),{},{components:t})):r.createElement(h,s({ref:n},l))}));function f(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var a=t.length,s=new Array(a);s[0]=d;var o={};for(var p in n)hasOwnProperty.call(n,p)&&(o[p]=n[p]);o.originalType=e,o.mdxType="string"==typeof e?e:i,s[1]=o;for(var c=2;c{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>c});var r=t(87462),i=(t(67294),t(3905));const a={},s=void 0,o={unversionedId:"sdk/reference/interfaces/ICensus3SupportedChain",id:"sdk/reference/interfaces/ICensus3SupportedChain",title:"ICensus3SupportedChain",description:"@vocdoni/sdk / Exports / ICensus3SupportedChain",source:"@site/docs/sdk/reference/interfaces/ICensus3SupportedChain.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3SupportedChain",permalink:"/sdk/reference/interfaces/ICensus3SupportedChain",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategyToken",permalink:"/sdk/reference/interfaces/ICensus3StrategyToken"},next:{title:"ICensus3TokenHolderResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenHolderResponse"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"chainID",id:"chainid",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"shortName",id:"shortname",level:3},{value:"Defined in",id:"defined-in-2",level:4}],l={toc:c};function u(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},l,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3SupportedChain"),(0,i.kt)("h1",{id:"interface-icensus3supportedchain"},"Interface: ICensus3SupportedChain"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3SupportedChain#chainid"},"chainID")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3SupportedChain#name"},"name")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3SupportedChain#shortname"},"shortName"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"chainid"},"chainID"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"chainID"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The identifier of the chain"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/service.ts#L12"},"api/census3/service.ts:12")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"name"},"name"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"name"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The name of the chain"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/service.ts#L22"},"api/census3/service.ts:22")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"shortname"},"shortName"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"shortName"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The short name of the chain"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/service.ts#L17"},"api/census3/service.ts:17")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a87232fc.38b9a196.js b/assets/js/a87232fc.38b9a196.js new file mode 100644 index 000000000..972ccf67c --- /dev/null +++ b/assets/js/a87232fc.38b9a196.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7347],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>f});var r=t(67294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var p=r.createContext({}),l=function(e){var n=r.useContext(p),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},c=function(e){var n=l(e.components);return r.createElement(p.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,a=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=l(t),f=i,h=d["".concat(p,".").concat(f)]||d[f]||u[f]||a;return t?r.createElement(h,o(o({ref:n},c),{},{components:t})):r.createElement(h,o({ref:n},c))}));function f(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var a=t.length,o=new Array(a);o[0]=d;var s={};for(var p in n)hasOwnProperty.call(n,p)&&(s[p]=n[p]);s.originalType=e,s.mdxType="string"==typeof e?e:i,o[1]=s;for(var l=2;l{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>l});var r=t(87462),i=(t(67294),t(3905));const a={},o=void 0,s={unversionedId:"sdk/reference/interfaces/ICensus3SupportedChain",id:"sdk/reference/interfaces/ICensus3SupportedChain",title:"ICensus3SupportedChain",description:"@vocdoni/sdk / Exports / ICensus3SupportedChain",source:"@site/docs/sdk/reference/interfaces/ICensus3SupportedChain.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3SupportedChain",permalink:"/sdk/reference/interfaces/ICensus3SupportedChain",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategyToken",permalink:"/sdk/reference/interfaces/ICensus3StrategyToken"},next:{title:"ICensus3TokenHolderResponse",permalink:"/sdk/reference/interfaces/ICensus3TokenHolderResponse"}},p={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"chainID",id:"chainid",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"shortName",id:"shortname",level:3},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:l};function u(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3SupportedChain"),(0,i.kt)("h1",{id:"interface-icensus3supportedchain"},"Interface: ICensus3SupportedChain"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ICensus3SupportedChain#chainid"},"chainID")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ICensus3SupportedChain#name"},"name")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ICensus3SupportedChain#shortname"},"shortName"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"chainid"},"chainID"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"chainID"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The identifier of the chain"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/service.ts#L12"},"api/census3/service.ts:12")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"name"},"name"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"name"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The name of the chain"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/service.ts#L22"},"api/census3/service.ts:22")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"shortname"},"shortName"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"shortName"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The short name of the chain"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/service.ts#L17"},"api/census3/service.ts:17")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/aa9e799f.61d22874.js b/assets/js/aa9e799f.61d22874.js new file mode 100644 index 000000000..0ccbfbccd --- /dev/null +++ b/assets/js/aa9e799f.61d22874.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4183],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>h});var a=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function s(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function r(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var l=a.createContext({}),c=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},u=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,s=e.originalType,l=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),d=c(n),h=o,k=d["".concat(l,".").concat(h)]||d[h]||p[h]||s;return n?a.createElement(k,r(r({ref:t},u),{},{components:n})):a.createElement(k,r({ref:t},u))}));function h(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var s=n.length,r=new Array(s);r[0]=d;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i.mdxType="string"==typeof e?e:o,r[1]=i;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>s,metadata:()=>i,toc:()=>c});var a=n(87462),o=(n(67294),n(3905));const s={},r="On-chain Token-Based Census",i={unversionedId:"sdk/integration-details/census-types/on-chain/on-chain",id:"sdk/integration-details/census-types/on-chain/on-chain",title:"On-chain Token-Based Census",description:"An on-chain census is one whose voters are defined by holding tokens on the Ethereum blockchain. Currently the following token types are supported:",source:"@site/docs/sdk/integration-details/census-types/on-chain/on-chain.md",sourceDirName:"sdk/integration-details/census-types/on-chain",slug:"/sdk/integration-details/census-types/on-chain/",permalink:"/sdk/integration-details/census-types/on-chain/",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Off-chain Merkle Tree",permalink:"/sdk/integration-details/census-types/off-chain-tree"},next:{title:"Complex Census",permalink:"/sdk/integration-details/census-types/on-chain/complex-census"}},l={},c=[{value:"Tutorial",id:"tutorial",level:2},{value:"Setup",id:"setup",level:3},{value:"Creating a Token",id:"creating-a-token",level:4},{value:"Registering Your Token",id:"registering-your-token",level:4},{value:"Creating the Census",id:"creating-the-census",level:3},{value:"Complex Census",id:"complex-census",level:4},{value:"Election & Voting",id:"election--voting",level:3},{value:"Anonymity",id:"anonymity",level:2}],u={toc:c};function p(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"on-chain-token-based-census"},"On-chain Token-Based Census"),(0,o.kt)("p",null,"An on-chain census is one whose voters are defined by holding tokens on the Ethereum blockchain. Currently the following token types are supported:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"ERC20"),(0,o.kt)("li",{parentName:"ul"},"ERC721"),(0,o.kt)("li",{parentName:"ul"},"ERC777"),(0,o.kt)("li",{parentName:"ul"},"POAP"),(0,o.kt)("li",{parentName:"ul"},"Gitcoin Passport Score"),(0,o.kt)("li",{parentName:"ul"},"Gitcoin Passport Shields (coming soon)"),(0,o.kt)("li",{parentName:"ul"},"ERC1155 (coming soon)")),(0,o.kt)("admonition",{title:"token selection",type:"warning"},(0,o.kt)("p",{parentName:"admonition"},"While all of the above token types are supported, the recommended use-case for a token-based census is a custom token created specifically to govern an organization. It is theoretically possible to create a census with a popular token such as ETH, but the number of token-holders and frequency of transactions for such a token make census generation impractical. ")),(0,o.kt)("p",null,"This census type is supported by our ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/census3"},"Census3")," service which serves as a bridge between Ethereum and clients, collecting token-holder data and generating census trees."),(0,o.kt)("h2",{id:"tutorial"},"Tutorial"),(0,o.kt)("p",null,"You can check out a full working example of this tutorial ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/tree/examples/token-based/examples/token-based"},"here")),(0,o.kt)("p",null,"The on-chain census requires some extra setup, as censuses depend on indexing token balances from a public blockchain. Luckily the SDK provides a client to the Census3 service which keeps track of token balances and translates blockchain data to a straightforward census of voters. This tutorial explains how to set up your environment and use the ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/classes/vocdonicensus3client"},"VocdoniCensus3Client"),"."),(0,o.kt)("h3",{id:"setup"},"Setup"),(0,o.kt)("p",null,"The first consideration when setting up an on-chain census is which token you will use to validate voters. This section will explain how to create a token for testing and register that token to the census3 service."),(0,o.kt)("h4",{id:"creating-a-token"},"Creating a Token"),(0,o.kt)("admonition",{title:"existing token",type:"tip"},(0,o.kt)("p",{parentName:"admonition"},"If you already have a token that represents your organization, feel free to skip this step and register your token with the census3 service.")),(0,o.kt)("p",null,"The easiest way to start using and testing the census3 service is to create a testing token on a testnet (a blockchain network built for testing integrations, where tokens have no real value). We will use a free service to generate a token on the ",(0,o.kt)("a",{parentName:"p",href:"https://www.alchemy.com/overviews/sepolia-testnet"},"Sepolia")," testnet. Before you can generate a token, however, there are two steps:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Make sure you have a wallet such as ",(0,o.kt)("a",{parentName:"li",href:"https://metamask.io/"},"Metamask")," and an account to use for testing. "),(0,o.kt)("li",{parentName:"ul"},"Request some Sepolia ETH from the ",(0,o.kt)("a",{parentName:"li",href:"https://www.alchemy.com/faucets/ethereum-sepolia"},"Sepolia faucet"),'. You need testnet Ethereum to "pay" for transactions on Sepolia. ')),(0,o.kt)("p",null,"You can use ",(0,o.kt)("a",{parentName:"p",href:"https://coinfactory.app/generator/erc20/standard-token"},"Coin Factory"),' to create a standard token. For testing purposes the name, symbol, and initial supply of the token do not matter. After pressing "create token" and signing with you metamask account, make sure to open the token\'s etherscan page and copy its address.'),(0,o.kt)("h4",{id:"registering-your-token"},"Registering Your Token"),(0,o.kt)("p",null,"With a token created, you now need to register this token to the census3 service. You can set up a fresh Vocdoni SDK environment as described in the ",(0,o.kt)("a",{parentName:"p",href:"/sdk/tutorial"},"tutorial"),"."),(0,o.kt)("p",null,"For the sake of testing, let's simply hard-code some information about the token we want to use. We need the address of the token you just published as well as the public Chain ID for the testnet (or mainnet) you are using. Sepolia's chainID is ",(0,o.kt)("inlineCode",{parentName:"p"},"11155111"),". We also need the token type, which in this case is ",(0,o.kt)("inlineCode",{parentName:"p"},"erc20"),". "),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"const myToken = {\n address: '0x...',\n chainID: 11155111,\n type: 'erc20',\n};\n")),(0,o.kt)("p",null,"In addition to creating a normal VocdoniSDKClient, you also need a ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/classes/vocdonicensus3client"},(0,o.kt)("inlineCode",{parentName:"a"},"VocdoniCensus3Client")),". Use the same environment as you would for the standard SDK client, in this case Staging for a stable testing environment."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"const census3client = new VocdoniCensus3Client({ env: EnvOptions.STG });\n")),(0,o.kt)("p",null,"Make sure the Sepolia network is supported by the census3 service with ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/classes/vocdonicensus3client#getsupportedchains"},(0,o.kt)("inlineCode",{parentName:"a"},"getSupportedChains")),". Sepolia should always be supported, but if it is not, you need to create a token on a chain that is."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"let chains = await census3Client.getSupportedChains();\nlet supportsChain = false;\nfor (let chain of chains) {\n if (chain.chainID == myToken.chainID) {\n supportsChain = true;\n }\n}\n")),(0,o.kt)("p",null,"Similarly, before registering the token, you can double-check whether it already is supported with ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/classes/vocdonicensus3client#getsupportedtokens"},(0,o.kt)("inlineCode",{parentName:"a"},"getSupportedTokens")),". Here we convert our target token address to lowercase because it is represented by a case-insensitive hex-string. If the token is already supported (not possible if the token is brand-new), you can skip the next step."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"let tokens = await census3Client.getSupportedTokens();\nlet supportsToken = false;\nfor (let token of tokens) {\n if (token.ID.toLowerCase() === myToken.address.toLowerCase()) {\n supportsToken = true;\n }\n}\n")),(0,o.kt)("p",null,"Now we can register the token. "),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"await census3Client.createToken(myToken.address, myToken.type, myToken.chainID);\n")),(0,o.kt)("admonition",{title:"warning",type:"warning"},(0,o.kt)("p",{parentName:"admonition"},"The ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/classes/vocdonicensus3client#createtoken"},(0,o.kt)("inlineCode",{parentName:"a"},"createToken"))," function asks the census3 service to add the token to its registry, but this does not mean the token is ready to use.")),(0,o.kt)("p",null,"Now that the token is registered, we can request the token info from the census3 service. Before using this token to create a census or getting information about the number of token-holders, however, we need to wait for the census3 service to peruse the blockchain and index the entire history of the token. Even with a brand new token this can take some time in the range of 30 minutes. ",(0,o.kt)("inlineCode",{parentName:"p"},"info.status")," reports whether the token has synced and the syncing progress percentage."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"let status = (await census3Client.getToken(myToken.address, myToken.chainID)).status;\nif (!status.synced) {\n console.log('Token %s is syncing. Progress %d%. Try again later.', myToken.address, status.progress);\n return;\n}\n")),(0,o.kt)("h3",{id:"creating-the-census"},"Creating the Census"),(0,o.kt)("p",null,"Once a token has been registered and is synced, the steps above never have to be performed again. Simple censuses can be created with ",(0,o.kt)("inlineCode",{parentName:"p"},"createTokenCensus"),": this creates the 'default' census, in which every token-holder has a weighted vote according to their token balance. "),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"const census = await census3Client.createTokenCensus(myToken.address, myToken.chainID);\n")),(0,o.kt)("h4",{id:"complex-census"},"Complex Census"),(0,o.kt)("p",null,"It is possible to create a census with more complex inclusion criteria, such as holders of two different tokens. In order to do this, each token must individually be supported by the census3 service.\nThe first step is to create a 'strategy' with ",(0,o.kt)("inlineCode",{parentName:"p"},"census3Client.createStrategy"),". This strategy ID is then passed to ",(0,o.kt)("inlineCode",{parentName:"p"},"census3Client.createCensus")," to generate the census itself.\n",(0,o.kt)("inlineCode",{parentName:"p"},"createStrategy")," takes a ",(0,o.kt)("inlineCode",{parentName:"p"},"predicate")," string which defines the logical operations representing inclusion criteria for the census strategy."),(0,o.kt)("p",null,"For a detailed guide on creating complex on-chain censuses, check out ",(0,o.kt)("a",{parentName:"p",href:"on-chain/complex-census"},"Complex Census")),(0,o.kt)("h3",{id:"election--voting"},"Election & Voting"),(0,o.kt)("p",null,"Once a census has been created, the entire process is identical to the off-chain tree census process."),(0,o.kt)("ol",null,(0,o.kt)("li",{parentName:"ol"},"Create account"),(0,o.kt)("li",{parentName:"ol"},"Create election"),(0,o.kt)("li",{parentName:"ol"},"Publish election & wait for it to be posted"),(0,o.kt)("li",{parentName:"ol"},"Cast votes"),(0,o.kt)("li",{parentName:"ol"},"Count votes")),(0,o.kt)("p",null,"The one difference here is how voter wallets are accessed. Because we are using a token-based census, voters are expected to have custody of their private keys. In a web application, you would need to ask users to connect with a wallet provider (like Metamask) to provide the public key associated with their token-holder account and to sign their vote transaction. You can see how we implemented this in our ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c9440d96d7cc5b3ac5e81e9350794660d7/examples/vite-react-app/src/containers/App.tsx#L185"},"vite-react example"),". "),(0,o.kt)("p",null,"For the purposes of this tutorial, we can just manually import the private key of the ",(0,o.kt)("strong",{parentName:"p"},"testing-only")," wallet we used to generate the token initially. You could also make other testing wallets and send some of your testing token to them so you can use multiple voters with different weights."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"// Private-keys copied from your wallet provider. NEVER do this with an account you use to hold real funds.\nconst voters = ['...', '...'];\nfor (const voter of voters) {\n const wallet = new Wallet(voter);\n const client = new VocdoniSDKClient({ env: EnvOptions.STG, wallet: wallet, electionId: electionId });\n ...\n // Create the vote and cast is as you would with an off-chain census\n")),(0,o.kt)("h2",{id:"anonymity"},"Anonymity"),(0,o.kt)("p",null,"Anonymity may seem impossible for token-based censuses, as votes are weighted based on public token balance values. However, we have been able to design a sufficiently-anonymous approach by rounding token values, which you can read about on our ",(0,o.kt)("a",{parentName:"p",href:"https://blog.vocdoni.io/anonymous-voting-token-based"},"blog"),". This form of anonymity has some drawbacks and theoretical weaknesses that users should be aware of, but it provides a strong layer of anonymity under the right conditions. "),(0,o.kt)("p",null,"All you need to do to create an anonymous token-based census is to set the ",(0,o.kt)("inlineCode",{parentName:"p"},"anonymous")," parameter to ",(0,o.kt)("inlineCode",{parentName:"p"},"true"),":"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"const census = await census3Client.createTokenCensus(myToken.address, myToken.chainID, true);\n")),(0,o.kt)("p",null,"You can then use this census with an anonymous election:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"electionType: { anonymous: true },\n")),(0,o.kt)("p",null,"Voting proceeds as normal and the anonymity is applied."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/aab6ad66.33080cf6.js b/assets/js/aab6ad66.33080cf6.js deleted file mode 100644 index fa25c341e..000000000 --- a/assets/js/aab6ad66.33080cf6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[260],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var i=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function a(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=i.createContext({}),o=function(e){var t=i.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},p=function(e){var t=o(e.components);return i.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,s=e.parentName,p=d(e,["components","mdxType","originalType","parentName"]),k=o(n),u=r,h=k["".concat(s,".").concat(u)]||k[u]||c[u]||l;return n?i.createElement(h,a(a({ref:t},p),{},{components:n})):i.createElement(h,a({ref:t},p))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,a=new Array(l);a[0]=k;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d.mdxType="string"==typeof e?e:r,a[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>c,frontMatter:()=>l,metadata:()=>d,toc:()=>o});var i=n(87462),r=(n(67294),n(3905));const l={},a=void 0,d={unversionedId:"sdk/reference/classes/ArchivedElection",id:"sdk/reference/classes/ArchivedElection",title:"ArchivedElection",description:"@vocdoni/sdk / Exports / ArchivedElection",source:"@site/docs/sdk/reference/classes/ArchivedElection.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/ArchivedElection",permalink:"/sdk/reference/classes/ArchivedElection",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ApprovalElection",permalink:"/sdk/reference/classes/ApprovalElection"},next:{title:"BudgetElection",permalink:"/sdk/reference/classes/BudgetElection"}},s={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_addSDKVersion",id:"_addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_census",id:"_census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_description",id:"_description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"_electionType",id:"_electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"_endDate",id:"_enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"_header",id:"_header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"_maxCensusSize",id:"_maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"_meta",id:"_meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"_questions",id:"_questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"_startDate",id:"_startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"_streamUri",id:"_streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"_temporarySecretIdentity",id:"_temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"_title",id:"_title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"_voteType",id:"_votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"census",id:"census",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"chainId",id:"chainid",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"creationTime",id:"creationtime",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"description",id:"description",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"endDate",id:"enddate",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"finalResults",id:"finalresults",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"fromArchive",id:"fromarchive",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"header",id:"header",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"id",id:"id",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"isValid",id:"isvalid",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"manuallyEnded",id:"manuallyended",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-25",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-26",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"meta",id:"meta",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-27",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"metadataURL",id:"metadataurl",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-28",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"organizationId",id:"organizationid",level:3},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-29",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"questions",id:"questions",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-30",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"raw",id:"raw",level:3},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-31",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"results",id:"results",level:3},{value:"Returns",id:"returns-20",level:4},{value:"Inherited from",id:"inherited-from-32",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"resultsType",id:"resultstype",level:3},{value:"Returns",id:"returns-21",level:4},{value:"Inherited from",id:"inherited-from-33",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"startDate",id:"startdate",level:3},{value:"Returns",id:"returns-22",level:4},{value:"Inherited from",id:"inherited-from-34",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"status",id:"status",level:3},{value:"Returns",id:"returns-23",level:4},{value:"Inherited from",id:"inherited-from-35",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Returns",id:"returns-24",level:4},{value:"Inherited from",id:"inherited-from-36",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Returns",id:"returns-25",level:4},{value:"Inherited from",id:"inherited-from-37",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"title",id:"title",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Inherited from",id:"inherited-from-38",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"voteCount",id:"votecount",level:3},{value:"Returns",id:"returns-27",level:4},{value:"Inherited from",id:"inherited-from-39",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"voteType",id:"votetype",level:3},{value:"Returns",id:"returns-28",level:4},{value:"Inherited from",id:"inherited-from-40",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"Methods",id:"methods-1",level:2},{value:"checkVote",id:"checkvote",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Inherited from",id:"inherited-from-41",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Inherited from",id:"inherited-from-42",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"build",id:"build",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Inherited from",id:"inherited-from-43",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"checkVote",id:"checkvote-1",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Inherited from",id:"inherited-from-44",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"from",id:"from",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Inherited from",id:"inherited-from-45",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"getStatus",id:"getstatus",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-34",level:4},{value:"Inherited from",id:"inherited-from-46",level:4},{value:"Defined in",id:"defined-in-48",level:4}],p={toc:o};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,i.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ArchivedElection"),(0,r.kt)("h1",{id:"class-archivedelection"},"Class: ArchivedElection"),(0,r.kt)("p",null,"Represents a published election"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedElection"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"ArchivedElection"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_addsdkversion"},"_","addSDKVersion")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_census"},"_","census")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_description"},"_","description")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_electiontype"},"_","electionType")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_enddate"},"_","endDate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_header"},"_","header")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_maxcensussize"},"_","maxCensusSize")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_meta"},"_","meta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_questions"},"_","questions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_startdate"},"_","startDate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_streamuri"},"_","streamUri")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_temporarysecretidentity"},"_","temporarySecretIdentity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_title"},"_","title")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_votetype"},"_","voteType"))),(0,r.kt)("h3",{id:"accessors"},"Accessors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#addsdkversion"},"addSDKVersion")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#census"},"census")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#chainid"},"chainId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#creationtime"},"creationTime")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#description"},"description")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#electiontype"},"electionType")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#enddate"},"endDate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#finalresults"},"finalResults")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#fromarchive"},"fromArchive")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#header"},"header")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#id"},"id")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#isvalid"},"isValid")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#manuallyended"},"manuallyEnded")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#maxcensussize"},"maxCensusSize")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#meta"},"meta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#metadataurl"},"metadataURL")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#organizationid"},"organizationId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#questions"},"questions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#raw"},"raw")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#results"},"results")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#resultstype"},"resultsType")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#startdate"},"startDate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#status"},"status")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#streamuri"},"streamUri")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#temporarysecretidentity"},"temporarySecretIdentity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#title"},"title")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#votecount"},"voteCount")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#votetype"},"voteType"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#checkvote"},"checkVote")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#get"},"get")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#build"},"build")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#checkvote-1"},"checkVote")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#from"},"from")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#getstatus"},"getStatus"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new ArchivedElection"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ArchivedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"ArchivedElection"))),(0,r.kt)("p",null,"Constructs an archived election"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IPublishedElectionParameters"},(0,r.kt)("inlineCode",{parentName:"a"},"IPublishedElectionParameters"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Election parameters")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ArchivedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"ArchivedElection"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#constructor"},"constructor")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/archived.ts#L13"},"types/election/archived.ts:13")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"_addsdkversion"},"_","addSDKVersion"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","addSDKVersion"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_addsdkversion"},"_addSDKVersion")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L175"},"types/election/election.ts:175")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_census"},"_","census"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","census"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,r.kt)("inlineCode",{parentName:"a"},"Census"))),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_census"},"_census")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L172"},"types/election/election.ts:172")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_description"},"_","description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_description"},"_description")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L163"},"types/election/election.ts:163")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_electiontype"},"_","electionType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","electionType"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_electiontype"},"_electionType")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L169"},"types/election/election.ts:169")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_enddate"},"_","endDate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","endDate"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_enddate"},"_endDate")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L168"},"types/election/election.ts:168")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_header"},"_","header"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","header"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_header"},"_header")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L164"},"types/election/election.ts:164")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_maxcensussize"},"_","maxCensusSize"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","maxCensusSize"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_maxcensussize"},"_maxCensusSize")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L173"},"types/election/election.ts:173")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_meta"},"_","meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_meta"},"_meta")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L166"},"types/election/election.ts:166")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_questions"},"_","questions"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","questions"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,r.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,r.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_questions"},"_questions")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L171"},"types/election/election.ts:171")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_startdate"},"_","startDate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","startDate"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_startdate"},"_startDate")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L167"},"types/election/election.ts:167")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_streamuri"},"_","streamUri"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","streamUri"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_streamuri"},"_streamUri")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L165"},"types/election/election.ts:165")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_temporarysecretidentity"},"_","temporarySecretIdentity"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","temporarySecretIdentity"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_temporarysecretidentity"},"_temporarySecretIdentity")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L174"},"types/election/election.ts:174")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_title"},"_","title"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","title"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_title"},"_title")),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L162"},"types/election/election.ts:162")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_votetype"},"_","voteType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","voteType"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,r.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,r.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_votetype"},"_voteType")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L170"},"types/election/election.ts:170")),(0,r.kt)("h2",{id:"accessors-1"},"Accessors"),(0,r.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"addSDKVersion"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.addSDKVersion"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L262"},"types/election/election.ts:262")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"census"},"census"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"census"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"ArchivedCensus")),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"ArchivedCensus")),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,"PublishedElection.census"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/archived.ts#L17"},"types/election/archived.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"chainid"},"chainId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"chainId"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.chainId"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L219"},"types/election/published.ts:219")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"creationtime"},"creationTime"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"creationTime"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.creationTime"),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L223"},"types/election/published.ts:223")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"description"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.description"),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L147"},"types/election/published.ts:147")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electiontype"},"electionType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"electionType"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,r.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.electionType"),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L167"},"types/election/published.ts:167")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"enddate"},"endDate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"endDate"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.endDate"),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L163"},"types/election/published.ts:163")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"finalresults"},"finalResults"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"finalResults"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.finalResults"),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L203"},"types/election/published.ts:203")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fromarchive"},"fromArchive"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"fromArchive"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-21"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.fromArchive"),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L215"},"types/election/published.ts:215")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"header"},"header"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"header"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-22"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.header"),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L151"},"types/election/published.ts:151")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"id"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-23"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.id"),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L187"},"types/election/published.ts:187")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isvalid"},"isValid"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"isValid"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-24"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.isValid"),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L239"},"types/election/published.ts:239")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"manuallyended"},"manuallyEnded"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"manuallyEnded"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-25"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.manuallyEnded"),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L211"},"types/election/published.ts:211")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"maxCensusSize"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-26"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.maxCensusSize"),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L183"},"types/election/published.ts:183")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"meta"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"inherited-from-27"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.meta"),(0,r.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L226"},"types/election/election.ts:226")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"metadataurl"},"metadataURL"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"metadataURL"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-28"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.metadataURL"),(0,r.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L227"},"types/election/published.ts:227")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"organizationid"},"organizationId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"organizationId"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-29"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.organizationId"),(0,r.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L191"},"types/election/published.ts:191")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"questions"},"questions"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"questions"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,r.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,r.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,r.kt)("h4",{id:"inherited-from-30"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.questions"),(0,r.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L175"},"types/election/published.ts:175")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"raw"},"raw"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"raw"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"object")),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"object")),(0,r.kt)("h4",{id:"inherited-from-31"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.raw"),(0,r.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L235"},"types/election/published.ts:235")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"results"},"results"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"results"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[][]"),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[][]"),(0,r.kt)("h4",{id:"inherited-from-32"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.results"),(0,r.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L207"},"types/election/published.ts:207")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"resultstype"},"resultsType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"resultsType"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#electionresultstype"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionResultsType"))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#electionresultstype"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionResultsType"))),(0,r.kt)("h4",{id:"inherited-from-33"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.resultsType"),(0,r.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L231"},"types/election/published.ts:231")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"startdate"},"startDate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"startDate"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"inherited-from-34"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.startDate"),(0,r.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L159"},"types/election/published.ts:159")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"status"},"status"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"status"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,r.kt)("h4",{id:"returns-23"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,r.kt)("h4",{id:"inherited-from-35"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.status"),(0,r.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L195"},"types/election/published.ts:195")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"streamuri"},"streamUri"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"streamUri"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-24"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-36"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.streamUri"),(0,r.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L155"},"types/election/published.ts:155")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-25"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-37"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.temporarySecretIdentity"),(0,r.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L258"},"types/election/election.ts:258")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"title"},"title"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"title"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"returns-26"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"inherited-from-38"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.title"),(0,r.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L143"},"types/election/published.ts:143")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"votecount"},"voteCount"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"voteCount"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"returns-27"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-39"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.voteCount"),(0,r.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L199"},"types/election/published.ts:199")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"votetype"},"voteType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"voteType"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,r.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,r.kt)("h4",{id:"returns-28"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,r.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,r.kt)("h4",{id:"inherited-from-40"},"Inherited from"),(0,r.kt)("p",null,"PublishedElection.voteType"),(0,r.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L171"},"types/election/published.ts:171")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"checkvote"},"checkVote"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkVote"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"vote"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"vote")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Vote"},(0,r.kt)("inlineCode",{parentName:"a"},"Vote")))))),(0,r.kt)("h4",{id:"returns-29"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-41"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#checkvote"},"checkVote")),(0,r.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L113"},"types/election/published.ts:113")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"dot"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dot")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-30"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"inherited-from-42"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#get"},"get")),(0,r.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L266"},"types/election/election.ts:266")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"build"},"build"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"build"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedElection"))),(0,r.kt)("p",null,"Returns a published election object"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IPublishedElectionParameters"},(0,r.kt)("inlineCode",{parentName:"a"},"IPublishedElectionParameters"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Published election parameters")))),(0,r.kt)("h4",{id:"returns-31"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedElection"))),(0,r.kt)("h4",{id:"inherited-from-43"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#build"},"build")),(0,r.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L100"},"types/election/published.ts:100")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"checkvote-1"},"checkVote"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkVote"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"vote"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"voteType"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"vote")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Vote"},(0,r.kt)("inlineCode",{parentName:"a"},"Vote")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"voteType")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IVoteType"},(0,r.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,r.kt)("h4",{id:"returns-32"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-44"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#checkvote-1"},"checkVote")),(0,r.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L127"},"types/election/published.ts:127")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"from"},"from"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"from"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,r.kt)("p",null,"Returns an unpublished election object"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IElectionParameters"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Unpublished Election parameters")))),(0,r.kt)("h4",{id:"returns-33"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,r.kt)("h4",{id:"inherited-from-45"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#from"},"from")),(0,r.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L206"},"types/election/election.ts:206")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstatus"},"getStatus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStatus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"status"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"startDate"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"status")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#allelectionstatus"},(0,r.kt)("inlineCode",{parentName:"a"},"AllElectionStatus")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"startDate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,r.kt)("h4",{id:"returns-34"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,r.kt)("h4",{id:"inherited-from-46"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#getstatus"},"getStatus")),(0,r.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L104"},"types/election/published.ts:104")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/aab6ad66.c8f828e5.js b/assets/js/aab6ad66.c8f828e5.js new file mode 100644 index 000000000..2f703a9db --- /dev/null +++ b/assets/js/aab6ad66.c8f828e5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[260],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var i=n(67294);function l(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function a(e){for(var t=1;t=0||(l[n]=e[n]);return l}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(l[n]=e[n])}return l}var o=i.createContext({}),s=function(e){var t=i.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},p=function(e){var t=s(e.components);return i.createElement(o.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,l=e.mdxType,r=e.originalType,o=e.parentName,p=d(e,["components","mdxType","originalType","parentName"]),k=s(n),h=l,c=k["".concat(o,".").concat(h)]||k[h]||u[h]||r;return n?i.createElement(c,a(a({ref:t},p),{},{components:n})):i.createElement(c,a({ref:t},p))}));function h(e,t){var n=arguments,l=t&&t.mdxType;if("string"==typeof e||l){var r=n.length,a=new Array(r);a[0]=k;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d.mdxType="string"==typeof e?e:l,a[1]=d;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>d,toc:()=>s});var i=n(87462),l=(n(67294),n(3905));const r={},a=void 0,d={unversionedId:"sdk/reference/classes/ArchivedElection",id:"sdk/reference/classes/ArchivedElection",title:"ArchivedElection",description:"@vocdoni/sdk / Exports / ArchivedElection",source:"@site/docs/sdk/reference/classes/ArchivedElection.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/ArchivedElection",permalink:"/sdk/reference/classes/ArchivedElection",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ApprovalElection",permalink:"/sdk/reference/classes/ApprovalElection"},next:{title:"BudgetElection",permalink:"/sdk/reference/classes/BudgetElection"}},o={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_addSDKVersion",id:"_addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_census",id:"_census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_description",id:"_description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"_electionType",id:"_electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"_endDate",id:"_enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"_header",id:"_header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"_maxCensusSize",id:"_maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"_meta",id:"_meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"_questions",id:"_questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"_startDate",id:"_startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"_streamUri",id:"_streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"_temporarySecretIdentity",id:"_temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"_title",id:"_title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"_voteType",id:"_votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"census",id:"census",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"chainId",id:"chainid",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"creationTime",id:"creationtime",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"description",id:"description",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"endDate",id:"enddate",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"finalResults",id:"finalresults",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"fromArchive",id:"fromarchive",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"header",id:"header",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"id",id:"id",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"isValid",id:"isvalid",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"manuallyEnded",id:"manuallyended",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-25",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-26",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"meta",id:"meta",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-27",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"metadataURL",id:"metadataurl",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-28",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"organizationId",id:"organizationid",level:3},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-29",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"questions",id:"questions",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-30",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"raw",id:"raw",level:3},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-31",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"results",id:"results",level:3},{value:"Returns",id:"returns-20",level:4},{value:"Inherited from",id:"inherited-from-32",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"resultsType",id:"resultstype",level:3},{value:"Returns",id:"returns-21",level:4},{value:"Inherited from",id:"inherited-from-33",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"startDate",id:"startdate",level:3},{value:"Returns",id:"returns-22",level:4},{value:"Inherited from",id:"inherited-from-34",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"status",id:"status",level:3},{value:"Returns",id:"returns-23",level:4},{value:"Inherited from",id:"inherited-from-35",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Returns",id:"returns-24",level:4},{value:"Inherited from",id:"inherited-from-36",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Returns",id:"returns-25",level:4},{value:"Inherited from",id:"inherited-from-37",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"title",id:"title",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Inherited from",id:"inherited-from-38",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"voteCount",id:"votecount",level:3},{value:"Returns",id:"returns-27",level:4},{value:"Inherited from",id:"inherited-from-39",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"voteType",id:"votetype",level:3},{value:"Returns",id:"returns-28",level:4},{value:"Inherited from",id:"inherited-from-40",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"Methods",id:"methods-1",level:2},{value:"checkVote",id:"checkvote",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Inherited from",id:"inherited-from-41",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Inherited from",id:"inherited-from-42",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"build",id:"build",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Inherited from",id:"inherited-from-43",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"checkVote",id:"checkvote-1",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Inherited from",id:"inherited-from-44",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"from",id:"from",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Inherited from",id:"inherited-from-45",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"getStatus",id:"getstatus",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-34",level:4},{value:"Inherited from",id:"inherited-from-46",level:4},{value:"Defined in",id:"defined-in-48",level:4}],p={toc:s};function u(e){let{components:t,...n}=e;return(0,l.kt)("wrapper",(0,i.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,l.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ArchivedElection"),(0,l.kt)("h1",{id:"class-archivedelection"},"Class: ArchivedElection"),(0,l.kt)("p",null,"Represents a published election"),(0,l.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"PublishedElection"))),(0,l.kt)("p",{parentName:"li"},"\u21b3 ",(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"ArchivedElection"))))),(0,l.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,l.kt)("h3",{id:"constructors"},"Constructors"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#constructor"},"constructor"))),(0,l.kt)("h3",{id:"properties"},"Properties"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_addsdkversion"},"_","addSDKVersion")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_census"},"_","census")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_description"},"_","description")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_electiontype"},"_","electionType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_enddate"},"_","endDate")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_header"},"_","header")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_maxcensussize"},"_","maxCensusSize")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_meta"},"_","meta")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_questions"},"_","questions")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_startdate"},"_","startDate")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_streamuri"},"_","streamUri")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_temporarysecretidentity"},"_","temporarySecretIdentity")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_title"},"_","title")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#_votetype"},"_","voteType"))),(0,l.kt)("h3",{id:"accessors"},"Accessors"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#addsdkversion"},"addSDKVersion")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#census"},"census")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#chainid"},"chainId")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#creationtime"},"creationTime")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#description"},"description")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#electiontype"},"electionType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#enddate"},"endDate")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#finalresults"},"finalResults")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#fromarchive"},"fromArchive")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#header"},"header")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#id"},"id")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#isvalid"},"isValid")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#manuallyended"},"manuallyEnded")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#maxcensussize"},"maxCensusSize")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#meta"},"meta")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#metadataurl"},"metadataURL")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#organizationid"},"organizationId")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#questions"},"questions")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#raw"},"raw")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#results"},"results")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#resultstype"},"resultsType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#startdate"},"startDate")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#status"},"status")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#streamuri"},"streamUri")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#temporarysecretidentity"},"temporarySecretIdentity")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#title"},"title")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#votecount"},"voteCount")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#votetype"},"voteType"))),(0,l.kt)("h3",{id:"methods"},"Methods"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#checkvote"},"checkVote")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#get"},"get")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#build"},"build")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ArchivedElection#checkvote-1"},"checkVote")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#from"},"from")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"ArchivedElection#getstatus"},"getStatus"))),(0,l.kt)("h2",{id:"constructors-1"},"Constructors"),(0,l.kt)("h3",{id:"constructor"},"constructor"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"new ArchivedElection"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,l.kt)("a",{parentName:"p",href:"ArchivedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"ArchivedElection"))),(0,l.kt)("p",null,"Constructs an archived election"),(0,l.kt)("h4",{id:"parameters"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"params")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"../interfaces/IPublishedElectionParameters"},(0,l.kt)("inlineCode",{parentName:"a"},"IPublishedElectionParameters"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Election parameters")))),(0,l.kt)("h4",{id:"returns"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"ArchivedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"ArchivedElection"))),(0,l.kt)("h4",{id:"overrides"},"Overrides"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"PublishedElection#constructor"},"constructor")),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/archived.ts#L13"},"types/election/archived.ts:13")),(0,l.kt)("h2",{id:"properties-1"},"Properties"),(0,l.kt)("h3",{id:"_addsdkversion"},"_","addSDKVersion"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","addSDKVersion"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_addsdkversion"},"_addSDKVersion")),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L175"},"types/election/election.ts:175")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_census"},"_","census"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","census"),": ",(0,l.kt)("a",{parentName:"p",href:"Census"},(0,l.kt)("inlineCode",{parentName:"a"},"Census"))),(0,l.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_census"},"_census")),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L172"},"types/election/election.ts:172")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_description"},"_","description"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","description"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_description"},"_description")),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L163"},"types/election/election.ts:163")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_electiontype"},"_","electionType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","electionType"),": ",(0,l.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,l.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,l.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_electiontype"},"_electionType")),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L169"},"types/election/election.ts:169")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_enddate"},"_","endDate"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","endDate"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_enddate"},"_endDate")),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L168"},"types/election/election.ts:168")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_header"},"_","header"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","header"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_header"},"_header")),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L164"},"types/election/election.ts:164")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_maxcensussize"},"_","maxCensusSize"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","maxCensusSize"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_maxcensussize"},"_maxCensusSize")),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L173"},"types/election/election.ts:173")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_meta"},"_","meta"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","meta"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_meta"},"_meta")),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L166"},"types/election/election.ts:166")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_questions"},"_","questions"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","questions"),": ",(0,l.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,l.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,l.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_questions"},"_questions")),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L171"},"types/election/election.ts:171")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_startdate"},"_","startDate"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","startDate"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_startdate"},"_startDate")),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L167"},"types/election/election.ts:167")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_streamuri"},"_","streamUri"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","streamUri"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_streamuri"},"_streamUri")),(0,l.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L165"},"types/election/election.ts:165")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_temporarysecretidentity"},"_","temporarySecretIdentity"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","temporarySecretIdentity"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_temporarysecretidentity"},"_temporarySecretIdentity")),(0,l.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L174"},"types/election/election.ts:174")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_title"},"_","title"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","title"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_title"},"_title")),(0,l.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L162"},"types/election/election.ts:162")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_votetype"},"_","voteType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","voteType"),": ",(0,l.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,l.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,l.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#_votetype"},"_voteType")),(0,l.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L170"},"types/election/election.ts:170")),(0,l.kt)("h2",{id:"accessors-1"},"Accessors"),(0,l.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"addSDKVersion"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-1"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.addSDKVersion"),(0,l.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L262"},"types/election/election.ts:262")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"census"},"census"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"census"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"ArchivedCensus")),(0,l.kt)("h4",{id:"returns-2"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"ArchivedCensus")),(0,l.kt)("h4",{id:"overrides-1"},"Overrides"),(0,l.kt)("p",null,"PublishedElection.census"),(0,l.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/archived.ts#L17"},"types/election/archived.ts:17")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"chainid"},"chainId"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"chainId"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-3"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.chainId"),(0,l.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L219"},"types/election/published.ts:219")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"creationtime"},"creationTime"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"creationTime"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"returns-4"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.creationTime"),(0,l.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L223"},"types/election/published.ts:223")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"description"},"description"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"description"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"returns-5"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.description"),(0,l.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L147"},"types/election/published.ts:147")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"electiontype"},"electionType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"electionType"),"(): ",(0,l.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,l.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,l.kt)("h4",{id:"returns-6"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,l.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,l.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.electionType"),(0,l.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L167"},"types/election/published.ts:167")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"enddate"},"endDate"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"endDate"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"returns-7"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.endDate"),(0,l.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L163"},"types/election/published.ts:163")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"finalresults"},"finalResults"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"finalResults"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-8"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.finalResults"),(0,l.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L203"},"types/election/published.ts:203")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"fromarchive"},"fromArchive"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"fromArchive"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-9"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from-21"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.fromArchive"),(0,l.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L215"},"types/election/published.ts:215")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"header"},"header"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"header"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-10"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"inherited-from-22"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.header"),(0,l.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L151"},"types/election/published.ts:151")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"id"},"id"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"id"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-11"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"inherited-from-23"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.id"),(0,l.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L187"},"types/election/published.ts:187")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isvalid"},"isValid"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"isValid"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-12"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from-24"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.isValid"),(0,l.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L239"},"types/election/published.ts:239")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"manuallyended"},"manuallyEnded"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"manuallyEnded"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-13"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from-25"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.manuallyEnded"),(0,l.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L211"},"types/election/published.ts:211")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"maxCensusSize"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"returns-14"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"inherited-from-26"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.maxCensusSize"),(0,l.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L183"},"types/election/published.ts:183")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"meta"},"meta"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"meta"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("h4",{id:"returns-15"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("h4",{id:"inherited-from-27"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.meta"),(0,l.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L226"},"types/election/election.ts:226")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"metadataurl"},"metadataURL"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"metadataURL"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-16"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"inherited-from-28"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.metadataURL"),(0,l.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L227"},"types/election/published.ts:227")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"organizationid"},"organizationId"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"organizationId"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-17"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"inherited-from-29"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.organizationId"),(0,l.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L191"},"types/election/published.ts:191")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"questions"},"questions"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"questions"),"(): ",(0,l.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,l.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,l.kt)("h4",{id:"returns-18"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,l.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,l.kt)("h4",{id:"inherited-from-30"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.questions"),(0,l.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L175"},"types/election/published.ts:175")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"raw"},"raw"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"raw"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"object")),(0,l.kt)("h4",{id:"returns-19"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"object")),(0,l.kt)("h4",{id:"inherited-from-31"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.raw"),(0,l.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L235"},"types/election/published.ts:235")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"results"},"results"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"results"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string"),"[][]"),(0,l.kt)("h4",{id:"returns-20"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string"),"[][]"),(0,l.kt)("h4",{id:"inherited-from-32"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.results"),(0,l.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L207"},"types/election/published.ts:207")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"resultstype"},"resultsType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"resultsType"),"(): ",(0,l.kt)("a",{parentName:"p",href:"../modules#electionresultstype"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionResultsType"))),(0,l.kt)("h4",{id:"returns-21"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"../modules#electionresultstype"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionResultsType"))),(0,l.kt)("h4",{id:"inherited-from-33"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.resultsType"),(0,l.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L231"},"types/election/published.ts:231")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"startdate"},"startDate"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"startDate"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"returns-22"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"inherited-from-34"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.startDate"),(0,l.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L159"},"types/election/published.ts:159")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"status"},"status"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"status"),"(): ",(0,l.kt)("a",{parentName:"p",href:"../enums/ElectionStatus"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,l.kt)("h4",{id:"returns-23"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"../enums/ElectionStatus"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,l.kt)("h4",{id:"inherited-from-35"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.status"),(0,l.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L195"},"types/election/published.ts:195")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"streamuri"},"streamUri"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"streamUri"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-24"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"inherited-from-36"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.streamUri"),(0,l.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L155"},"types/election/published.ts:155")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-25"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from-37"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.temporarySecretIdentity"),(0,l.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L258"},"types/election/election.ts:258")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"title"},"title"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"title"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"returns-26"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"inherited-from-38"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.title"),(0,l.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L143"},"types/election/published.ts:143")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"votecount"},"voteCount"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"voteCount"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"returns-27"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"inherited-from-39"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.voteCount"),(0,l.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L199"},"types/election/published.ts:199")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"votetype"},"voteType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"voteType"),"(): ",(0,l.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,l.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,l.kt)("h4",{id:"returns-28"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,l.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,l.kt)("h4",{id:"inherited-from-40"},"Inherited from"),(0,l.kt)("p",null,"PublishedElection.voteType"),(0,l.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L171"},"types/election/published.ts:171")),(0,l.kt)("h2",{id:"methods-1"},"Methods"),(0,l.kt)("h3",{id:"checkvote"},"checkVote"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"checkVote"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"vote"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"parameters-1"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"vote")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"Vote"},(0,l.kt)("inlineCode",{parentName:"a"},"Vote")))))),(0,l.kt)("h4",{id:"returns-29"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"inherited-from-41"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"PublishedElection#checkvote"},"checkVote")),(0,l.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L113"},"types/election/published.ts:113")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"get"},"get"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"get"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"dot"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("h4",{id:"parameters-2"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"dot")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))))),(0,l.kt)("h4",{id:"returns-30"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("h4",{id:"inherited-from-42"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"PublishedElection#get"},"get")),(0,l.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L266"},"types/election/election.ts:266")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"build"},"build"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"build"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"PublishedElection"))),(0,l.kt)("p",null,"Returns a published election object"),(0,l.kt)("h4",{id:"parameters-3"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"params")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"../interfaces/IPublishedElectionParameters"},(0,l.kt)("inlineCode",{parentName:"a"},"IPublishedElectionParameters"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Published election parameters")))),(0,l.kt)("h4",{id:"returns-31"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"PublishedElection"))),(0,l.kt)("h4",{id:"inherited-from-43"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"PublishedElection#build"},"build")),(0,l.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L100"},"types/election/published.ts:100")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"checkvote-1"},"checkVote"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"checkVote"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"vote"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"voteType"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"parameters-4"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"vote")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"Vote"},(0,l.kt)("inlineCode",{parentName:"a"},"Vote")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"voteType")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"../interfaces/IVoteType"},(0,l.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,l.kt)("h4",{id:"returns-32"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"inherited-from-44"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection#checkvote-1"},"checkVote")),(0,l.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L127"},"types/election/published.ts:127")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"from"},"from"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"from"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,l.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,l.kt)("p",null,"Returns an unpublished election object"),(0,l.kt)("h4",{id:"parameters-5"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"params")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"../interfaces/IElectionParameters"},(0,l.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Unpublished Election parameters")))),(0,l.kt)("h4",{id:"returns-33"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,l.kt)("h4",{id:"inherited-from-45"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"PublishedElection#from"},"from")),(0,l.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L206"},"types/election/election.ts:206")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getstatus"},"getStatus"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"getStatus"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"status"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"startDate"),"): ",(0,l.kt)("a",{parentName:"p",href:"../enums/ElectionStatus"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,l.kt)("h4",{id:"parameters-6"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"status")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"../modules#allelectionstatus"},(0,l.kt)("inlineCode",{parentName:"a"},"AllElectionStatus")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"startDate")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,l.kt)("h4",{id:"returns-34"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"../enums/ElectionStatus"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,l.kt)("h4",{id:"inherited-from-46"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},"PublishedElection"),".",(0,l.kt)("a",{parentName:"p",href:"PublishedElection#getstatus"},"getStatus")),(0,l.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L104"},"types/election/published.ts:104")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ac57e32f.1b2a2136.js b/assets/js/ac57e32f.1b2a2136.js new file mode 100644 index 000000000..9362aec3b --- /dev/null +++ b/assets/js/ac57e32f.1b2a2136.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[848],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>f});var r=t(67294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function a(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var l=r.createContext({}),p=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},d=function(e){var n=p(e.components);return r.createElement(l.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},u=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,o=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=p(t),f=i,m=u["".concat(l,".").concat(f)]||u[f]||c[f]||o;return t?r.createElement(m,a(a({ref:n},d),{},{components:t})):r.createElement(m,a({ref:n},d))}));function f(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var o=t.length,a=new Array(o);a[0]=u;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s.mdxType="string"==typeof e?e:i,a[1]=s;for(var p=2;p{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>c,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var r=t(87462),i=(t(67294),t(3905));const o={},a=void 0,s={unversionedId:"sdk/reference/enums/CspProofType",id:"sdk/reference/enums/CspProofType",title:"CspProofType",description:"@vocdoni/sdk / Exports / CspProofType",source:"@site/docs/sdk/reference/enums/CspProofType.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/CspProofType",permalink:"/sdk/reference/enums/CspProofType",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CensusTypeEnum",permalink:"/sdk/reference/enums/CensusTypeEnum"},next:{title:"ElectionCreationSteps",permalink:"/sdk/reference/enums/ElectionCreationSteps"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"ECDSA",id:"ecdsa",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ECDSA_BLIND",id:"ecdsa_blind",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ECDSA_BLIND_PIDSALTED",id:"ecdsa_blind_pidsalted",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"ECDSA_PIDSALTED",id:"ecdsa_pidsalted",level:3},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:p};function c(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / CspProofType"),(0,i.kt)("h1",{id:"enumeration-cspprooftype"},"Enumeration: CspProofType"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"CspProofType#ecdsa"},"ECDSA")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CspProofType#ecdsa_blind"},"ECDSA","_","BLIND")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CspProofType#ecdsa_blind_pidsalted"},"ECDSA","_","BLIND","_","PIDSALTED")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CspProofType#ecdsa_pidsalted"},"ECDSA","_","PIDSALTED"))),(0,i.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,i.kt)("h3",{id:"ecdsa"},"ECDSA"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ECDSA")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"1")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/csp.ts#L15"},"services/csp.ts:15")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ecdsa_blind"},"ECDSA","_","BLIND"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ECDSA","_","BLIND")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"3")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/csp.ts#L17"},"services/csp.ts:17")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ecdsa_blind_pidsalted"},"ECDSA","_","BLIND","_","PIDSALTED"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ECDSA","_","BLIND","_","PIDSALTED")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"4")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/csp.ts#L18"},"services/csp.ts:18")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ecdsa_pidsalted"},"ECDSA","_","PIDSALTED"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ECDSA","_","PIDSALTED")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"2")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/csp.ts#L16"},"services/csp.ts:16")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ac57e32f.7fd05cb8.js b/assets/js/ac57e32f.7fd05cb8.js deleted file mode 100644 index bb49da09f..000000000 --- a/assets/js/ac57e32f.7fd05cb8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[848],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>f});var r=t(67294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function a(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var l=r.createContext({}),p=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},c=function(e){var n=p(e.components);return r.createElement(l.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},u=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,o=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),u=p(t),f=i,m=u["".concat(l,".").concat(f)]||u[f]||d[f]||o;return t?r.createElement(m,a(a({ref:n},c),{},{components:t})):r.createElement(m,a({ref:n},c))}));function f(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var o=t.length,a=new Array(o);a[0]=u;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s.mdxType="string"==typeof e?e:i,a[1]=s;for(var p=2;p{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var r=t(87462),i=(t(67294),t(3905));const o={},a=void 0,s={unversionedId:"sdk/reference/enums/CspProofType",id:"sdk/reference/enums/CspProofType",title:"CspProofType",description:"@vocdoni/sdk / Exports / CspProofType",source:"@site/docs/sdk/reference/enums/CspProofType.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/CspProofType",permalink:"/sdk/reference/enums/CspProofType",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CensusTypeEnum",permalink:"/sdk/reference/enums/CensusTypeEnum"},next:{title:"ElectionCreationSteps",permalink:"/sdk/reference/enums/ElectionCreationSteps"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"ECDSA",id:"ecdsa",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ECDSA_BLIND",id:"ecdsa_blind",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ECDSA_BLIND_PIDSALTED",id:"ecdsa_blind_pidsalted",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"ECDSA_PIDSALTED",id:"ecdsa_pidsalted",level:3},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:p};function d(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / CspProofType"),(0,i.kt)("h1",{id:"enumeration-cspprooftype"},"Enumeration: CspProofType"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CspProofType#ecdsa"},"ECDSA")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CspProofType#ecdsa_blind"},"ECDSA","_","BLIND")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CspProofType#ecdsa_blind_pidsalted"},"ECDSA","_","BLIND","_","PIDSALTED")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CspProofType#ecdsa_pidsalted"},"ECDSA","_","PIDSALTED"))),(0,i.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,i.kt)("h3",{id:"ecdsa"},"ECDSA"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ECDSA")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"1")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/csp.ts#L15"},"services/csp.ts:15")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ecdsa_blind"},"ECDSA","_","BLIND"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ECDSA","_","BLIND")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"3")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/csp.ts#L17"},"services/csp.ts:17")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ecdsa_blind_pidsalted"},"ECDSA","_","BLIND","_","PIDSALTED"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ECDSA","_","BLIND","_","PIDSALTED")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"4")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/csp.ts#L18"},"services/csp.ts:18")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ecdsa_pidsalted"},"ECDSA","_","PIDSALTED"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ECDSA","_","PIDSALTED")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"2")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/csp.ts#L16"},"services/csp.ts:16")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ace89945.73222deb.js b/assets/js/ace89945.73222deb.js deleted file mode 100644 index 35250a0a0..000000000 --- a/assets/js/ace89945.73222deb.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7612],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>f});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=a.createContext({}),p=function(e){var t=a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return a.createElement(c.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,c=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=p(n),f=r,k=u["".concat(c,".").concat(f)]||u[f]||s[f]||i;return n?a.createElement(k,o(o({ref:t},d),{},{components:n})):a.createElement(k,o({ref:t},d))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,o=new Array(i);o[0]=u;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l.mdxType="string"==typeof e?e:r,o[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var a=n(87462),r=(n(67294),n(3905));const i={},o=void 0,l={unversionedId:"sdk/reference/interfaces/IAccount",id:"sdk/reference/interfaces/IAccount",title:"IAccount",description:"@vocdoni/sdk / Exports / IAccount",source:"@site/docs/sdk/reference/interfaces/IAccount.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IAccount",permalink:"/sdk/reference/interfaces/IAccount",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"FetchElectionsParameters",permalink:"/sdk/reference/interfaces/FetchElectionsParameters"},next:{title:"IAccountTransfersCountResponse",permalink:"/sdk/reference/interfaces/IAccountTransfersCountResponse"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"avatar",id:"avatar",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"feed",id:"feed",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"header",id:"header",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"languages",id:"languages",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"logo",id:"logo",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:p};function s(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IAccount"),(0,r.kt)("h1",{id:"interface-iaccount"},"Interface: IAccount"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IAccount#avatar"},"avatar")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IAccount#description"},"description")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IAccount#feed"},"feed")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IAccount#header"},"header")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IAccount#languages"},"languages")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IAccount#logo"},"logo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IAccount#meta"},"meta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IAccount#name"},"name"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"avatar"},"avatar"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"avatar"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L11"},"types/account.ts:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L8"},"types/account.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"feed"},"feed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"feed"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L9"},"types/account.ts:9")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"header"},"header"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"header"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L10"},"types/account.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"languages"},"languages"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"languages"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"languages: array of languages used by account"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L6"},"types/account.ts:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"logo"},"logo"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"logo"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L12"},"types/account.ts:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"value"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }[]"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L13"},"types/account.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/account.ts#L7"},"types/account.ts:7")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ace89945.9c4c5054.js b/assets/js/ace89945.9c4c5054.js new file mode 100644 index 000000000..a034a0ced --- /dev/null +++ b/assets/js/ace89945.9c4c5054.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7612],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),c=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=c(n),k=r,f=u["".concat(p,".").concat(k)]||u[k]||s[k]||i;return n?a.createElement(f,o(o({ref:t},d),{},{components:n})):a.createElement(f,o({ref:t},d))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,o=new Array(i);o[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:r,o[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=n(87462),r=(n(67294),n(3905));const i={},o=void 0,l={unversionedId:"sdk/reference/interfaces/IAccount",id:"sdk/reference/interfaces/IAccount",title:"IAccount",description:"@vocdoni/sdk / Exports / IAccount",source:"@site/docs/sdk/reference/interfaces/IAccount.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IAccount",permalink:"/sdk/reference/interfaces/IAccount",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"FetchElectionsParameters",permalink:"/sdk/reference/interfaces/FetchElectionsParameters"},next:{title:"IAccountTransfersCountResponse",permalink:"/sdk/reference/interfaces/IAccountTransfersCountResponse"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"avatar",id:"avatar",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"feed",id:"feed",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"header",id:"header",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"languages",id:"languages",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"logo",id:"logo",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IAccount"),(0,r.kt)("h1",{id:"interface-iaccount"},"Interface: IAccount"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IAccount#avatar"},"avatar")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IAccount#description"},"description")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IAccount#feed"},"feed")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IAccount#header"},"header")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IAccount#languages"},"languages")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IAccount#logo"},"logo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IAccount#meta"},"meta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IAccount#name"},"name"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"avatar"},"avatar"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"avatar"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L10"},"types/account.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L7"},"types/account.ts:7")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"feed"},"feed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"feed"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L8"},"types/account.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"header"},"header"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"header"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L9"},"types/account.ts:9")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"languages"},"languages"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"languages"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L5"},"types/account.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"logo"},"logo"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"logo"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L11"},"types/account.ts:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"value"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }[]"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L12"},"types/account.ts:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L6"},"types/account.ts:6")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ad99c2e7.2541db2d.js b/assets/js/ad99c2e7.2541db2d.js deleted file mode 100644 index 0eb480f8e..000000000 --- a/assets/js/ad99c2e7.2541db2d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4600],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>u});var i=t(67294);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function p(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var c=i.createContext({}),o=function(e){var n=i.useContext(c),t=n;return e&&(t="function"==typeof e?e(n):p(p({},n),e)),t},d=function(e){var n=o(e.components);return i.createElement(c.Provider,{value:n},e.children)},s={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},k=i.forwardRef((function(e,n){var t=e.components,r=e.mdxType,a=e.originalType,c=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),k=o(t),u=r,f=k["".concat(c,".").concat(u)]||k[u]||s[u]||a;return t?i.createElement(f,p(p({ref:n},d),{},{components:t})):i.createElement(f,p({ref:n},d))}));function u(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var a=t.length,p=new Array(a);p[0]=k;var l={};for(var c in n)hasOwnProperty.call(n,c)&&(l[c]=n[c]);l.originalType=e,l.mdxType="string"==typeof e?e:r,p[1]=l;for(var o=2;o{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>p,default:()=>s,frontMatter:()=>a,metadata:()=>l,toc:()=>o});var i=t(87462),r=(t(67294),t(3905));const a={},p=void 0,l={unversionedId:"sdk/reference/interfaces/AdminTx",id:"sdk/reference/interfaces/AdminTx",title:"AdminTx",description:"@vocdoni/sdk / Exports / AdminTx",source:"@site/docs/sdk/reference/interfaces/AdminTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/AdminTx",permalink:"/sdk/reference/interfaces/AdminTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"AccountMetadata",permalink:"/sdk/reference/interfaces/AccountMetadata"},next:{title:"CircuitInputs",permalink:"/sdk/reference/interfaces/CircuitInputs"}},c={},o=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"address",id:"address",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"encryptionPrivateKey",id:"encryptionprivatekey",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"encryptionPublicKey",id:"encryptionpublickey",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"keyIndex",id:"keyindex",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"power",id:"power",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"processId",id:"processid",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"publicKey",id:"publickey",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"txtype",id:"txtype",level:3},{value:"Defined in",id:"defined-in-8",level:4}],d={toc:o};function s(e){let{components:n,...t}=e;return(0,r.kt)("wrapper",(0,i.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / AdminTx"),(0,r.kt)("h1",{id:"interface-admintx"},"Interface: AdminTx"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AdminTx#address"},"address")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AdminTx#encryptionprivatekey"},"encryptionPrivateKey")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AdminTx#encryptionpublickey"},"encryptionPublicKey")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AdminTx#keyindex"},"keyIndex")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AdminTx#nonce"},"nonce")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AdminTx#power"},"power")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AdminTx#processid"},"processId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AdminTx#publickey"},"publicKey")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AdminTx#txtype"},"txtype"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"address"},"address"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"address"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L92"},"api/chain/transactions.ts:92")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"encryptionprivatekey"},"encryptionPrivateKey"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"encryptionPrivateKey"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L93"},"api/chain/transactions.ts:93")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"encryptionpublickey"},"encryptionPublicKey"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"encryptionPublicKey"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L94"},"api/chain/transactions.ts:94")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"keyindex"},"keyIndex"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"keyIndex"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L95"},"api/chain/transactions.ts:95")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"nonce"},"nonce"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"nonce"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L98"},"api/chain/transactions.ts:98")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"power"},"power"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"power"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L96"},"api/chain/transactions.ts:96")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"processid"},"processId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"processId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L91"},"api/chain/transactions.ts:91")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"publickey"},"publicKey"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"publicKey"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L97"},"api/chain/transactions.ts:97")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"txtype"},"txtype"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"txtype"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/TxType"},(0,r.kt)("inlineCode",{parentName:"a"},"TxType"))),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L90"},"api/chain/transactions.ts:90")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ad99c2e7.e38b45d2.js b/assets/js/ad99c2e7.e38b45d2.js new file mode 100644 index 000000000..93f8b12f9 --- /dev/null +++ b/assets/js/ad99c2e7.e38b45d2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4600],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>u});var i=t(67294);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function p(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var o=i.createContext({}),d=function(e){var n=i.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):p(p({},n),e)),t},c=function(e){var n=d(e.components);return i.createElement(o.Provider,{value:n},e.children)},s={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},k=i.forwardRef((function(e,n){var t=e.components,r=e.mdxType,a=e.originalType,o=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),k=d(t),u=r,f=k["".concat(o,".").concat(u)]||k[u]||s[u]||a;return t?i.createElement(f,p(p({ref:n},c),{},{components:t})):i.createElement(f,p({ref:n},c))}));function u(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var a=t.length,p=new Array(a);p[0]=k;var l={};for(var o in n)hasOwnProperty.call(n,o)&&(l[o]=n[o]);l.originalType=e,l.mdxType="string"==typeof e?e:r,p[1]=l;for(var d=2;d{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>p,default:()=>s,frontMatter:()=>a,metadata:()=>l,toc:()=>d});var i=t(87462),r=(t(67294),t(3905));const a={},p=void 0,l={unversionedId:"sdk/reference/interfaces/AdminTx",id:"sdk/reference/interfaces/AdminTx",title:"AdminTx",description:"@vocdoni/sdk / Exports / AdminTx",source:"@site/docs/sdk/reference/interfaces/AdminTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/AdminTx",permalink:"/sdk/reference/interfaces/AdminTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"AccountMetadata",permalink:"/sdk/reference/interfaces/AccountMetadata"},next:{title:"CircuitInputs",permalink:"/sdk/reference/interfaces/CircuitInputs"}},o={},d=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"address",id:"address",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"encryptionPrivateKey",id:"encryptionprivatekey",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"encryptionPublicKey",id:"encryptionpublickey",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"keyIndex",id:"keyindex",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"power",id:"power",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"processId",id:"processid",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"publicKey",id:"publickey",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"txtype",id:"txtype",level:3},{value:"Defined in",id:"defined-in-8",level:4}],c={toc:d};function s(e){let{components:n,...t}=e;return(0,r.kt)("wrapper",(0,i.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / AdminTx"),(0,r.kt)("h1",{id:"interface-admintx"},"Interface: AdminTx"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AdminTx#address"},"address")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AdminTx#encryptionprivatekey"},"encryptionPrivateKey")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AdminTx#encryptionpublickey"},"encryptionPublicKey")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AdminTx#keyindex"},"keyIndex")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AdminTx#nonce"},"nonce")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AdminTx#power"},"power")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AdminTx#processid"},"processId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AdminTx#publickey"},"publicKey")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AdminTx#txtype"},"txtype"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"address"},"address"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"address"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L92"},"api/chain/transactions.ts:92")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"encryptionprivatekey"},"encryptionPrivateKey"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"encryptionPrivateKey"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L93"},"api/chain/transactions.ts:93")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"encryptionpublickey"},"encryptionPublicKey"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"encryptionPublicKey"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L94"},"api/chain/transactions.ts:94")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"keyindex"},"keyIndex"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"keyIndex"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L95"},"api/chain/transactions.ts:95")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"nonce"},"nonce"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"nonce"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L98"},"api/chain/transactions.ts:98")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"power"},"power"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"power"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L96"},"api/chain/transactions.ts:96")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"processid"},"processId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"processId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L91"},"api/chain/transactions.ts:91")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"publickey"},"publicKey"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"publicKey"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L97"},"api/chain/transactions.ts:97")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"txtype"},"txtype"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"txtype"),": ",(0,r.kt)("a",{parentName:"p",href:"../enums/TxType"},(0,r.kt)("inlineCode",{parentName:"a"},"TxType"))),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L90"},"api/chain/transactions.ts:90")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ae74964d.5112960a.js b/assets/js/ae74964d.5112960a.js new file mode 100644 index 000000000..a44852206 --- /dev/null +++ b/assets/js/ae74964d.5112960a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[297],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function p(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var o=r.createContext({}),s=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},d=function(e){var t=s(e.components);return r.createElement(o.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=s(n),m=a,c=u["".concat(o,".").concat(m)]||u[m]||k[m]||i;return n?r.createElement(c,p(p({ref:t},d),{},{components:n})):r.createElement(c,p({ref:t},d))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,p=new Array(i);p[0]=u;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l.mdxType="string"==typeof e?e:a,p[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>k,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=n(87462),a=(n(67294),n(3905));const i={},p=void 0,l={unversionedId:"sdk/reference/classes/CspVote",id:"sdk/reference/classes/CspVote",title:"CspVote",description:"@vocdoni/sdk / Exports / CspVote",source:"@site/docs/sdk/reference/classes/CspVote.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/CspVote",permalink:"/sdk/reference/classes/CspVote",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CspService",permalink:"/sdk/reference/classes/CspService"},next:{title:"Election",permalink:"/sdk/reference/classes/Election"}},o={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_proof_type",id:"_proof_type",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"_signature",id:"_signature",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"proof_type",id:"proof_type",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"signature",id:"signature",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"votes",id:"votes",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-8",level:4}],d={toc:s};function k(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / CspVote"),(0,a.kt)("h1",{id:"class-cspvote"},"Class: CspVote"),(0,a.kt)("p",null,"Represents a vote"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"CspVote"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"CspVote#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspVote#_proof_type"},"_","proof","_","type")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspVote#_signature"},"_","signature"))),(0,a.kt)("h3",{id:"accessors"},"Accessors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspVote#proof_type"},"proof","_","type")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"CspVote#signature"},"signature")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"CspVote#votes"},"votes"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new CspVote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"votes"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"proof_type?"),"): ",(0,a.kt)("a",{parentName:"p",href:"CspVote"},(0,a.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,a.kt)("p",null,"Constructs a csp vote"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"votes")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(",(0,a.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"bigint"),")[]"),(0,a.kt)("td",{parentName:"tr",align:"left"},"The list of votes values")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"signature")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The CSP signature")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"proof_type?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../enums/CspProofType"},(0,a.kt)("inlineCode",{parentName:"a"},"CspProofType"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"The CSP proof type")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"CspVote"},(0,a.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Vote"},"Vote"),".",(0,a.kt)("a",{parentName:"p",href:"Vote#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/csp.ts#L15"},"types/vote/csp.ts:15")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"_proof_type"},"_","proof","_","type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","proof","_","type"),": ",(0,a.kt)("a",{parentName:"p",href:"../enums/CspProofType"},(0,a.kt)("inlineCode",{parentName:"a"},"CspProofType"))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/csp.ts#L6"},"types/vote/csp.ts:6")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_signature"},"_","signature"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","signature"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/csp.ts#L5"},"types/vote/csp.ts:5")),(0,a.kt)("h2",{id:"accessors-1"},"Accessors"),(0,a.kt)("h3",{id:"proof_type"},"proof","_","type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"proof_type"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../enums/CspProofType"},(0,a.kt)("inlineCode",{parentName:"a"},"CspProofType"))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../enums/CspProofType"},(0,a.kt)("inlineCode",{parentName:"a"},"CspProofType"))),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/csp.ts#L29"},"types/vote/csp.ts:29")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"proof_type"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../enums/CspProofType"},(0,a.kt)("inlineCode",{parentName:"a"},"CspProofType")))))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/csp.ts#L33"},"types/vote/csp.ts:33")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"signature"},"signature"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"signature"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/csp.ts#L21"},"types/vote/csp.ts:21")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"signature"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/csp.ts#L25"},"types/vote/csp.ts:25")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votes"},"votes"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"votes"),"(): (",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint"),")[]"),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,"(",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint"),")[]"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Vote.votes"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/vote.ts#L16"},"types/vote/vote.ts:16")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"votes"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(",(0,a.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"bigint"),")[]")))),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Vote.votes"),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/vote.ts#L20"},"types/vote/vote.ts:20")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ae74964d.7384d12e.js b/assets/js/ae74964d.7384d12e.js deleted file mode 100644 index 4acd1408c..000000000 --- a/assets/js/ae74964d.7384d12e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[297],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>u});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function p(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var o=r.createContext({}),s=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},d=function(e){var t=s(e.components);return r.createElement(o.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),c=s(n),u=a,m=c["".concat(o,".").concat(u)]||c[u]||k[u]||i;return n?r.createElement(m,p(p({ref:t},d),{},{components:n})):r.createElement(m,p({ref:t},d))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,p=new Array(i);p[0]=c;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l.mdxType="string"==typeof e?e:a,p[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>k,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=n(87462),a=(n(67294),n(3905));const i={},p=void 0,l={unversionedId:"sdk/reference/classes/CspVote",id:"sdk/reference/classes/CspVote",title:"CspVote",description:"@vocdoni/sdk / Exports / CspVote",source:"@site/docs/sdk/reference/classes/CspVote.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/CspVote",permalink:"/sdk/reference/classes/CspVote",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CspService",permalink:"/sdk/reference/classes/CspService"},next:{title:"Election",permalink:"/sdk/reference/classes/Election"}},o={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_proof_type",id:"_proof_type",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"_signature",id:"_signature",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"proof_type",id:"proof_type",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"signature",id:"signature",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"votes",id:"votes",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-8",level:4}],d={toc:s};function k(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / CspVote"),(0,a.kt)("h1",{id:"class-cspvote"},"Class: CspVote"),(0,a.kt)("p",null,"Represents a vote"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"CspVote"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspVote#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspVote#_proof_type"},"_","proof","_","type")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspVote#_signature"},"_","signature"))),(0,a.kt)("h3",{id:"accessors"},"Accessors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspVote#proof_type"},"proof","_","type")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspVote#signature"},"signature")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspVote#votes"},"votes"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new CspVote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"votes"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"proof_type?"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CspVote"},(0,a.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,a.kt)("p",null,"Constructs a csp vote"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"votes")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(",(0,a.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"bigint"),")[]"),(0,a.kt)("td",{parentName:"tr",align:"left"},"The list of votes values")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"signature")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The CSP signature")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"proof_type?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CspProofType"},(0,a.kt)("inlineCode",{parentName:"a"},"CspProofType"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"The CSP proof type")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CspVote"},(0,a.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Vote"},"Vote"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Vote#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/csp.ts#L15"},"types/vote/csp.ts:15")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"_proof_type"},"_","proof","_","type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","proof","_","type"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CspProofType"},(0,a.kt)("inlineCode",{parentName:"a"},"CspProofType"))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/csp.ts#L6"},"types/vote/csp.ts:6")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_signature"},"_","signature"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","signature"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/csp.ts#L5"},"types/vote/csp.ts:5")),(0,a.kt)("h2",{id:"accessors-1"},"Accessors"),(0,a.kt)("h3",{id:"proof_type"},"proof","_","type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"proof_type"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CspProofType"},(0,a.kt)("inlineCode",{parentName:"a"},"CspProofType"))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CspProofType"},(0,a.kt)("inlineCode",{parentName:"a"},"CspProofType"))),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/csp.ts#L29"},"types/vote/csp.ts:29")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"proof_type"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CspProofType"},(0,a.kt)("inlineCode",{parentName:"a"},"CspProofType")))))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/csp.ts#L33"},"types/vote/csp.ts:33")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"signature"},"signature"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"signature"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/csp.ts#L21"},"types/vote/csp.ts:21")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"signature"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/csp.ts#L25"},"types/vote/csp.ts:25")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votes"},"votes"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"votes"),"(): (",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint"),")[]"),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,"(",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint"),")[]"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Vote.votes"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/vote.ts#L16"},"types/vote/vote.ts:16")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"votes"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(",(0,a.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"bigint"),")[]")))),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Vote.votes"),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/vote.ts#L20"},"types/vote/vote.ts:20")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ae785ce1.46772073.js b/assets/js/ae785ce1.46772073.js new file mode 100644 index 000000000..609d903a1 --- /dev/null +++ b/assets/js/ae785ce1.46772073.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3496],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var i=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=i.createContext({}),s=function(e){var t=i.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=s(e.components);return i.createElement(d.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},m=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,d=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),m=s(n),u=a,k=m["".concat(d,".").concat(u)]||m[u]||c[u]||r;return n?i.createElement(k,l(l({ref:t},p),{},{components:n})):i.createElement(k,l({ref:t},p))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,l=new Array(r);l[0]=m;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>r,metadata:()=>o,toc:()=>s});var i=n(87462),a=(n(67294),n(3905));const r={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IPublishedElectionParameters",id:"sdk/reference/interfaces/IPublishedElectionParameters",title:"IPublishedElectionParameters",description:"@vocdoni/sdk / Exports / IPublishedElectionParameters",source:"@site/docs/sdk/reference/interfaces/IPublishedElectionParameters.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IPublishedElectionParameters",permalink:"/sdk/reference/interfaces/IPublishedElectionParameters",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IMultiChoiceElectionParameters",permalink:"/sdk/reference/interfaces/IMultiChoiceElectionParameters"},next:{title:"IQuestion",permalink:"/sdk/reference/interfaces/IQuestion"}},d={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"census",id:"census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"chainId",id:"chainid",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"creationTime",id:"creationtime",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"endDate",id:"enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"finalResults",id:"finalresults",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"fromArchive",id:"fromarchive",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"header",id:"header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"manuallyEnded",id:"manuallyended",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"meta",id:"meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"metadataURL",id:"metadataurl",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"organizationId",id:"organizationid",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"questions",id:"questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"raw",id:"raw",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"results",id:"results",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"resultsType",id:"resultstype",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"startDate",id:"startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"voteCount",id:"votecount",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"voteType",id:"votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-26",level:4}],p={toc:s};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IPublishedElectionParameters"),(0,a.kt)("h1",{id:"interface-ipublishedelectionparameters"},"Interface: IPublishedElectionParameters"),(0,a.kt)("p",null,"Define election parameters."),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"IElectionParameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"IPublishedElectionParameters"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#addsdkversion"},"addSDKVersion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#census"},"census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#chainid"},"chainId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#creationtime"},"creationTime")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#description"},"description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#electiontype"},"electionType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#enddate"},"endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#finalresults"},"finalResults")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#fromarchive"},"fromArchive")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#header"},"header")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#id"},"id")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#manuallyended"},"manuallyEnded")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#maxcensussize"},"maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#meta"},"meta")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#metadataurl"},"metadataURL")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#organizationid"},"organizationId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#questions"},"questions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#raw"},"raw")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#results"},"results")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#resultstype"},"resultsType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#startdate"},"startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#status"},"status")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#streamuri"},"streamUri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#temporarysecretidentity"},"temporarySecretIdentity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#title"},"title")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#votecount"},"voteCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IPublishedElectionParameters#votetype"},"voteType"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"addSDKVersion"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"Used to add the SDK version to the election metadata"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,a.kt)("a",{parentName:"p",href:"IElectionParameters#addsdkversion"},"addSDKVersion")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L155"},"types/election/election.ts:155")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"census"},"census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"census"),": ",(0,a.kt)("a",{parentName:"p",href:"../classes/Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,a.kt)("a",{parentName:"p",href:"IElectionParameters#census"},"census")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L129"},"types/election/election.ts:129")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"chainid"},"chainId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"chainId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L35"},"types/election/published.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"creationtime"},"creationTime"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"creationTime"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L36"},"types/election/published.ts:36")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,"Election description"),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,a.kt)("a",{parentName:"p",href:"IElectionParameters#description"},"description")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L114"},"types/election/election.ts:114")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"electiontype"},"electionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"electionType"),": ",(0,a.kt)("a",{parentName:"p",href:"IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,a.kt)("a",{parentName:"p",href:"IElectionParameters#electiontype"},"electionType")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L131"},"types/election/election.ts:131")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enddate"},"endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"endDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,a.kt)("a",{parentName:"p",href:"IElectionParameters#enddate"},"endDate")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L128"},"types/election/election.ts:128")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"finalresults"},"finalResults"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"finalResults"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L31"},"types/election/published.ts:31")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"fromarchive"},"fromArchive"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"fromArchive"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L34"},"types/election/published.ts:34")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"header"},"header"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"header"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Election header image url."),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,a.kt)("a",{parentName:"p",href:"IElectionParameters#header"},"header")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L118"},"types/election/election.ts:118")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"id"},"id"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"id"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L27"},"types/election/published.ts:27")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"manuallyended"},"manuallyEnded"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"manuallyEnded"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L33"},"types/election/published.ts:33")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"Is used to limit the number of votes that can be registered for an election. This feature helps to prevent any\npotential overflow of the blockchain when the number of votes goes beyond the maximum limit."),(0,a.kt)("p",null,"In order to create an election, the creator is required to set the MaxCensusSize parameter to a proper value.\nTypically, this value should be equal to the size of the census. If the MaxCensusSize parameter is set to 0, an\nerror will occur and the election cannot be created."),(0,a.kt)("p",null,"If the number of votes exceeds this limit, will throw ",(0,a.kt)("inlineCode",{parentName:"p"},"Max census size for the election is greater than allowed\nsize")," error."),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,a.kt)("a",{parentName:"p",href:"IElectionParameters#maxcensussize"},"maxCensusSize")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L145"},"types/election/election.ts:145")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"meta"},"meta"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"meta"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("p",null,"Metadata (anything added by the election creator)"),(0,a.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,a.kt)("a",{parentName:"p",href:"IElectionParameters#meta"},"meta")),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L126"},"types/election/election.ts:126")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"metadataurl"},"metadataURL"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"metadataURL"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L37"},"types/election/published.ts:37")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"organizationid"},"organizationId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"organizationId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L28"},"types/election/published.ts:28")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"questions"},"questions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"questions"),": ",(0,a.kt)("a",{parentName:"p",href:"IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,a.kt)("a",{parentName:"p",href:"IElectionParameters#questions"},"questions")),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L132"},"types/election/election.ts:132")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"raw"},"raw"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"raw"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L39"},"types/election/published.ts:39")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"results"},"results"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"results"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[][]"),(0,a.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L32"},"types/election/published.ts:32")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"resultstype"},"resultsType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"resultsType"),": ",(0,a.kt)("a",{parentName:"p",href:"../modules#electionresultstype"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionResultsType"))),(0,a.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L38"},"types/election/published.ts:38")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"startdate"},"startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"startDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,a.kt)("a",{parentName:"p",href:"IElectionParameters#startdate"},"startDate")),(0,a.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L127"},"types/election/election.ts:127")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"status"},"status"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"status"),": ",(0,a.kt)("a",{parentName:"p",href:"../modules#allelectionstatus"},(0,a.kt)("inlineCode",{parentName:"a"},"AllElectionStatus"))),(0,a.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L29"},"types/election/published.ts:29")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"streamuri"},"streamUri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"streamUri"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Election stream Uri (ex: a video url)"),(0,a.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,a.kt)("a",{parentName:"p",href:"IElectionParameters#streamuri"},"streamUri")),(0,a.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L122"},"types/election/election.ts:122")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"Is used to remove the secret identities of the voters once the process is done."),(0,a.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,a.kt)("a",{parentName:"p",href:"IElectionParameters#temporarysecretidentity"},"temporarySecretIdentity")),(0,a.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L150"},"types/election/election.ts:150")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"title"},"title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"title"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,"Election title"),(0,a.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,a.kt)("a",{parentName:"p",href:"IElectionParameters#title"},"title")),(0,a.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L110"},"types/election/election.ts:110")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votecount"},"voteCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"voteCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L30"},"types/election/published.ts:30")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votetype"},"voteType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"voteType"),": ",(0,a.kt)("a",{parentName:"p",href:"IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,a.kt)("a",{parentName:"p",href:"IElectionParameters#votetype"},"voteType")),(0,a.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L130"},"types/election/election.ts:130")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ae785ce1.d5a5a0d6.js b/assets/js/ae785ce1.d5a5a0d6.js deleted file mode 100644 index 189aa8ab9..000000000 --- a/assets/js/ae785ce1.d5a5a0d6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3496],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var i=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=i.createContext({}),o=function(e){var t=i.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=o(e.components);return i.createElement(d.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,d=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),k=o(n),m=r,u=k["".concat(d,".").concat(m)]||k[m]||c[m]||a;return n?i.createElement(u,l(l({ref:t},p),{},{components:n})):i.createElement(u,l({ref:t},p))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,l=new Array(a);l[0]=k;var s={};for(var d in t)hasOwnProperty.call(t,d)&&(s[d]=t[d]);s.originalType=e,s.mdxType="string"==typeof e?e:r,l[1]=s;for(var o=2;o{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>a,metadata:()=>s,toc:()=>o});var i=n(87462),r=(n(67294),n(3905));const a={},l=void 0,s={unversionedId:"sdk/reference/interfaces/IPublishedElectionParameters",id:"sdk/reference/interfaces/IPublishedElectionParameters",title:"IPublishedElectionParameters",description:"@vocdoni/sdk / Exports / IPublishedElectionParameters",source:"@site/docs/sdk/reference/interfaces/IPublishedElectionParameters.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IPublishedElectionParameters",permalink:"/sdk/reference/interfaces/IPublishedElectionParameters",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IMultiChoiceElectionParameters",permalink:"/sdk/reference/interfaces/IMultiChoiceElectionParameters"},next:{title:"IQuestion",permalink:"/sdk/reference/interfaces/IQuestion"}},d={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"census",id:"census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"chainId",id:"chainid",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"creationTime",id:"creationtime",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"endDate",id:"enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"finalResults",id:"finalresults",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"fromArchive",id:"fromarchive",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"header",id:"header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"manuallyEnded",id:"manuallyended",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"meta",id:"meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"metadataURL",id:"metadataurl",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"organizationId",id:"organizationid",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"questions",id:"questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"raw",id:"raw",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"results",id:"results",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"resultsType",id:"resultstype",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"startDate",id:"startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"voteCount",id:"votecount",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"voteType",id:"votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-26",level:4}],p={toc:o};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,i.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IPublishedElectionParameters"),(0,r.kt)("h1",{id:"interface-ipublishedelectionparameters"},"Interface: IPublishedElectionParameters"),(0,r.kt)("p",null,"Define election parameters."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IPublishedElectionParameters"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#addsdkversion"},"addSDKVersion")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#census"},"census")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#chainid"},"chainId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#creationtime"},"creationTime")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#description"},"description")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#electiontype"},"electionType")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#enddate"},"endDate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#finalresults"},"finalResults")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#fromarchive"},"fromArchive")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#header"},"header")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#id"},"id")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#manuallyended"},"manuallyEnded")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#maxcensussize"},"maxCensusSize")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#meta"},"meta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#metadataurl"},"metadataURL")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#organizationid"},"organizationId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#questions"},"questions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#raw"},"raw")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#results"},"results")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#resultstype"},"resultsType")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#startdate"},"startDate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#status"},"status")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#streamuri"},"streamUri")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#temporarysecretidentity"},"temporarySecretIdentity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#title"},"title")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#votecount"},"voteCount")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IPublishedElectionParameters#votetype"},"voteType"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"addSDKVersion"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Used to add the SDK version to the election metadata"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#addsdkversion"},"addSDKVersion")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L155"},"types/election/election.ts:155")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"census"},"census"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"census"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,r.kt)("inlineCode",{parentName:"a"},"Census"))),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#census"},"census")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L129"},"types/election/election.ts:129")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"chainid"},"chainId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"chainId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L35"},"types/election/published.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"creationtime"},"creationTime"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"creationTime"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L36"},"types/election/published.ts:36")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Election description"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#description"},"description")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L114"},"types/election/election.ts:114")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electiontype"},"electionType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"electionType"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#electiontype"},"electionType")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L131"},"types/election/election.ts:131")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"enddate"},"endDate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"endDate"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#enddate"},"endDate")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L128"},"types/election/election.ts:128")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"finalresults"},"finalResults"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"finalResults"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L31"},"types/election/published.ts:31")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fromarchive"},"fromArchive"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"fromArchive"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L34"},"types/election/published.ts:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"header"},"header"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"header"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Election header image url."),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#header"},"header")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L118"},"types/election/election.ts:118")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L27"},"types/election/published.ts:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"manuallyended"},"manuallyEnded"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"manuallyEnded"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L33"},"types/election/published.ts:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Is used to limit the number of votes that can be registered for an election. This feature helps to prevent any\npotential overflow of the blockchain when the number of votes goes beyond the maximum limit."),(0,r.kt)("p",null,"In order to create an election, the creator is required to set the MaxCensusSize parameter to a proper value.\nTypically, this value should be equal to the size of the census. If the MaxCensusSize parameter is set to 0, an\nerror will occur and the election cannot be created."),(0,r.kt)("p",null,"If the number of votes exceeds this limit, will throw ",(0,r.kt)("inlineCode",{parentName:"p"},"Max census size for the election is greater than allowed\nsize")," error."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#maxcensussize"},"maxCensusSize")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L145"},"types/election/election.ts:145")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Metadata (anything added by the election creator)"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#meta"},"meta")),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L126"},"types/election/election.ts:126")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"metadataurl"},"metadataURL"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"metadataURL"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L37"},"types/election/published.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"organizationid"},"organizationId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"organizationId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L28"},"types/election/published.ts:28")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"questions"},"questions"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"questions"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,r.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,r.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#questions"},"questions")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L132"},"types/election/election.ts:132")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"raw"},"raw"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"raw"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"object")),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L39"},"types/election/published.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"results"},"results"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"results"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[][]"),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L32"},"types/election/published.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"resultstype"},"resultsType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"resultsType"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#electionresultstype"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionResultsType"))),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L38"},"types/election/published.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"startdate"},"startDate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"startDate"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#startdate"},"startDate")),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L127"},"types/election/election.ts:127")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"status"},"status"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"status"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#allelectionstatus"},(0,r.kt)("inlineCode",{parentName:"a"},"AllElectionStatus"))),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L29"},"types/election/published.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"streamuri"},"streamUri"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"streamUri"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Election stream Uri (ex: a video url)"),(0,r.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#streamuri"},"streamUri")),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L122"},"types/election/election.ts:122")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Is used to remove the secret identities of the voters once the process is done."),(0,r.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#temporarysecretidentity"},"temporarySecretIdentity")),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L150"},"types/election/election.ts:150")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"title"},"title"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"title"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Election title"),(0,r.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#title"},"title")),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L110"},"types/election/election.ts:110")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"votecount"},"voteCount"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"voteCount"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L30"},"types/election/published.ts:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"votetype"},"voteType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"voteType"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,r.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,r.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#votetype"},"voteType")),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L130"},"types/election/election.ts:130")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/af55f10e.7cb91573.js b/assets/js/af55f10e.7cb91573.js new file mode 100644 index 000000000..322c50e9f --- /dev/null +++ b/assets/js/af55f10e.7cb91573.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5580],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>u});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),s=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},o=function(e){var t=s(e.components);return a.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),m=s(n),u=r,N=m["".concat(p,".").concat(u)]||m[u]||k[u]||i;return n?a.createElement(N,l(l({ref:t},o),{},{components:n})):a.createElement(N,l({ref:t},o))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>d,toc:()=>s});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,d={unversionedId:"sdk/reference/classes/VocdoniCensus3Client",id:"sdk/reference/classes/VocdoniCensus3Client",title:"VocdoniCensus3Client",description:"@vocdoni/sdk / Exports / VocdoniCensus3Client",source:"@site/docs/sdk/reference/classes/VocdoniCensus3Client.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/VocdoniCensus3Client",permalink:"/sdk/reference/classes/VocdoniCensus3Client",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"UnpublishedElection",permalink:"/sdk/reference/classes/UnpublishedElection"},next:{title:"VocdoniSDKClient",permalink:"/sdk/reference/classes/VocdoniSDKClient"}},p={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"queueWait",id:"queuewait",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods-1",level:2},{value:"createCensus",id:"createcensus",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"createStrategy",id:"createstrategy",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"createToken",id:"createtoken",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"createTokenCensus",id:"createtokencensus",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"getCensus",id:"getcensus",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getCensuses",id:"getcensuses",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getStrategies",id:"getstrategies",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getStrategiesByToken",id:"getstrategiesbytoken",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getStrategy",id:"getstrategy",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getStrategyEstimation",id:"getstrategyestimation",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getStrategyHolders",id:"getstrategyholders",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getSupportedChains",id:"getsupportedchains",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getSupportedOperators",id:"getsupportedoperators",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getSupportedTokens",id:"getsupportedtokens",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getSupportedTypes",id:"getsupportedtypes",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getToken",id:"gettoken",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"importStrategy",id:"importstrategy",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"isHolderInToken",id:"isholderintoken",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"tokenHolderBalance",id:"tokenholderbalance",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"validatePredicate",id:"validatepredicate",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-22",level:4}],o={toc:s};function k(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / VocdoniCensus3Client"),(0,r.kt)("h1",{id:"class-vocdonicensus3client"},"Class: VocdoniCensus3Client"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#queuewait"},"queueWait")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#url"},"url"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#createcensus"},"createCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#createstrategy"},"createStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#createtoken"},"createToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#createtokencensus"},"createTokenCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#getcensus"},"getCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#getcensuses"},"getCensuses")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#getstrategies"},"getStrategies")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#getstrategiesbytoken"},"getStrategiesByToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#getstrategy"},"getStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#getstrategyestimation"},"getStrategyEstimation")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#getstrategyholders"},"getStrategyHolders")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#getsupportedchains"},"getSupportedChains")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#getsupportedoperators"},"getSupportedOperators")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#getsupportedtokens"},"getSupportedTokens")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#getsupportedtypes"},"getSupportedTypes")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#gettoken"},"getToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#importstrategy"},"importStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#isholderintoken"},"isHolderInToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#tokenholderbalance"},"tokenHolderBalance")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"VocdoniCensus3Client#validatepredicate"},"validatePredicate"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new VocdoniCensus3Client"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"opts"),"): ",(0,r.kt)("a",{parentName:"p",href:"VocdoniCensus3Client"},(0,r.kt)("inlineCode",{parentName:"a"},"VocdoniCensus3Client"))),(0,r.kt)("p",null,"Instantiate new VocdoniCensus3 client."),(0,r.kt)("p",null,"To instantiate the client just pass the ",(0,r.kt)("inlineCode",{parentName:"p"},"ClientOptions")," you want or empty object to let defaults."),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"const client = new VocdoniCensus3Client({EnvOptions.PROD})")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"opts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../modules#clientoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"ClientOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"optional arguments")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"VocdoniCensus3Client"},(0,r.kt)("inlineCode",{parentName:"a"},"VocdoniCensus3Client"))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L48"},"census3.ts:48")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"queuewait"},"queueWait"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"queueWait"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"attempts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"retryTime")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L37"},"census3.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"url"},"url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L36"},"census3.ts:36")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"createcensus"},"createCensus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createCensus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"strategyId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),">"),(0,r.kt)("p",null,"Creates the census based on the given strategy"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"strategyId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the census has to be anonymous")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),">"),(0,r.kt)("p",null,"The census information"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L358"},"census3.ts:358")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createstrategy"},"createStrategy"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createStrategy"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"alias"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"predicate"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"tokens"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"Creates a new strategy based on the given tokens and predicate"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"alias")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The alias of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"predicate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The predicate of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokens")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The token list for the strategy")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"The strategy id"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L275"},"census3.ts:275")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createtoken"},"createToken"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createToken"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"tags?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Creates a new token to be tracked in the service"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The address of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"type")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The type of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"1")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chain id of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tags")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"[]")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The tag list to associate the token with")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L163"},"census3.ts:163")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createtokencensus"},"createTokenCensus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createTokenCensus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymous?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"TokenCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"TokenCensus")),">"),(0,r.kt)("p",null,"Returns the actual census based on the given token using the default strategy set"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The address of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the chain")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the census has to be anonymous")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"TokenCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"TokenCensus")),">"),(0,r.kt)("p",null,"The token census"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L395"},"census3.ts:395")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcensus"},"getCensus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCensus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),">"),(0,r.kt)("p",null,"Returns the census3 census based on the given identifier"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the census")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),">"),(0,r.kt)("p",null,"The census3 census"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L346"},"census3.ts:346")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcensuses"},"getCensuses"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCensuses"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"strategyId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),"[]",">"),(0,r.kt)("p",null,"Returns the census3 censuses"),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"strategyId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The strategy identifier")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),"[]",">"),(0,r.kt)("p",null,"The list of census3 censuses"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L335"},"census3.ts:335")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstrategies"},"getStrategies"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStrategies"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),"[]",">"),(0,r.kt)("p",null,"Returns the strategies"),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),"[]",">"),(0,r.kt)("p",null,"The list of strategies"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L181"},"census3.ts:181")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstrategiesbytoken"},"getStrategiesByToken"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStrategiesByToken"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),"[]",">"),(0,r.kt)("p",null,"Returns the strategies from the given token"),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id (address) of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the chain")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),"[]",">"),(0,r.kt)("p",null,"The list of strategies"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L207"},"census3.ts:207")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstrategy"},"getStrategy"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStrategy"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),">"),(0,r.kt)("p",null,"Returns the information of the strategy based on the id"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the strategy")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),">"),(0,r.kt)("p",null,"The strategy information"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L221"},"census3.ts:221")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstrategyestimation"},"getStrategyEstimation"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStrategyEstimation"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"accuracy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"size"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"timeToCreateCensus"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," }",">"),(0,r.kt)("p",null,"Returns the estimation of size and time (in milliseconds) to create the census generated for the provided strategy"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the estimation should be done for anonymous census")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"accuracy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"size"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"timeToCreateCensus"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," }",">"),(0,r.kt)("p",null,"The strategy estimation"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L233"},"census3.ts:233")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstrategyholders"},"getStrategyHolders"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStrategyHolders"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pagination?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#strategyholders"},(0,r.kt)("inlineCode",{parentName:"a"},"StrategyHolders")),">"),(0,r.kt)("p",null,"Returns the strategy holders"),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pagination")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Census3Pagination")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Pagination options")))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#strategyholders"},(0,r.kt)("inlineCode",{parentName:"a"},"StrategyHolders")),">"),(0,r.kt)("p",null,"The list strategy holders"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L192"},"census3.ts:192")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsupportedchains"},"getSupportedChains"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSupportedChains"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3SupportedChain"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3SupportedChain")),"[]",">"),(0,r.kt)("p",null,"Returns a list of supported chain identifiers"),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3SupportedChain"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3SupportedChain")),"[]",">"),(0,r.kt)("p",null,"Supported chain list"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L76"},"census3.ts:76")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsupportedoperators"},"getSupportedOperators"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSupportedOperators"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3StrategiesOperator"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesOperator")),"[]",">"),(0,r.kt)("p",null,"Returns a list of supported strategies operators"),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3StrategiesOperator"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesOperator")),"[]",">"),(0,r.kt)("p",null,"Supported strategies operators list"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L94"},"census3.ts:94")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsupportedtokens"},"getSupportedTokens"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSupportedTokens"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#tokensummary"},(0,r.kt)("inlineCode",{parentName:"a"},"TokenSummary")),"[]",">"),(0,r.kt)("p",null,"Returns a list of summary tokens supported by the service"),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#tokensummary"},(0,r.kt)("inlineCode",{parentName:"a"},"TokenSummary")),"[]",">"),(0,r.kt)("p",null,"Token summary list"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L61"},"census3.ts:61")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsupportedtypes"},"getSupportedTypes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSupportedTypes"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]",">"),(0,r.kt)("p",null,"Returns a list of supported tokens type"),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]",">"),(0,r.kt)("p",null,"Supported tokens type list"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L85"},"census3.ts:85")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gettoken"},"getToken"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getToken"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#token"},(0,r.kt)("inlineCode",{parentName:"a"},"Token")),">"),(0,r.kt)("p",null,"Returns the full token information based on the id (address)"),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id (address) of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the chain")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#token"},(0,r.kt)("inlineCode",{parentName:"a"},"Token")),">"),(0,r.kt)("p",null,"The token information"),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L106"},"census3.ts:106")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"importstrategy"},"importStrategy"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"importStrategy"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"cid"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),">"),(0,r.kt)("p",null,"Imports a strategy from IPFS from the given cid."),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"cid")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The IPFS cid of the strategy to import")))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),">"),(0,r.kt)("p",null,"The strategy information"),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L290"},"census3.ts:290")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isholderintoken"},"isHolderInToken"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHolderInToken"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"tokenId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"holderId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Returns if the holder ID is already registered in the database as a holder of the token."),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokenId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id (address) of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the chain")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"holderId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the holder")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"If the holder is in the token"),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L124"},"census3.ts:124")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tokenholderbalance"},"tokenHolderBalance"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"tokenHolderBalance"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"tokenId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"holderId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"bigint"),">"),(0,r.kt)("p",null,"Returns the balance of the holder based on the token and chain"),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokenId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id (address) of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the chain")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"holderId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the holder")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"bigint"),">"),(0,r.kt)("p",null,"The balance of the holder"),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L145"},"census3.ts:145")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"validatepredicate"},"validatePredicate"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"validatePredicate"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"predicate"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3ValidatePredicateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3ValidatePredicateResponse")),">"),(0,r.kt)("p",null,"Validates a predicate"),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"predicate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The predicate of the strategy")))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3ValidatePredicateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3ValidatePredicateResponse")),">"),(0,r.kt)("p",null,"The parsed predicate"),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/census3.ts#L324"},"census3.ts:324")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/af55f10e.a66f4163.js b/assets/js/af55f10e.a66f4163.js deleted file mode 100644 index 7ddbf90e1..000000000 --- a/assets/js/af55f10e.a66f4163.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5580],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>u});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),p=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},o=function(e){var t=p(e.components);return a.createElement(d.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),m=p(n),u=r,N=m["".concat(d,".").concat(u)]||m[u]||k[u]||i;return n?a.createElement(N,l(l({ref:t},o),{},{components:n})):a.createElement(N,l({ref:t},o))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var s={};for(var d in t)hasOwnProperty.call(t,d)&&(s[d]=t[d]);s.originalType=e,s.mdxType="string"==typeof e?e:r,l[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,s={unversionedId:"sdk/reference/classes/VocdoniCensus3Client",id:"sdk/reference/classes/VocdoniCensus3Client",title:"VocdoniCensus3Client",description:"@vocdoni/sdk / Exports / VocdoniCensus3Client",source:"@site/docs/sdk/reference/classes/VocdoniCensus3Client.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/VocdoniCensus3Client",permalink:"/sdk/reference/classes/VocdoniCensus3Client",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"UnpublishedElection",permalink:"/sdk/reference/classes/UnpublishedElection"},next:{title:"VocdoniSDKClient",permalink:"/sdk/reference/classes/VocdoniSDKClient"}},d={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"queueWait",id:"queuewait",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods-1",level:2},{value:"createCensus",id:"createcensus",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"createStrategy",id:"createstrategy",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"createToken",id:"createtoken",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"createTokenCensus",id:"createtokencensus",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"getCensus",id:"getcensus",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getCensuses",id:"getcensuses",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getStrategies",id:"getstrategies",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getStrategiesByToken",id:"getstrategiesbytoken",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getStrategy",id:"getstrategy",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getStrategyEstimation",id:"getstrategyestimation",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getStrategyHolders",id:"getstrategyholders",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getSupportedChains",id:"getsupportedchains",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getSupportedOperators",id:"getsupportedoperators",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getSupportedTokens",id:"getsupportedtokens",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getSupportedTypes",id:"getsupportedtypes",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getToken",id:"gettoken",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"importStrategy",id:"importstrategy",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"isHolderInToken",id:"isholderintoken",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"tokenHolderBalance",id:"tokenholderbalance",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"validatePredicate",id:"validatepredicate",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-22",level:4}],o={toc:p};function k(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / VocdoniCensus3Client"),(0,r.kt)("h1",{id:"class-vocdonicensus3client"},"Class: VocdoniCensus3Client"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#queuewait"},"queueWait")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#url"},"url"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#createcensus"},"createCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#createstrategy"},"createStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#createtoken"},"createToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#createtokencensus"},"createTokenCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#getcensus"},"getCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#getcensuses"},"getCensuses")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#getstrategies"},"getStrategies")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#getstrategiesbytoken"},"getStrategiesByToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#getstrategy"},"getStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#getstrategyestimation"},"getStrategyEstimation")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#getstrategyholders"},"getStrategyHolders")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#getsupportedchains"},"getSupportedChains")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#getsupportedoperators"},"getSupportedOperators")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#getsupportedtokens"},"getSupportedTokens")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#getsupportedtypes"},"getSupportedTypes")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#gettoken"},"getToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#importstrategy"},"importStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#isholderintoken"},"isHolderInToken")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#tokenholderbalance"},"tokenHolderBalance")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniCensus3Client#validatepredicate"},"validatePredicate"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new VocdoniCensus3Client"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"opts"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniCensus3Client"},(0,r.kt)("inlineCode",{parentName:"a"},"VocdoniCensus3Client"))),(0,r.kt)("p",null,"Instantiate new VocdoniCensus3 client."),(0,r.kt)("p",null,"To instantiate the client just pass the ",(0,r.kt)("inlineCode",{parentName:"p"},"ClientOptions")," you want or empty object to let defaults."),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"const client = new VocdoniCensus3Client({EnvOptions.PROD})")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"opts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#clientoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"ClientOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"optional arguments")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniCensus3Client"},(0,r.kt)("inlineCode",{parentName:"a"},"VocdoniCensus3Client"))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L48"},"census3.ts:48")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"queuewait"},"queueWait"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"queueWait"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"attempts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"retryTime")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L37"},"census3.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"url"},"url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L36"},"census3.ts:36")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"createcensus"},"createCensus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createCensus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"strategyId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),">"),(0,r.kt)("p",null,"Creates the census based on the given strategy"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"strategyId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the census has to be anonymous")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),">"),(0,r.kt)("p",null,"The census information"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L358"},"census3.ts:358")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createstrategy"},"createStrategy"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createStrategy"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"alias"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"predicate"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"tokens"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"Creates a new strategy based on the given tokens and predicate"),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"alias")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The alias of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"predicate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The predicate of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokens")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The token list for the strategy")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"The strategy id"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L275"},"census3.ts:275")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createtoken"},"createToken"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createToken"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"tags?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Creates a new token to be tracked in the service"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The address of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"type")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The type of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"1")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chain id of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tags")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"[]")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The tag list to associate the token with")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L163"},"census3.ts:163")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createtokencensus"},"createTokenCensus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createTokenCensus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymous?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/TokenCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"TokenCensus")),">"),(0,r.kt)("p",null,"Returns the actual census based on the given token using the default strategy set"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The address of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the chain")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the census has to be anonymous")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/TokenCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"TokenCensus")),">"),(0,r.kt)("p",null,"The token census"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L395"},"census3.ts:395")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcensus"},"getCensus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCensus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),">"),(0,r.kt)("p",null,"Returns the census3 census based on the given identifier"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the census")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),">"),(0,r.kt)("p",null,"The census3 census"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L346"},"census3.ts:346")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcensuses"},"getCensuses"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCensuses"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"strategyId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),"[]",">"),(0,r.kt)("p",null,"Returns the census3 censuses"),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"strategyId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The strategy identifier")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),"[]",">"),(0,r.kt)("p",null,"The list of census3 censuses"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L335"},"census3.ts:335")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstrategies"},"getStrategies"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStrategies"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),"[]",">"),(0,r.kt)("p",null,"Returns the strategies"),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),"[]",">"),(0,r.kt)("p",null,"The list of strategies"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L181"},"census3.ts:181")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstrategiesbytoken"},"getStrategiesByToken"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStrategiesByToken"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),"[]",">"),(0,r.kt)("p",null,"Returns the strategies from the given token"),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id (address) of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the chain")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),"[]",">"),(0,r.kt)("p",null,"The list of strategies"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L207"},"census3.ts:207")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstrategy"},"getStrategy"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStrategy"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),">"),(0,r.kt)("p",null,"Returns the information of the strategy based on the id"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the strategy")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),">"),(0,r.kt)("p",null,"The strategy information"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L221"},"census3.ts:221")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstrategyestimation"},"getStrategyEstimation"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStrategyEstimation"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"accuracy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"size"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"timeToCreateCensus"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," }",">"),(0,r.kt)("p",null,"Returns the estimation of size and time (in milliseconds) to create the census generated for the provided strategy"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the estimation should be done for anonymous census")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"accuracy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"size"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"timeToCreateCensus"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," }",">"),(0,r.kt)("p",null,"The strategy estimation"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L233"},"census3.ts:233")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstrategyholders"},"getStrategyHolders"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStrategyHolders"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pagination?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#strategyholders"},(0,r.kt)("inlineCode",{parentName:"a"},"StrategyHolders")),">"),(0,r.kt)("p",null,"Returns the strategy holders"),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the strategy")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pagination")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Census3Pagination")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Pagination options")))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#strategyholders"},(0,r.kt)("inlineCode",{parentName:"a"},"StrategyHolders")),">"),(0,r.kt)("p",null,"The list strategy holders"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L192"},"census3.ts:192")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsupportedchains"},"getSupportedChains"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSupportedChains"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3SupportedChain"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3SupportedChain")),"[]",">"),(0,r.kt)("p",null,"Returns a list of supported chain identifiers"),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3SupportedChain"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3SupportedChain")),"[]",">"),(0,r.kt)("p",null,"Supported chain list"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L76"},"census3.ts:76")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsupportedoperators"},"getSupportedOperators"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSupportedOperators"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategiesOperator"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesOperator")),"[]",">"),(0,r.kt)("p",null,"Returns a list of supported strategies operators"),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategiesOperator"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesOperator")),"[]",">"),(0,r.kt)("p",null,"Supported strategies operators list"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L94"},"census3.ts:94")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsupportedtokens"},"getSupportedTokens"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSupportedTokens"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#tokensummary"},(0,r.kt)("inlineCode",{parentName:"a"},"TokenSummary")),"[]",">"),(0,r.kt)("p",null,"Returns a list of summary tokens supported by the service"),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#tokensummary"},(0,r.kt)("inlineCode",{parentName:"a"},"TokenSummary")),"[]",">"),(0,r.kt)("p",null,"Token summary list"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L61"},"census3.ts:61")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsupportedtypes"},"getSupportedTypes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSupportedTypes"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]",">"),(0,r.kt)("p",null,"Returns a list of supported tokens type"),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]",">"),(0,r.kt)("p",null,"Supported tokens type list"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L85"},"census3.ts:85")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gettoken"},"getToken"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getToken"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#token"},(0,r.kt)("inlineCode",{parentName:"a"},"Token")),">"),(0,r.kt)("p",null,"Returns the full token information based on the id (address)"),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id (address) of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the chain")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#token"},(0,r.kt)("inlineCode",{parentName:"a"},"Token")),">"),(0,r.kt)("p",null,"The token information"),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L106"},"census3.ts:106")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"importstrategy"},"importStrategy"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"importStrategy"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"cid"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),">"),(0,r.kt)("p",null,"Imports a strategy from IPFS from the given cid."),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"cid")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The IPFS cid of the strategy to import")))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3strategy"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),">"),(0,r.kt)("p",null,"The strategy information"),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L290"},"census3.ts:290")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isholderintoken"},"isHolderInToken"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isHolderInToken"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"tokenId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"holderId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Returns if the holder ID is already registered in the database as a holder of the token."),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokenId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id (address) of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the chain")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"holderId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the holder")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"If the holder is in the token"),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L124"},"census3.ts:124")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tokenholderbalance"},"tokenHolderBalance"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"tokenHolderBalance"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"tokenId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chainId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"holderId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"externalId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"bigint"),">"),(0,r.kt)("p",null,"Returns the balance of the holder based on the token and chain"),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokenId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id (address) of the token")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the chain")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"holderId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the holder")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"externalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier used by external provider")))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"bigint"),">"),(0,r.kt)("p",null,"The balance of the holder"),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L145"},"census3.ts:145")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"validatepredicate"},"validatePredicate"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"validatePredicate"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"predicate"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3ValidatePredicateResponse")),">"),(0,r.kt)("p",null,"Validates a predicate"),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"predicate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The predicate of the strategy")))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3ValidatePredicateResponse")),">"),(0,r.kt)("p",null,"The parsed predicate"),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/census3.ts#L324"},"census3.ts:324")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/af663d33.622d7ca4.js b/assets/js/af663d33.193471bc.js similarity index 80% rename from assets/js/af663d33.622d7ca4.js rename to assets/js/af663d33.193471bc.js index d8054257e..33f3b96c2 100644 --- a/assets/js/af663d33.622d7ca4.js +++ b/assets/js/af663d33.193471bc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4721],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>d});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function c(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var i=r.createContext({}),u=function(e){var t=r.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=u(e.components);return r.createElement(i.Provider,{value:t},e.children)},l={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,c=e.originalType,i=e.parentName,p=a(e,["components","mdxType","originalType","parentName"]),f=u(n),d=o,m=f["".concat(i,".").concat(d)]||f[d]||l[d]||c;return n?r.createElement(m,s(s({ref:t},p),{},{components:n})):r.createElement(m,s({ref:t},p))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var c=n.length,s=new Array(c);s[0]=f;var a={};for(var i in t)hasOwnProperty.call(t,i)&&(a[i]=t[i]);a.originalType=e,a.mdxType="string"==typeof e?e:o,s[1]=a;for(var u=2;u{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>l,frontMatter:()=>c,metadata:()=>a,toc:()=>u});var r=n(87462),o=(n(67294),n(3905));const c={},s=void 0,a={unversionedId:"sdk/reference/interfaces/IAccountsCountResponse",id:"sdk/reference/interfaces/IAccountsCountResponse",title:"IAccountsCountResponse",description:"@vocdoni/sdk / Exports / IAccountsCountResponse",source:"@site/docs/sdk/reference/interfaces/IAccountsCountResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IAccountsCountResponse",permalink:"/sdk/reference/interfaces/IAccountsCountResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IAccountTransfersCountResponse",permalink:"/sdk/reference/interfaces/IAccountTransfersCountResponse"},next:{title:"IAccountsListResponse",permalink:"/sdk/reference/interfaces/IAccountsListResponse"}},i={},u=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"count",id:"count",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:u};function l(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IAccountsCountResponse"),(0,o.kt)("h1",{id:"interface-iaccountscountresponse"},"Interface: IAccountsCountResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IAccountsCountResponse#count"},"count"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"count"},"count"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"count"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"Number of accounts"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/account.ts#L102"},"api/account.ts:102")))}l.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4721],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>d});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function c(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var i=r.createContext({}),u=function(e){var t=r.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=u(e.components);return r.createElement(i.Provider,{value:t},e.children)},l={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,c=e.originalType,i=e.parentName,p=a(e,["components","mdxType","originalType","parentName"]),f=u(n),d=o,m=f["".concat(i,".").concat(d)]||f[d]||l[d]||c;return n?r.createElement(m,s(s({ref:t},p),{},{components:n})):r.createElement(m,s({ref:t},p))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var c=n.length,s=new Array(c);s[0]=f;var a={};for(var i in t)hasOwnProperty.call(t,i)&&(a[i]=t[i]);a.originalType=e,a.mdxType="string"==typeof e?e:o,s[1]=a;for(var u=2;u{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>l,frontMatter:()=>c,metadata:()=>a,toc:()=>u});var r=n(87462),o=(n(67294),n(3905));const c={},s=void 0,a={unversionedId:"sdk/reference/interfaces/IAccountsCountResponse",id:"sdk/reference/interfaces/IAccountsCountResponse",title:"IAccountsCountResponse",description:"@vocdoni/sdk / Exports / IAccountsCountResponse",source:"@site/docs/sdk/reference/interfaces/IAccountsCountResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IAccountsCountResponse",permalink:"/sdk/reference/interfaces/IAccountsCountResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IAccountTransfersCountResponse",permalink:"/sdk/reference/interfaces/IAccountTransfersCountResponse"},next:{title:"IAccountsListResponse",permalink:"/sdk/reference/interfaces/IAccountsListResponse"}},i={},u=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"count",id:"count",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:u};function l(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IAccountsCountResponse"),(0,o.kt)("h1",{id:"interface-iaccountscountresponse"},"Interface: IAccountsCountResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IAccountsCountResponse#count"},"count"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"count"},"count"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"count"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"Number of accounts"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L102"},"api/account.ts:102")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/af6efd74.7f51efee.js b/assets/js/af6efd74.7f51efee.js deleted file mode 100644 index 0a363ae59..000000000 --- a/assets/js/af6efd74.7f51efee.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4458],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>h});var a=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function r(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=a.createContext({}),c=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},d=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=c(n),h=i,m=u["".concat(l,".").concat(h)]||u[h]||p[h]||o;return n?a.createElement(m,r(r({ref:t},d),{},{components:n})):a.createElement(m,r({ref:t},d))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,r=new Array(o);r[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:i,r[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var a=n(87462),i=(n(67294),n(3905));const o={},r="SDK Integration Details",s={unversionedId:"sdk/integration-details",id:"sdk/integration-details",title:"SDK Integration Details",description:"The tutorial covers the basics, but here are some details you'll need to consider when integrating the Vocdoni SDK into your application.",source:"@site/docs/sdk/integration-details.md",sourceDirName:"sdk",slug:"/sdk/integration-details",permalink:"/sdk/integration-details",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Vocdoni SDK",permalink:"/sdk/"},next:{title:"Changelog",permalink:"/sdk/reference/changelog"}},l={},c=[{value:"Vocdoni Tokens",id:"vocdoni-tokens",level:2},{value:"Faucet",id:"faucet",level:4},{value:"Election cost",id:"election-cost",level:4},{value:"Census Types",id:"census-types",level:2},{value:"Off-chain Merkle Tree",id:"off-chain-merkle-tree",level:3},{value:"Anonymous off-chain tree",id:"anonymous-off-chain-tree",level:4},{value:"Off-chain Credential Service Provider",id:"off-chain-credential-service-provider",level:3},{value:"On-chain Census",id:"on-chain-census",level:3},{value:"Election Types",id:"election-types",level:2},{value:"Election Status",id:"election-status",level:2},{value:"Pause",id:"pause",level:4},{value:"Cancel",id:"cancel",level:4},{value:"End",id:"end",level:4},{value:"Continue",id:"continue",level:4},{value:"Environment",id:"environment",level:2},{value:"Production",id:"production",level:4},{value:"Staging",id:"staging",level:4},{value:"Development",id:"development",level:4},{value:"Other SDK functionalities",id:"other-sdk-functionalities",level:2},{value:"Generate a random Wallet",id:"generate-a-random-wallet",level:4},{value:"Generate deterministic Wallet from data",id:"generate-deterministic-wallet-from-data",level:4}],d={toc:c};function p(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"sdk-integration-details"},"SDK Integration Details"),(0,i.kt)("p",null,"The tutorial covers the basics, but here are some details you'll need to consider when integrating the Vocdoni SDK into your application."),(0,i.kt)("h2",{id:"vocdoni-tokens"},"Vocdoni Tokens"),(0,i.kt)("p",null,"Behind-the-scenes, Vocdoni is powered by a custom ",(0,i.kt)("a",{parentName:"p",href:"/protocol#11-the-blockchain"},"blockchain"),'. This component provides universal verifiability, but it also introduces some complexity. In order to distribute workload and verify transactions, our blockchain uses a digital "currency" of Vocdoni tokens that have no real-world value but help with load-balancing and spam reduction. Actions that update data on the blockchain incur a set "cost" and integrators are responsible for ensuring that accounts creating elections have sufficient balance of tokens.'),(0,i.kt)("admonition",{type:"info"},(0,i.kt)("p",{parentName:"admonition"},"Casting a vote ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("em",{parentName:"strong"},"never"))," requires Vocdoni tokens.")),(0,i.kt)("p",null,"Currently tokens are automatically supplied in non-production networks, which is why you can create example applications on the ",(0,i.kt)("inlineCode",{parentName:"p"},"STG")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"DEV")," networks without worrying about maintaining a balance."),(0,i.kt)("h4",{id:"faucet"},"Faucet"),(0,i.kt)("p",null,"The main way for integrators to gain tokens in a production environment is via the faucet. Vocdoni provides a faucet, or provider of free tokens, which accounts can request tokens from. For production environments, you should ",(0,i.kt)("a",{parentName:"p",href:"https://chat.vocdoni.io"},"contact us")," for a byte64 string faucet."),(0,i.kt)("p",null,"Because accounts cannot hold Vocdoni tokens before they are created, ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#createaccount"},(0,i.kt)("inlineCode",{parentName:"a"},"client.createAccount()"))," allows you to specify a ",(0,i.kt)("inlineCode",{parentName:"p"},"faucetPackage"),", the byte64 string we have provided you with. This will provide you with at least enough tokens to create the account."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},'(async () => {\n const info = await client.createAccount({\n faucetPackage: ""\n })\n})();\n')),(0,i.kt)("p",null,"From this point on, you can check your account balance with ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#createaccount"},(0,i.kt)("inlineCode",{parentName:"a"},"client.createAccount()"))," or ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#fetchaccount"},(0,i.kt)("inlineCode",{parentName:"a"},"client.fetchAccountInfo()")),". You will need to use ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#collectfaucettokens"},(0,i.kt)("inlineCode",{parentName:"a"},"client.collectFaucetTokens()"))," whenever you are low on tokens and need more."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"(async () => {\n const info = await client.createAccount()\n if (info.balance === 0) {\n await client.collectFaucetTokens()\n }\n})();\n")),(0,i.kt)("admonition",{type:"note"},(0,i.kt)("p",{parentName:"admonition"},"In production environments, the ",(0,i.kt)("inlineCode",{parentName:"p"},"collectFaucetTokens")," method only works when the account does not have enough tokens to create new voting processes. ")),(0,i.kt)("h4",{id:"election-cost"},"Election cost"),(0,i.kt)("p",null,"The token cost of a voting process is not constant; it is determined by many factors. After creating an election, but before publishing it to the blockchain, you should get a sense of the total cost in order to ensure your account has sufficient balance. There are two methods to do this: ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#estimateelectioncost"},(0,i.kt)("inlineCode",{parentName:"a"},"client.estimateElectionCost()"))," quickly provides a decent estimate of the cost and can be useful for writing UI components. ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#calculateelectioncost"},(0,i.kt)("inlineCode",{parentName:"a"},"client.calculateElectionCost()"))," makes a time-intensive API call but provides an exact figure. It is helpful to use this directly before publishing the election to ensure it can be published."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"(async () => {\n const price = await client.estimateElectionCost(election) // Should be an UnpublishedElection\n console.log(price) // shows the estimation price\n})();\n")),(0,i.kt)("h2",{id:"census-types"},"Census Types"),(0,i.kt)("p",null,"A census is a list of voters who are eligible to vote in a given election. There are multiple ways to define a census with Vocdoni, each with different privacy and verifiability considerations. The ",(0,i.kt)("a",{parentName:"p",href:"/protocol/census"},"census types")," are defined at a protocol level and include ",(0,i.kt)("a",{parentName:"p",href:"/protocol/census#on-chain-based-census-ethereum-erc-20"},"on-chain"),", ",(0,i.kt)("a",{parentName:"p",href:"/protocol/census#off-chain-tree-based-census-merkle-tree"},"off-chain Merkle tree"),", and ",(0,i.kt)("a",{parentName:"p",href:"/protocol/census#off-chain-csp-based-census-credential-service-provider"},"off-chain Credential Service Provider"),". "),(0,i.kt)("p",null,"The census type is selected from the SDK by using a ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,i.kt)("inlineCode",{parentName:"a"},"census"))," of that type when creating an election. The SDK ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#hierarchy"},"census types")," correspond to the three protocol-level census types according to the following table:"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:null},"SDK Census Type"),(0,i.kt)("th",{parentName:"tr",align:null},"Protocol Type"),(0,i.kt)("th",{parentName:"tr",align:null},"weighted"),(0,i.kt)("th",{parentName:"tr",align:null},"anonymous"),(0,i.kt)("th",{parentName:"tr",align:null},(0,i.kt)("a",{parentName:"th",href:"/sdk/reference/enums/CensusType"},(0,i.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,i.kt)("th",{parentName:"tr",align:null}))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/CSPCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"CSPCensus"))),(0,i.kt)("td",{parentName:"tr",align:null},"Off-chain CSP"),(0,i.kt)("td",{parentName:"tr",align:null},"no"),(0,i.kt)("td",{parentName:"tr",align:null},"optional"),(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"CSP")),(0,i.kt)("td",{parentName:"tr",align:null})),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/PublishedCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))," -> ",(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/TokenCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"TokenCensus"))),(0,i.kt)("td",{parentName:"tr",align:null},"On-chain"),(0,i.kt)("td",{parentName:"tr",align:null},"yes"),(0,i.kt)("td",{parentName:"tr",align:null},"no"),(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"WEIGHTED")),(0,i.kt)("td",{parentName:"tr",align:null})),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/PublishedCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))," -> ",(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/TokenCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"TokenCensus"))),(0,i.kt)("td",{parentName:"tr",align:null},"On-chain"),(0,i.kt)("td",{parentName:"tr",align:null},"yes"),(0,i.kt)("td",{parentName:"tr",align:null},"yes"),(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"ANONYMOUS")),(0,i.kt)("td",{parentName:"tr",align:null})),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/OffchainCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))," -> ",(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/PlainCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"PlainCensus"))),(0,i.kt)("td",{parentName:"tr",align:null},"Off-chain tree"),(0,i.kt)("td",{parentName:"tr",align:null},"no"),(0,i.kt)("td",{parentName:"tr",align:null},"no"),(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"WEIGHTED")),(0,i.kt)("td",{parentName:"tr",align:null})),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/OffchainCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))," -> ",(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/PlainCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"PlainCensus"))),(0,i.kt)("td",{parentName:"tr",align:null},"Off-chain tree"),(0,i.kt)("td",{parentName:"tr",align:null},"no"),(0,i.kt)("td",{parentName:"tr",align:null},"yes"),(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"WEIGHTED")),(0,i.kt)("td",{parentName:"tr",align:null})),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/OffchainCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))," -> ",(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/WeightedCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"WeightedCensus"))),(0,i.kt)("td",{parentName:"tr",align:null},"Off-chain tree"),(0,i.kt)("td",{parentName:"tr",align:null},"yes"),(0,i.kt)("td",{parentName:"tr",align:null},"no"),(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"ANONYMOUS")),(0,i.kt)("td",{parentName:"tr",align:null})),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/OffchainCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))," -> ",(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/WeightedCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"WeightedCensus"))),(0,i.kt)("td",{parentName:"tr",align:null},"Off-chain tree"),(0,i.kt)("td",{parentName:"tr",align:null},"yes"),(0,i.kt)("td",{parentName:"tr",align:null},"yes"),(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"ANONYMOUS")),(0,i.kt)("td",{parentName:"tr",align:null})))),(0,i.kt)("admonition",{type:"note"},(0,i.kt)("p",{parentName:"admonition"},"A weighted census is one where some voters' votes have more power than others, set by a ",(0,i.kt)("inlineCode",{parentName:"p"},"weight")," value. ",(0,i.kt)("inlineCode",{parentName:"p"},"PlainCensus")," is described by a ",(0,i.kt)("inlineCode",{parentName:"p"},"WEIGHTED")," ",(0,i.kt)("inlineCode",{parentName:"p"},"CensusType")," because it technically is a weighted census, with every weight set to ",(0,i.kt)("inlineCode",{parentName:"p"},"1"),".")),(0,i.kt)("h3",{id:"off-chain-merkle-tree"},"Off-chain Merkle Tree"),(0,i.kt)("p",null,"This is the most basic census type, is the default when creating an election, and is the one used in the SDK tutorial. In this scheme, the census is essentially a basic list of voter, with some behind-the-scenes cryptography. With an off-train tree census, voters are added as wallet addresses using ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PlainCensus#add"},(0,i.kt)("inlineCode",{parentName:"a"},"census.add()")),". "),(0,i.kt)("p",null,"Off-chain tree census can be created as ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PlainCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"PlainCensus"))," or ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/WeightedCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"WeightedCensus")),". If a weighted census is used, voters can be assigned a weight which proportionally determines the power of their vote: "),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"weightedCensus.add([\n {\n key: address1,\n weight: BigInt(1),\n },\n {\n key: address2,\n // This voter will have 100x the vote power as voter1. This is not a very equitable election.\n weight: BigInt(100),\n },\n ]);\n")),(0,i.kt)("h4",{id:"anonymous-off-chain-tree"},"Anonymous off-chain tree"),(0,i.kt)("p",null,"For an ",(0,i.kt)("a",{parentName:"p",href:"/protocol/anonymity/zk-census-proof"},"anonymous")," election, the election must be created with the option "),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"electionType: {\n anonymous: true\n}\n")),(0,i.kt)("p",null,"In this case, votes must also be cast as ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/AnonymousVote"},(0,i.kt)("inlineCode",{parentName:"a"},"AnonymousVote")),"s. The cryptography needed for anonymous voting is very different from typical voting, but this is all handled by the SDK without any other changes needed."),(0,i.kt)("h3",{id:"off-chain-credential-service-provider"},"Off-chain Credential Service Provider"),(0,i.kt)("p",null,"A Credential Service Provider is an external component that serves as a validator for the identities of voters. An example of this could be a service set up by a municipal government that validates if a given voter is registered, or a forum that validates if a given voter has an active account. With this type of census, voters show proof of registry and receive a cryptographic package from the CSP allowing them to cast a vote. "),(0,i.kt)("p",null,"Because using an off-chain CSP census requires a custom CSP for each use-case, it is not ready to use out-of-the-box. If you are interested in setting up a CSP election, please ",(0,i.kt)("a",{parentName:"p",href:"https://chat.vocdoni.io"},"reach out to us")," for help."),(0,i.kt)("p",null,"CSP census elections have the option of full-anonymity with the use of ",(0,i.kt)("a",{parentName:"p",href:"/protocol/Census/off-chain-csp#blind-signatures"},"Blind Signatures"),". "),(0,i.kt)("p",null,"If a CSP is set up for a census, minor modifications are needed on the client side. For creating a CSP based election, a ",(0,i.kt)("inlineCode",{parentName:"p"},"CspCensus")," has to be used with the CSP's public key and URL as parameters. "),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"const election = Election.from({\n title: 'Election title',\n description: 'Election description',\n // a header image for your process (this is for example purposes; avoid using random sources)\n header: 'https://source.unsplash.com/random/2048x600',\n endDate: new Date('2023-01-23 23:23:23'),\n census: new CspCensus(CSP_PUBKEY, CSP_URL),\n})\n// The election can be created the same way from here...\n")),(0,i.kt)("p",null,"The next step is requesting a blind signature from the CSP for each voter before casting their vote. "),(0,i.kt)("p",null,"This is done with ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#cspstep"},(0,i.kt)("inlineCode",{parentName:"a"},"client.cspStep")),'. This function sends an API call to the given CSP to perform an "authentication step" predefined by whoever sets up the CSP. A step could be validating a name, sending an authentication token, or anything else. Non-final steps should return a ',(0,i.kt)("inlineCode",{parentName:"p"},"ICspIntermediateStepResponse")," object containing an ",(0,i.kt)("inlineCode",{parentName:"p"},"authToken")," and arbitrary ",(0,i.kt)("inlineCode",{parentName:"p"},"response")," data.\nOnce the predefined set of steps has been performed successfully, the final step should return a ",(0,i.kt)("inlineCode",{parentName:"p"},"ICspFinalStepResponse")," object containing a ",(0,i.kt)("inlineCode",{parentName:"p"},"token")," registered to the verified voter."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"// Auth steps for the CSP (can vary of the type of the CSP)\nconst step0 = (await client.cspStep(0, ['Name test'])) as ICspIntermediateStepResponse;\nconst step1 = (await client.cspStep(\n 1,\n [step0.response.reduce((acc, v) => +acc + +v, 0).toString()],\n step0.authToken\n)) as ICspFinalStepResponse;\n")),(0,i.kt)("p",null,"Once this token has been received, the client requests blind signature from the CSP and then uses this signature to cast vote. Because this signature is blinded, the vote cannot be traced back to the voter address or verification information."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"// Get the blind signature\nconst signature = await client.cspSign(signer.address, step1.token);\n\n// Get the vote based on the signature\nconst vote = client.cspVote(new Vote([index % 2]), signature);\n\n// Vote\nconst voteId = await client.submitVote(vote);\n")),(0,i.kt)("h3",{id:"on-chain-census"},"On-chain Census"),(0,i.kt)("p",null,"An on-chain census is one whose voters are defined by holding tokens on the Ethereum blockchain. Currently the following token types are supported:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"ERC20"),(0,i.kt)("li",{parentName:"ul"},"ERC721"),(0,i.kt)("li",{parentName:"ul"},"ERC777"),(0,i.kt)("li",{parentName:"ul"},"POAP"),(0,i.kt)("li",{parentName:"ul"},"Gitcoin Passport Score"),(0,i.kt)("li",{parentName:"ul"},"Gitcoin Passport Shields (coming soon)"),(0,i.kt)("li",{parentName:"ul"},"ERC1155 (coming soon)")),(0,i.kt)("p",null,"This census type is supported by our ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/census3"},"Census3")," service which serves as a bridge between Ethereum and clients. "),(0,i.kt)("h2",{id:"election-types"},"Election Types"),(0,i.kt)("p",null,"The Vocdoni ",(0,i.kt)("a",{parentName:"p",href:"/protocol/ballot-protocol"},"Ballot Protocol")," provides a flexible way to define many types of election. Check out ",(0,i.kt)("a",{parentName:"p",href:"/sdk/voting-types"},"Voting Types")," for an overview of the possibilities, including ranked-choice, quadratic, weighted, and approval voting."),(0,i.kt)("h2",{id:"election-status"},"Election Status"),(0,i.kt)("p",null,"Depending on your use case, you may need to pause, cancel, or otherwise pay attention to the state of an election.\n",(0,i.kt)("a",{parentName:"p",href:"/protocol#election-lifecycle-states"},"Election lifecycle states")," details all of the possible statuses an election can have once it has been published to the blockchain."),(0,i.kt)("h4",{id:"pause"},"Pause"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"(async () => {\n await client.pauseElection(id)\n const election = await client.fetchElection(id)\n console.log(election.status) // Matches ElectionStatus.PAUSED\n})();\n")),(0,i.kt)("h4",{id:"cancel"},"Cancel"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"(async () => {\n await client.cancelElection(id)\n const election = await client.fetchElection(id)\n console.log(election.status) // Matches ElectionStatus.CANCELED\n})();\n")),(0,i.kt)("h4",{id:"end"},"End"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"(async () => {\n await client.endElection(id)\n const election = await client.fetchElection(id)\n console.log(election.status) // Matches ElectionStatus.ENDED\n})();\n")),(0,i.kt)("h4",{id:"continue"},"Continue"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"(async () => {\n await client.continueElection(id)\n const election = await client.fetchElection(id)\n console.log(election.status) // Matches ElectionStatus.READY\n})();\n")),(0,i.kt)("h2",{id:"environment"},"Environment"),(0,i.kt)("h4",{id:"production"},"Production"),(0,i.kt)("p",null,"This is the environment for any production use cases. This environment is slightly more complicated to use, as it requires the manual use of ",(0,i.kt)("a",{parentName:"p",href:"/sdk/integration-details#vocdoni-tokens"},"Vocdoni Tokens")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"const client = new VocdoniSDKClient({\n env: EnvOptions.PROD, // mandatory, can be 'dev', 'stg', or 'prod'\n wallet: signer, // optional, the signer used (Metamask, Walletconnect)\n})\n")),(0,i.kt)("h4",{id:"staging"},"Staging"),(0,i.kt)("p",null,"This is the ",(0,i.kt)("strong",{parentName:"p"},"recommended")," environment for most testing use cases, since the\n",(0,i.kt)("inlineCode",{parentName:"p"},"dev")," environment is more subject to blockchain resets and downtimes than\nthe ",(0,i.kt)("inlineCode",{parentName:"p"},"stg")," one."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"const client = new VocdoniSDKClient({\n env: EnvOptions.STG, // mandatory, can be 'dev', 'stg', or 'prod'\n wallet: signer, // optional, the signer used (Metamask, Walletconnect)\n})\n")),(0,i.kt)("h4",{id:"development"},"Development"),(0,i.kt)("p",null,"This environment is for development testing and is subject to breaking changes and downtime."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"const client = new VocdoniSDKClient({\n env: EnvOptions.DEV, // mandatory, can be 'dev', 'stg', or 'prod'\n wallet: signer, // optional, the signer used (Metamask, Walletconnect)\n})\n")),(0,i.kt)("h2",{id:"other-sdk-functionalities"},"Other SDK functionalities"),(0,i.kt)("h4",{id:"generate-a-random-wallet"},"Generate a random Wallet"),(0,i.kt)("p",null,"You can use the ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#generaterandomwallet"},(0,i.kt)("inlineCode",{parentName:"a"},"client.generateRandomWallet"))," function to generate a random Wallet and assign it to the client.\nThis function returns the private key of the Wallet."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"const privateKey = client.generateRandomWallet();\nconsole.log(privateKey) // the private key of the wallet\n")),(0,i.kt)("h4",{id:"generate-deterministic-wallet-from-data"},"Generate deterministic Wallet from data"),(0,i.kt)("p",null,"For some cases where the voters don't have custody over an existing Wallet, we can generate a deterministic\nWallet based on arbitrary data, like, for example, the user and hash password from a custom CRM."),(0,i.kt)("p",null,"Here is an example of ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#generatewalletfromdata"},(0,i.kt)("inlineCode",{parentName:"a"},"client.generateWalletFromData"))," where a Wallet is generated using the username and the hash of the password\nwhich we would use to identify the user in our platform. This Wallet can then be used for the\ncensus and for voting purposes. This enables users to keep the same private key without having to store it in their browser or application."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"// 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08 is the sha256 of 'test'\nconst userWallet = VocdoniSDKClient.generateWalletFromData(['user1', '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08']);\nconsole.log(userWallet) // address is 0x8AF1b3EDB817b5854e3311d583905a3421F49829\n")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b0d01e95.1ecd2398.js b/assets/js/b0d01e95.1ecd2398.js deleted file mode 100644 index c50a783dd..000000000 --- a/assets/js/b0d01e95.1ecd2398.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1968],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>k});var i=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function r(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=i.createContext({}),c=function(e){var t=i.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},s=function(e){var t=c(e.components);return i.createElement(d.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},f=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),f=c(n),k=a,u=f["".concat(d,".").concat(k)]||f[k]||p[k]||l;return n?i.createElement(u,r(r({ref:t},s),{},{components:n})):i.createElement(u,r({ref:t},s))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,r=new Array(l);r[0]=f;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:a,r[1]=o;for(var c=2;c{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var i=n(87462),a=(n(67294),n(3905));const l={},r=void 0,o={unversionedId:"sdk/reference/interfaces/IElectionInfoResponse",id:"sdk/reference/interfaces/IElectionInfoResponse",title:"IElectionInfoResponse",description:"@vocdoni/sdk / Exports / IElectionInfoResponse",source:"@site/docs/sdk/reference/interfaces/IElectionInfoResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionInfoResponse",permalink:"/sdk/reference/interfaces/IElectionInfoResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionCreateResponse",permalink:"/sdk/reference/interfaces/IElectionCreateResponse"},next:{title:"IElectionKeysResponse",permalink:"/sdk/reference/interfaces/IElectionKeysResponse"}},d={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"census",id:"census",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"chainId",id:"chainid",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"creationTime",id:"creationtime",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"electionId",id:"electionid",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"electionMode",id:"electionmode",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"endDate",id:"enddate",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"finalResults",id:"finalresults",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"fromArchive",id:"fromarchive",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"manuallyEnded",id:"manuallyended",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"metadata",id:"metadata",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"metadataURL",id:"metadataurl",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"organizationId",id:"organizationid",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"result",id:"result",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"startDate",id:"startdate",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"tallyMode",id:"tallymode",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"voteCount",id:"votecount",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"voteMode",id:"votemode",level:3},{value:"Defined in",id:"defined-in-17",level:4}],s={toc:c};function p(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IElectionInfoResponse"),(0,a.kt)("h1",{id:"interface-ielectioninforesponse"},"Interface: IElectionInfoResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#census"},"census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#chainid"},"chainId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#creationtime"},"creationTime")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#electionid"},"electionId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#electionmode"},"electionMode")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#enddate"},"endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#finalresults"},"finalResults")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#fromarchive"},"fromArchive")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#manuallyended"},"manuallyEnded")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#metadata"},"metadata")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#metadataurl"},"metadataURL")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#organizationid"},"organizationId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#result"},"result")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#startdate"},"startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#status"},"status")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#tallymode"},"tallyMode")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#votecount"},"voteCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionInfoResponse#votemode"},"voteMode"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"census"},"census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"census"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus"},(0,a.kt)("inlineCode",{parentName:"a"},"ICensus"))),(0,a.kt)("p",null,"The census of the election"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L220"},"api/election.ts:220")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"chainid"},"chainId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"chainId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The chain identifier of the election"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L215"},"api/election.ts:215")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"creationtime"},"creationTime"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"creationTime"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The date of creation of the election"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L230"},"api/election.ts:230")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"electionid"},"electionId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"electionId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The id of the election"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L165"},"api/election.ts:165")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"electionmode"},"electionMode"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"electionMode"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionMode"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionMode"))),(0,a.kt)("p",null,"The election mode of the election"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L240"},"api/election.ts:240")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enddate"},"endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"endDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The end date of the election"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L185"},"api/election.ts:185")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"finalresults"},"finalResults"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"finalResults"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"If the election has the final results"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L195"},"api/election.ts:195")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"fromarchive"},"fromArchive"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"fromArchive"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"If the election comes from the archive"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L210"},"api/election.ts:210")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"manuallyended"},"manuallyEnded"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"manuallyEnded"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"If the election has been ended manually"),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L205"},"api/election.ts:205")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"metadata"},"metadata"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"metadata"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ElectionMetadata"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,a.kt)("p",null,"The metadata of the election"),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L250"},"api/election.ts:250")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"metadataurl"},"metadataURL"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"metadataURL"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The URL of the metadata"),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L225"},"api/election.ts:225")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"organizationid"},"organizationId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"organizationId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The id of the organization that created the election"),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L170"},"api/election.ts:170")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"result"},"result"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"result"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[][]"),(0,a.kt)("p",null,"The result of the election"),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L200"},"api/election.ts:200")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"startdate"},"startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"startDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The start date of the election"),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L180"},"api/election.ts:180")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"status"},"status"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"status"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#process_unknown"},(0,a.kt)("inlineCode",{parentName:"a"},"PROCESS_UNKNOWN"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#ended"},(0,a.kt)("inlineCode",{parentName:"a"},"ENDED"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#canceled"},(0,a.kt)("inlineCode",{parentName:"a"},"CANCELED"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#paused"},(0,a.kt)("inlineCode",{parentName:"a"},"PAUSED"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#results"},(0,a.kt)("inlineCode",{parentName:"a"},"RESULTS"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatusReady#ready"},(0,a.kt)("inlineCode",{parentName:"a"},"READY"))),(0,a.kt)("p",null,"The status of the election"),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L175"},"api/election.ts:175")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"tallymode"},"tallyMode"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"tallyMode"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ITallyMode"},(0,a.kt)("inlineCode",{parentName:"a"},"ITallyMode"))),(0,a.kt)("p",null,"The tally mode of the vote"),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L245"},"api/election.ts:245")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votecount"},"voteCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"voteCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of votes of the election"),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L190"},"api/election.ts:190")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votemode"},"voteMode"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"voteMode"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteMode"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteMode"))),(0,a.kt)("p",null,"The voting mode of the election"),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L235"},"api/election.ts:235")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b0d01e95.c215d981.js b/assets/js/b0d01e95.c215d981.js new file mode 100644 index 000000000..1cca37f93 --- /dev/null +++ b/assets/js/b0d01e95.c215d981.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1968],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>k});var i=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=i.createContext({}),p=function(e){var t=i.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},s=function(e){var t=p(e.components);return i.createElement(d.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},u=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,d=e.parentName,s=r(e,["components","mdxType","originalType","parentName"]),u=p(n),k=a,f=u["".concat(d,".").concat(k)]||u[k]||c[k]||l;return n?i.createElement(f,o(o({ref:t},s),{},{components:n})):i.createElement(f,o({ref:t},s))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,o=new Array(l);o[0]=u;var r={};for(var d in t)hasOwnProperty.call(t,d)&&(r[d]=t[d]);r.originalType=e,r.mdxType="string"==typeof e?e:a,o[1]=r;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>c,frontMatter:()=>l,metadata:()=>r,toc:()=>p});var i=n(87462),a=(n(67294),n(3905));const l={},o=void 0,r={unversionedId:"sdk/reference/interfaces/IElectionInfoResponse",id:"sdk/reference/interfaces/IElectionInfoResponse",title:"IElectionInfoResponse",description:"@vocdoni/sdk / Exports / IElectionInfoResponse",source:"@site/docs/sdk/reference/interfaces/IElectionInfoResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionInfoResponse",permalink:"/sdk/reference/interfaces/IElectionInfoResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionCreateResponse",permalink:"/sdk/reference/interfaces/IElectionCreateResponse"},next:{title:"IElectionKeysResponse",permalink:"/sdk/reference/interfaces/IElectionKeysResponse"}},d={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"census",id:"census",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"chainId",id:"chainid",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"creationTime",id:"creationtime",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"electionId",id:"electionid",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"electionMode",id:"electionmode",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"endDate",id:"enddate",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"finalResults",id:"finalresults",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"fromArchive",id:"fromarchive",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"manuallyEnded",id:"manuallyended",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"metadata",id:"metadata",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"metadataURL",id:"metadataurl",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"organizationId",id:"organizationid",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"result",id:"result",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"startDate",id:"startdate",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"tallyMode",id:"tallymode",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"voteCount",id:"votecount",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"voteMode",id:"votemode",level:3},{value:"Defined in",id:"defined-in-17",level:4}],s={toc:p};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IElectionInfoResponse"),(0,a.kt)("h1",{id:"interface-ielectioninforesponse"},"Interface: IElectionInfoResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#census"},"census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#chainid"},"chainId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#creationtime"},"creationTime")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#electionid"},"electionId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#electionmode"},"electionMode")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#enddate"},"endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#finalresults"},"finalResults")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#fromarchive"},"fromArchive")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#manuallyended"},"manuallyEnded")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#metadata"},"metadata")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#metadataurl"},"metadataURL")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#organizationid"},"organizationId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#result"},"result")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#startdate"},"startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#status"},"status")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#tallymode"},"tallyMode")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#votecount"},"voteCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionInfoResponse#votemode"},"voteMode"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"census"},"census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"census"),": ",(0,a.kt)("a",{parentName:"p",href:"ICensus"},(0,a.kt)("inlineCode",{parentName:"a"},"ICensus"))),(0,a.kt)("p",null,"The census of the election"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L220"},"api/election.ts:220")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"chainid"},"chainId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"chainId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The chain identifier of the election"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L215"},"api/election.ts:215")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"creationtime"},"creationTime"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"creationTime"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The date of creation of the election"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L230"},"api/election.ts:230")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"electionid"},"electionId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"electionId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The id of the election"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L165"},"api/election.ts:165")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"electionmode"},"electionMode"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"electionMode"),": ",(0,a.kt)("a",{parentName:"p",href:"IElectionMode"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionMode"))),(0,a.kt)("p",null,"The election mode of the election"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L240"},"api/election.ts:240")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enddate"},"endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"endDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The end date of the election"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L185"},"api/election.ts:185")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"finalresults"},"finalResults"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"finalResults"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"If the election has the final results"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L195"},"api/election.ts:195")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"fromarchive"},"fromArchive"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"fromArchive"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"If the election comes from the archive"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L210"},"api/election.ts:210")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"manuallyended"},"manuallyEnded"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"manuallyEnded"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"If the election has been ended manually"),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L205"},"api/election.ts:205")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"metadata"},"metadata"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"metadata"),": ",(0,a.kt)("a",{parentName:"p",href:"ElectionMetadata"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,a.kt)("p",null,"The metadata of the election"),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L250"},"api/election.ts:250")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"metadataurl"},"metadataURL"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"metadataURL"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The URL of the metadata"),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L225"},"api/election.ts:225")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"organizationid"},"organizationId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"organizationId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The id of the organization that created the election"),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L170"},"api/election.ts:170")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"result"},"result"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"result"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[][]"),(0,a.kt)("p",null,"The result of the election"),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L200"},"api/election.ts:200")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"startdate"},"startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"startDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The start date of the election"),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L180"},"api/election.ts:180")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"status"},"status"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"status"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#process_unknown"},(0,a.kt)("inlineCode",{parentName:"a"},"PROCESS_UNKNOWN"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#ended"},(0,a.kt)("inlineCode",{parentName:"a"},"ENDED"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#canceled"},(0,a.kt)("inlineCode",{parentName:"a"},"CANCELED"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#paused"},(0,a.kt)("inlineCode",{parentName:"a"},"PAUSED"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#results"},(0,a.kt)("inlineCode",{parentName:"a"},"RESULTS"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"../enums/ElectionStatusReady#ready"},(0,a.kt)("inlineCode",{parentName:"a"},"READY"))),(0,a.kt)("p",null,"The status of the election"),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L175"},"api/election.ts:175")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"tallymode"},"tallyMode"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"tallyMode"),": ",(0,a.kt)("a",{parentName:"p",href:"ITallyMode"},(0,a.kt)("inlineCode",{parentName:"a"},"ITallyMode"))),(0,a.kt)("p",null,"The tally mode of the vote"),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L245"},"api/election.ts:245")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votecount"},"voteCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"voteCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of votes of the election"),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L190"},"api/election.ts:190")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votemode"},"voteMode"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"voteMode"),": ",(0,a.kt)("a",{parentName:"p",href:"IVoteMode"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteMode"))),(0,a.kt)("p",null,"The voting mode of the election"),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L235"},"api/election.ts:235")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b16aadd2.0d579216.js b/assets/js/b16aadd2.0d579216.js new file mode 100644 index 000000000..f519466d1 --- /dev/null +++ b/assets/js/b16aadd2.0d579216.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7055],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var o=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function r(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=o.createContext({}),c=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},p=function(e){var t=c(e.components);return o.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},u=o.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(n),h=a,f=u["".concat(l,".").concat(h)]||u[h]||d[h]||i;return n?o.createElement(f,r(r({ref:t},p),{},{components:n})):o.createElement(f,r({ref:t},p))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,r=new Array(i);r[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,r[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var o=n(87462),a=(n(67294),n(3905));const i={},r="SDK Tutorial",s={unversionedId:"sdk/tutorial",id:"sdk/tutorial",title:"SDK Tutorial",description:"This tutorial will show you how to get your environment set up, start using the SDK, and create and vote in an election. We will be using typescript.",source:"@site/docs/sdk/01-tutorial.md",sourceDirName:"sdk",slug:"/sdk/tutorial",permalink:"/sdk/tutorial",draft:!1,tags:[],version:"current",sidebarPosition:1,frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Vocdoni SDK",permalink:"/sdk/"},next:{title:"Integration Details",permalink:"/sdk/integration-details/"}},l={},c=[{value:"Prerequisites",id:"prerequisites",level:3},{value:"Overview",id:"overview",level:2},{value:"Client",id:"client",level:2},{value:"Census",id:"census",level:2},{value:"Election",id:"election",level:2},{value:"Voting",id:"voting",level:2},{value:"Results",id:"results",level:2},{value:"Running the code",id:"running-the-code",level:2}],p={toc:c};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,o.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"sdk-tutorial"},"SDK Tutorial"),(0,a.kt)("p",null,"This tutorial will show you how to get your environment set up, start using the SDK, and create and vote in an election. We will be using typescript."),(0,a.kt)("h3",{id:"prerequisites"},"Prerequisites"),(0,a.kt)("p",null,"You'll need a working ",(0,a.kt)("a",{parentName:"p",href:"https://nodejs.org"},"nodejs")," environment, but other than that, you're\nfree to use any package manager (either npm, yarn, pnpm...). Let's start by creating a project and adding the SDK:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"# with yarn\nyarn add @vocdoni/sdk\n# with npm\nnpm i @vocdoni/sdk\n# with pnpm\npnpm add @vocdoni/sdk\n")),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"This project has been bundled into many formats in order for you to\nimport it based on the environment you're using it. When importing it via\n",(0,a.kt)("inlineCode",{parentName:"p"},"@vocdoni/sdk")," it will choose a version based on your current environment\n(commonjs or esm). There's also another UMD version which can be accessed via\n",(0,a.kt)("inlineCode",{parentName:"p"},"@vocdoni/sdk/umd")," in case you need it.")),(0,a.kt)("h2",{id:"overview"},"Overview"),(0,a.kt)("p",null,"The following are the main steps we need to implement:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Connecting a client to the Vocdoni network"),(0,a.kt)("li",{parentName:"ul"},"Creating a census with some random members"),(0,a.kt)("li",{parentName:"ul"},"Creating an election"),(0,a.kt)("li",{parentName:"ul"},"Sending votes"),(0,a.kt)("li",{parentName:"ul"},"Checking the election results")),(0,a.kt)("h2",{id:"client"},"Client"),(0,a.kt)("p",null,"The first step will be connecting to a Vocdoni ",(0,a.kt)("a",{parentName:"p",href:"/protocol#12-gateways"},"Gateway")," Node. We can do this easily with the ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient"},"VocdoniSDKClient"),". The client allows us to access all of the Vocdoni API calls."),(0,a.kt)("p",null,"In order to create a client, we need a ",(0,a.kt)("inlineCode",{parentName:"p"},"wallet"),", an envelope that holds a cryptographic key and enables our client to sign transactions for the blockchain. We'll be generating a random wallet with the ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/ethers-io/ethers.js"},"ethers")," signer."),(0,a.kt)("p",null,"We also need to define which Vocdoni ",(0,a.kt)("a",{parentName:"p",href:"/sdk/integration-details#environment"},"environment")," we will connect to. Staging is the ",(0,a.kt)("strong",{parentName:"p"},"recommended")," environment for most testing use cases, since the ",(0,a.kt)("inlineCode",{parentName:"p"},"dev")," environment is more subject to blockchain resets and downtimes than the ",(0,a.kt)("inlineCode",{parentName:"p"},"stg")," one."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/client.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export const getDefaultClient = () => {\n const wallet = Wallet.createRandom();\n const client = new VocdoniSDKClient({\n env: EnvOptions.STG,\n wallet: wallet,\n });\n\n return { wallet, client };\n};\n")),(0,a.kt)("p",null,"Now that we have a client connected to the ",(0,a.kt)("inlineCode",{parentName:"p"},"STG")," environment, we need to register its wallet to the blockchain with ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#createaccount"},"createAccount()"),". Parameters here are optional, but let's define a name and description."),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"An ",(0,a.kt)("inlineCode",{parentName:"p"},"Account")," can represent an organization hosting a voting process. There are many ",(0,a.kt)("a",{parentName:"p",href:"/protocol/data-schemes/organization"},"parameters")," we can optionally add, like ",(0,a.kt)("inlineCode",{parentName:"p"},"logo")," or even arbitrary ",(0,a.kt)("inlineCode",{parentName:"p"},"meta"),". This can all be displayed on a custom frontend implementation. Using ",(0,a.kt)("inlineCode",{parentName:"p"},"createAccount()")," on an account that already exists will fetch the account info from the blockchain.")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/account.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export const createAccount = (client: VocdoniSDKClient) => {\n return client\n .createAccount({\n account: new Account({\n languages: ['en'],\n name: {\n default: 'Account name',\n },\n description: 'Description of the account',\n logo: 'https://logo.io',\n }),\n })\n .then(() => client.fetchAccountInfo().then(info => console.log(info)));\n};\n")),(0,a.kt)("h2",{id:"census"},"Census"),(0,a.kt)("p",null,"With our client created and registered to the Vochain, the next step is to create a ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/census"},"census")," of voters. The protocol enables many ",(0,a.kt)("a",{parentName:"p",href:"/protocol/census"},"types of census")," and you can see how to implement each of them ",(0,a.kt)("a",{parentName:"p",href:"/sdk/integration-details/census-types"},"here"),". For our purposes it's easiest to use a ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/plaincensus"},"plain census"),", the simplest form of ",(0,a.kt)("a",{parentName:"p",href:"/sdk/integration-details/census-types/off-chain-tree"},"off-chain tree census"),"."),(0,a.kt)("p",null,"We can create a random wallet to represent each voter just like we did for the client, and then we can register each voter's address to the census. The voter wallets have to be saved in order to sign their individual votes."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/census.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export async function createCensus () {\n const census = new PlainCensus()\n\n // Create a list of random voters, register them to the census\n let voters: Wallet[] = []\n for (let i = 0; i < 5; i++) {\n voters.push(Wallet.createRandom())\n census.add(await voters[i].getAddress())\n }\n\n return { census, voters }\n}\n")),(0,a.kt)("h2",{id:"election"},"Election"),(0,a.kt)("p",null,"Creating a basic election is easy with ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#from"},"Election.from()"),". We just need to specify the title and description, a header photo, an end date, and the census we created earlier. We can specify some ",(0,a.kt)("inlineCode",{parentName:"p"},"electionType")," options, but this is not necessary as our election is using the default options. "),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/election.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export const createElection = (census: PlainCensus): UnpublishedElection => {\n const election: UnpublishedElection = Election.from({\n title: 'Election title',\n description: 'Election description',\n header: 'https://source.unsplash.com/random',\n endDate: new Date().getTime() + 100000,\n census,\n });\n ...\n")),(0,a.kt)("p",null," Questions can be added to an election with ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#addquestion"},"addQuestion"),". This is a single-choice (binary) election with only one question. "),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/election.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"...\n election.addQuestion('This is a title', 'This is a description', [\n {\n title: 'Option 1',\n value: 0\n },\n {\n title: 'Option 2',\n value: 1\n }\n ])\n\n return election\n}\n")),(0,a.kt)("p",null,"Once our election is defined, it has to be officially created on the blockchain with ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#createelection"},(0,a.kt)("inlineCode",{parentName:"a"},"client.CreateElection()")),". This will also provide us with a unique ",(0,a.kt)("inlineCode",{parentName:"p"},"electionID"),". We want to use ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#setelectionid"},(0,a.kt)("inlineCode",{parentName:"a"},"client.SetElectionID()"))," so that the client knows which voting process to submit votes to. "),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"Now that we have the ",(0,a.kt)("inlineCode",{parentName:"p"},"electionId"),", we can also print out a link to view our voting process on the Vocdoni blockchain ",(0,a.kt)("a",{parentName:"p",href:"https://stg.explorer.vote"},"explorer"),"! The explorer unlocks the universal verifiability of Vocdoni's protocol- even for this small example, the results of this election are verifiable by any observer and cannot be altered. ")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/election.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"const waitForElectionReady = (client: VocdoniSDKClient, electionId: string): Promise => {\n return new Promise(f => setTimeout(f, 5000))\n .then(() => client.fetchElection(electionId))\n .then(election => {\n if (election.status !== ElectionStatus.ONGOING) {\n return waitForElectionReady(client, electionId);\n }\n return Promise.resolve(electionId);\n });\n};\n")),(0,a.kt)("p",null,"Publishing an election registers a transaction to the blockchain. This means we have to wait for the next block to process in order to ensure the transaction was successful. Here we use ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#fetchelection"},"client.fetchElection()")," to fetch the election info from the blockchain, given our ",(0,a.kt)("inlineCode",{parentName:"p"},"electionId"),". This allows us to wait until the election status is ",(0,a.kt)("inlineCode",{parentName:"p"},"ONGOING"),", which means the election has been successfully published and has begun."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/election.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export const publishElection = (client: VocdoniSDKClient, election: UnpublishedElection): Promise => {\n return client.createElection(election).then(electionId => {\n client.setElectionId(electionId);\n console.log('Election created!', electionId);\n console.log('View this election at ' + client.explorerUrl + '/processes/show/#/' + electionId);\n console.log('Waiting for election to be published...');\n return waitForElectionReady(client, electionId);\n });\n};\n")),(0,a.kt)("h2",{id:"voting"},"Voting"),(0,a.kt)("p",null,"With the election published, it's time to vote. We can use each of the wallets that we saved earlier to cast a unique vote for that imaginary voter. We do this by first setting ",(0,a.kt)("inlineCode",{parentName:"p"},"client.wallet = voter"),", telling the client which wallet to use for bundling and submitting this vote. "),(0,a.kt)("p",null,"The we create the vote itself. A ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/vote"},"Vote")," is simply a list of values whose form depends on the type and number of questions in the election."),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"For more info on vote types, see our section on the ",(0,a.kt)("a",{parentName:"p",href:"/protocol/ballot-protocol"},"Ballot Protocol"))),(0,a.kt)("p",null,"Then we can simply call ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#submitvote"},(0,a.kt)("inlineCode",{parentName:"a"},"client.submitVote()")),", and the SDK handles the creation, signing, and submission of the vote package. It returns a ",(0,a.kt)("inlineCode",{parentName:"p"},"voteId")," which can be used to ensure the vote was correctly counted. "),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/vote.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export const castVotes = (electionId: string, voters: Wallet[]) => {\n var votePromises = [];\n for (const voter of voters) {\n const client = new VocdoniSDKClient({ env: EnvOptions.STG, wallet: voter, electionId: electionId });\n // Create a vote for option 0 or 1\n const vote = new Vote([Math.round(Math.random())]);\n votePromises.push(\n client.submitVote(vote).then(voteId => {\n console.log('Vote sent! Vote id: ', voteId);\n console.log('Verify vote at ' + client.explorerUrl + '/verify/#/' + voteId);\n })\n );\n }\n return Promise.all(votePromises);\n};\n")),(0,a.kt)("h2",{id:"results"},"Results"),(0,a.kt)("p",null,"All that's left is checking the results of this election! ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#fetchelection"},(0,a.kt)("inlineCode",{parentName:"a"},"client.fetchElection()"))," returns an object with a simple array of results values- it's up to you to decide how to display them. "),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"Note that the results are available immediately because this election was configured with ",(0,a.kt)("inlineCode",{parentName:"p"},"secretUntilTheEnd=false"))),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/vote.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export const countVotes = (client: VocdoniSDKClient) => {\n return client.fetchElection().then(election => {\n console.log('Election results: ');\n election.questions.forEach(question => {\n question.choices.forEach(choice => {\n console.log(choice.title.default + ': ' + choice.results);\n });\n });\n });\n};\n")),(0,a.kt)("h2",{id:"running-the-code"},"Running the code"),(0,a.kt)("p",null,"Here's a program that combines all the above functions into a working prototype:"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"src/index.ts")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"async function main () {\n console.log('Initializing client...');\n const { client } = getDefaultClient();\n\n console.log('Creating account...');\n await createAccount(client);\n\n console.log('Creating census with some random wallets...');\n const { census, voters } = await createCensus();\n\n console.log('Creating election...');\n const election = createElection(census);\n const electionId = await publishElection(client, election);\n\n console.log('Voting...');\n await castVotes(electionId, voters);\n\n console.log('Getting results...');\n await countVotes(client);\n}\nmain();\n")),(0,a.kt)("p",null,"All we have to do is run "),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"tutorial $ yarn start\nyarn run v1.22.17\n$ ts-node src/index.ts\nInitializing client...\nCreating account...\n{\n account: Account {\n _languages: [ 'en' ],\n _name: { default: 'Account name' },\n _description: { default: 'Description of the account' },\n _feed: { default: '' },\n _header: '',\n _avatar: '',\n _logo: 'https://logo.io',\n _meta: []\n },\n address: '73b3e1ff1602c6ece34f9b75aa86f5f90b41a209',\n nonce: 0,\n balance: 50,\n electionIndex: 0,\n infoURL: 'ipfs://bafybeif5mbhhwuju2pyd54bxhn3tdsj6m5cukx6f5xvchqfh2wvzkpbjpy',\n metadata: {\n version: '1.0',\n languages: [ 'en' ],\n name: { default: 'Account name' },\n description: { default: 'Description of the account' },\n newsFeed: { default: '' },\n media: { logo: 'https://logo.io' },\n meta: {}\n },\n sik: 'c5321163e98108424f5c25e55980a1ea4811029c1ff72cae95f113dfc95fac22'\n}\nCreating census with some random wallets...\nCreating election...\nElection created! 4ae20a8eb4ca73b3e1ff1602c6ece34f9b75aa86f5f90b41a209020000000000\nView this election at https://stg.explorer.vote/processes/show/#/4ae20a8eb4ca73b3e1ff1602c6ece34f9b75aa86f5f90b41a209020000000000\nWaiting for election to be published...\nVoting...\nVote sent! Vote id: 2fae8af3b02ec78af5a3bf06ec4aff1b7c000a1356a0aff1c07163da23f3d771\nVerify vote at https://stg.explorer.vote/verify/#/2fae8af3b02ec78af5a3bf06ec4aff1b7c000a1356a0aff1c07163da23f3d771\nVote sent! Vote id: 8af200d25a159c9d862e84064a4d977df2b10ea23ffb32ddc2de18b9142df0b6\nVerify vote at https://stg.explorer.vote/verify/#/8af200d25a159c9d862e84064a4d977df2b10ea23ffb32ddc2de18b9142df0b6\nVote sent! Vote id: 3cae37ec5c49ce338bcbc40b5102cf33bf9304c19c3f5e650c7c469b72664fc8\nVerify vote at https://stg.explorer.vote/verify/#/3cae37ec5c49ce338bcbc40b5102cf33bf9304c19c3f5e650c7c469b72664fc8\nVote sent! Vote id: 937911458a52393b75f1428ec1613d3a481112491c51bfcc033e2f0009341022\nVerify vote at https://stg.explorer.vote/verify/#/937911458a52393b75f1428ec1613d3a481112491c51bfcc033e2f0009341022\nVote sent! Vote id: a6e4f4fe0f0e56d41fc21c62473718c9fbbe4c451a6fd9c19dbfca1fef0dac8c\nVerify vote at https://stg.explorer.vote/verify/#/a6e4f4fe0f0e56d41fc21c62473718c9fbbe4c451a6fd9c19dbfca1fef0dac8c\nGetting results...\nElection results:\nOption 1: 2\nOption 2: 3\n\u2728 Done in 45.08s.\n")),(0,a.kt)("p",null,"You can even check out the ",(0,a.kt)("a",{parentName:"p",href:"https://stg.explorer.vote/processes/show/#/4ae20a8eb4ca73b3e1ff1602c6ece34f9b75aa86f5f90b41a209020000000000"},"election I created")," on the blockchain explorer. "),(0,a.kt)("p",null,"Now that you've created a basic example with the SDK, you can integrate this functionality into your own applications. For more details, check out the ",(0,a.kt)("a",{parentName:"p",href:"/sdk/integration-details"},"integration details")," section and the more extensive ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/examples"},"examples")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b2b5a0c0.f9c277cf.js b/assets/js/b2b5a0c0.d73732d4.js similarity index 78% rename from assets/js/b2b5a0c0.f9c277cf.js rename to assets/js/b2b5a0c0.d73732d4.js index 0c24ab668..e2afab9cc 100644 --- a/assets/js/b2b5a0c0.f9c277cf.js +++ b/assets/js/b2b5a0c0.d73732d4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1270],{3905:(e,n,t)=>{t.d(n,{Zo:()=>l,kt:()=>d});var r=t(67294);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function a(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var c=r.createContext({}),p=function(e){var n=r.useContext(c),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},l=function(e){var n=p(e.components);return r.createElement(c.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},f=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,i=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),f=p(t),d=o,m=f["".concat(c,".").concat(d)]||f[d]||u[d]||i;return t?r.createElement(m,a(a({ref:n},l),{},{components:t})):r.createElement(m,a({ref:n},l))}));function d(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var i=t.length,a=new Array(i);a[0]=f;var s={};for(var c in n)hasOwnProperty.call(n,c)&&(s[c]=n[c]);s.originalType=e,s.mdxType="string"==typeof e?e:o,a[1]=s;for(var p=2;p{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var r=t(87462),o=(t(67294),t(3905));const i={},a=void 0,s={unversionedId:"sdk/reference/interfaces/IChainOrganizationCountResponse",id:"sdk/reference/interfaces/IChainOrganizationCountResponse",title:"IChainOrganizationCountResponse",description:"@vocdoni/sdk / Exports / IChainOrganizationCountResponse",source:"@site/docs/sdk/reference/interfaces/IChainOrganizationCountResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainOrganizationCountResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationCountResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainGetInfoResponse",permalink:"/sdk/reference/interfaces/IChainGetInfoResponse"},next:{title:"IChainOrganizationListResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationListResponse"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"count",id:"count",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function u(e){let{components:n,...t}=e;return(0,o.kt)("wrapper",(0,r.Z)({},l,t,{components:n,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IChainOrganizationCountResponse"),(0,o.kt)("h1",{id:"interface-ichainorganizationcountresponse"},"Interface: IChainOrganizationCountResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainOrganizationCountResponse#count"},"count"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"count"},"count"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"count"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"The number of organizations"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L241"},"api/chain.ts:241")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1270],{3905:(e,n,t)=>{t.d(n,{Zo:()=>l,kt:()=>d});var r=t(67294);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function a(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var c=r.createContext({}),p=function(e){var n=r.useContext(c),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},l=function(e){var n=p(e.components);return r.createElement(c.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},f=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,i=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),f=p(t),d=o,m=f["".concat(c,".").concat(d)]||f[d]||u[d]||i;return t?r.createElement(m,a(a({ref:n},l),{},{components:t})):r.createElement(m,a({ref:n},l))}));function d(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var i=t.length,a=new Array(i);a[0]=f;var s={};for(var c in n)hasOwnProperty.call(n,c)&&(s[c]=n[c]);s.originalType=e,s.mdxType="string"==typeof e?e:o,a[1]=s;for(var p=2;p{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var r=t(87462),o=(t(67294),t(3905));const i={},a=void 0,s={unversionedId:"sdk/reference/interfaces/IChainOrganizationCountResponse",id:"sdk/reference/interfaces/IChainOrganizationCountResponse",title:"IChainOrganizationCountResponse",description:"@vocdoni/sdk / Exports / IChainOrganizationCountResponse",source:"@site/docs/sdk/reference/interfaces/IChainOrganizationCountResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainOrganizationCountResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationCountResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainGetInfoResponse",permalink:"/sdk/reference/interfaces/IChainGetInfoResponse"},next:{title:"IChainOrganizationListResponse",permalink:"/sdk/reference/interfaces/IChainOrganizationListResponse"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"count",id:"count",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function u(e){let{components:n,...t}=e;return(0,o.kt)("wrapper",(0,r.Z)({},l,t,{components:n,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IChainOrganizationCountResponse"),(0,o.kt)("h1",{id:"interface-ichainorganizationcountresponse"},"Interface: IChainOrganizationCountResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IChainOrganizationCountResponse#count"},"count"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"count"},"count"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"count"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"number")),(0,o.kt)("p",null,"The number of organizations"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L241"},"api/chain.ts:241")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b3153972.66abcd64.js b/assets/js/b3153972.b68a81b9.js similarity index 75% rename from assets/js/b3153972.66abcd64.js rename to assets/js/b3153972.b68a81b9.js index 639da4a72..fef62e93d 100644 --- a/assets/js/b3153972.66abcd64.js +++ b/assets/js/b3153972.b68a81b9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7631],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>d});var n=r(67294);function s(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t=0||(s[r]=e[r]);return s}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(s[r]=e[r])}return s}var p=n.createContext({}),c=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},l=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,s=e.mdxType,i=e.originalType,p=e.parentName,l=o(e,["components","mdxType","originalType","parentName"]),f=c(r),d=s,g=f["".concat(p,".").concat(d)]||f[d]||u[d]||i;return r?n.createElement(g,a(a({ref:t},l),{},{components:r})):n.createElement(g,a({ref:t},l))}));function d(e,t){var r=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var i=r.length,a=new Array(i);a[0]=f;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:s,a[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var n=r(87462),s=(r(67294),r(3905));const i={},a=void 0,o={unversionedId:"sdk/reference/interfaces/ICensus3StrategiesListResponse",id:"sdk/reference/interfaces/ICensus3StrategiesListResponse",title:"ICensus3StrategiesListResponse",description:"@vocdoni/sdk / Exports / ICensus3StrategiesListResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategiesListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategiesListResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategiesListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3ServiceInfoResponse",permalink:"/sdk/reference/interfaces/ICensus3ServiceInfoResponse"},next:{title:"ICensus3StrategiesListResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"strategies",id:"strategies",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:c};function u(e){let{components:t,...r}=e;return(0,s.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3StrategiesListResponse"),(0,s.kt)("h1",{id:"interface-icensus3strategieslistresponse"},"Interface: ICensus3StrategiesListResponse"),(0,s.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("p",{parentName:"li"},(0,s.kt)("strong",{parentName:"p"},(0,s.kt)("inlineCode",{parentName:"strong"},"ICensus3StrategiesListResponse"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated"},(0,s.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesListResponsePaginated"))))),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategiesListResponse#strategies"},"strategies"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"strategies"},"strategies"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"strategies"),": ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3strategy"},(0,s.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),"[]"),(0,s.kt)("p",null,"The list of the strategies identifiers"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L22"},"api/census3/strategy.ts:22")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7631],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>d});var n=r(67294);function s(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t=0||(s[r]=e[r]);return s}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(s[r]=e[r])}return s}var p=n.createContext({}),c=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},l=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,s=e.mdxType,i=e.originalType,p=e.parentName,l=o(e,["components","mdxType","originalType","parentName"]),f=c(r),d=s,g=f["".concat(p,".").concat(d)]||f[d]||u[d]||i;return r?n.createElement(g,a(a({ref:t},l),{},{components:r})):n.createElement(g,a({ref:t},l))}));function d(e,t){var r=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var i=r.length,a=new Array(i);a[0]=f;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:s,a[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var n=r(87462),s=(r(67294),r(3905));const i={},a=void 0,o={unversionedId:"sdk/reference/interfaces/ICensus3StrategiesListResponse",id:"sdk/reference/interfaces/ICensus3StrategiesListResponse",title:"ICensus3StrategiesListResponse",description:"@vocdoni/sdk / Exports / ICensus3StrategiesListResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategiesListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategiesListResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategiesListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3ServiceInfoResponse",permalink:"/sdk/reference/interfaces/ICensus3ServiceInfoResponse"},next:{title:"ICensus3StrategiesListResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"strategies",id:"strategies",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:c};function u(e){let{components:t,...r}=e;return(0,s.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3StrategiesListResponse"),(0,s.kt)("h1",{id:"interface-icensus3strategieslistresponse"},"Interface: ICensus3StrategiesListResponse"),(0,s.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("p",{parentName:"li"},(0,s.kt)("strong",{parentName:"p"},(0,s.kt)("inlineCode",{parentName:"strong"},"ICensus3StrategiesListResponse"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("a",{parentName:"p",href:"ICensus3StrategiesListResponsePaginated"},(0,s.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesListResponsePaginated"))))),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus3StrategiesListResponse#strategies"},"strategies"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"strategies"},"strategies"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"strategies"),": ",(0,s.kt)("a",{parentName:"p",href:"../modules#census3strategy"},(0,s.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),"[]"),(0,s.kt)("p",null,"The list of the strategies identifiers"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L22"},"api/census3/strategy.ts:22")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b491e6b8.8ade34df.js b/assets/js/b491e6b8.8ade34df.js new file mode 100644 index 000000000..c76c6f202 --- /dev/null +++ b/assets/js/b491e6b8.8ade34df.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2859],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),u=p(n),f=i,m=u["".concat(s,".").concat(f)]||u[f]||d[f]||a;return n?r.createElement(m,l(l({ref:t},c),{},{components:n})):r.createElement(m,l({ref:t},c))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>a,metadata:()=>o,toc:()=>p});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IChoice",id:"sdk/reference/interfaces/IChoice",title:"IChoice",description:"@vocdoni/sdk / Exports / IChoice",source:"@site/docs/sdk/reference/interfaces/IChoice.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChoice",permalink:"/sdk/reference/interfaces/IChoice",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainValidatorsListResponse",permalink:"/sdk/reference/interfaces/IChainValidatorsListResponse"},next:{title:"IElectionCreateResponse",permalink:"/sdk/reference/interfaces/IElectionCreateResponse"}},s={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"answer",id:"answer",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"results",id:"results",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"value",id:"value",level:3},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:p};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IChoice"),(0,i.kt)("h1",{id:"interface-ichoice"},"Interface: IChoice"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IChoice#answer"},"answer")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IChoice#results"},"results")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IChoice#title"},"title")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IChoice#value"},"value"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"answer"},"answer"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"answer"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L27"},"types/metadata/election.ts:27")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"results"},"results"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"results"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L26"},"types/metadata/election.ts:26")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L24"},"types/metadata/election.ts:24")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"value"},"value"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"value"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L25"},"types/metadata/election.ts:25")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b491e6b8.b148c371.js b/assets/js/b491e6b8.b148c371.js deleted file mode 100644 index c189d995c..000000000 --- a/assets/js/b491e6b8.b148c371.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2859],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),c=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),u=c(n),f=i,k=u["".concat(s,".").concat(f)]||u[f]||d[f]||a;return n?r.createElement(k,l(l({ref:t},p),{},{components:n})):r.createElement(k,l({ref:t},p))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>a,metadata:()=>o,toc:()=>c});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IChoice",id:"sdk/reference/interfaces/IChoice",title:"IChoice",description:"@vocdoni/sdk / Exports / IChoice",source:"@site/docs/sdk/reference/interfaces/IChoice.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChoice",permalink:"/sdk/reference/interfaces/IChoice",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainValidatorsListResponse",permalink:"/sdk/reference/interfaces/IChainValidatorsListResponse"},next:{title:"IElectionCreateResponse",permalink:"/sdk/reference/interfaces/IElectionCreateResponse"}},s={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"answer",id:"answer",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"results",id:"results",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"value",id:"value",level:3},{value:"Defined in",id:"defined-in-3",level:4}],p={toc:c};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IChoice"),(0,i.kt)("h1",{id:"interface-ichoice"},"Interface: IChoice"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChoice#answer"},"answer")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChoice#results"},"results")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChoice#title"},"title")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChoice#value"},"value"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"answer"},"answer"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"answer"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L27"},"types/metadata/election.ts:27")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"results"},"results"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"results"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L26"},"types/metadata/election.ts:26")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L24"},"types/metadata/election.ts:24")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"value"},"value"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"value"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L25"},"types/metadata/election.ts:25")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b5881b04.7cbb02d3.js b/assets/js/b5881b04.7cbb02d3.js new file mode 100644 index 000000000..e0a0ea012 --- /dev/null +++ b/assets/js/b5881b04.7cbb02d3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9589],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var p=r.createContext({}),c=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=c(n),f=i,k=u["".concat(p,".").concat(f)]||u[f]||s[f]||a;return n?r.createElement(k,o(o({ref:t},d),{},{components:n})):r.createElement(k,o({ref:t},d))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:i,o[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var r=n(87462),i=(n(67294),n(3905));const a={},o=void 0,l={unversionedId:"sdk/reference/interfaces/IElectionMode",id:"sdk/reference/interfaces/IElectionMode",title:"IElectionMode",description:"@vocdoni/sdk / Exports / IElectionMode",source:"@site/docs/sdk/reference/interfaces/IElectionMode.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionMode",permalink:"/sdk/reference/interfaces/IElectionMode",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionListResponse",permalink:"/sdk/reference/interfaces/IElectionListResponse"},next:{title:"IElectionNextIdResponse",permalink:"/sdk/reference/interfaces/IElectionNextIdResponse"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"autoStart",id:"autostart",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"dynamicCensus",id:"dynamiccensus",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"encryptedMetaData",id:"encryptedmetadata",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"interruptible",id:"interruptible",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"preRegister",id:"preregister",level:3},{value:"Defined in",id:"defined-in-4",level:4}],d={toc:c};function s(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IElectionMode"),(0,i.kt)("h1",{id:"interface-ielectionmode"},"Interface: IElectionMode"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IElectionMode#autostart"},"autoStart")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IElectionMode#dynamiccensus"},"dynamicCensus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IElectionMode#encryptedmetadata"},"encryptedMetaData")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IElectionMode#interruptible"},"interruptible")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IElectionMode#preregister"},"preRegister"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"autostart"},"autoStart"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"autoStart"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"If the election should start automatically"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L75"},"api/election.ts:75")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"dynamiccensus"},"dynamicCensus"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"dynamicCensus"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"If the election has a dynamic census"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L85"},"api/election.ts:85")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"encryptedmetadata"},"encryptedMetaData"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"encryptedMetaData"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"If the election has encrypted metadata"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L90"},"api/election.ts:90")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"interruptible"},"interruptible"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"interruptible"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"If the election is interruptible"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L80"},"api/election.ts:80")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"preregister"},"preRegister"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"preRegister"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"If the election has preregister phase"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L95"},"api/election.ts:95")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b5881b04.eedec913.js b/assets/js/b5881b04.eedec913.js deleted file mode 100644 index 15d20d31e..000000000 --- a/assets/js/b5881b04.eedec913.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9589],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=r.createContext({}),p=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(c.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,c=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=p(n),f=i,k=u["".concat(c,".").concat(f)]||u[f]||s[f]||a;return n?r.createElement(k,o(o({ref:t},d),{},{components:n})):r.createElement(k,o({ref:t},d))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=u;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l.mdxType="string"==typeof e?e:i,o[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>s,frontMatter:()=>a,metadata:()=>l,toc:()=>p});var r=n(87462),i=(n(67294),n(3905));const a={},o=void 0,l={unversionedId:"sdk/reference/interfaces/IElectionMode",id:"sdk/reference/interfaces/IElectionMode",title:"IElectionMode",description:"@vocdoni/sdk / Exports / IElectionMode",source:"@site/docs/sdk/reference/interfaces/IElectionMode.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionMode",permalink:"/sdk/reference/interfaces/IElectionMode",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionListResponse",permalink:"/sdk/reference/interfaces/IElectionListResponse"},next:{title:"IElectionNextIdResponse",permalink:"/sdk/reference/interfaces/IElectionNextIdResponse"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"autoStart",id:"autostart",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"dynamicCensus",id:"dynamiccensus",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"encryptedMetaData",id:"encryptedmetadata",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"interruptible",id:"interruptible",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"preRegister",id:"preregister",level:3},{value:"Defined in",id:"defined-in-4",level:4}],d={toc:p};function s(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IElectionMode"),(0,i.kt)("h1",{id:"interface-ielectionmode"},"Interface: IElectionMode"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionMode#autostart"},"autoStart")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionMode#dynamiccensus"},"dynamicCensus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionMode#encryptedmetadata"},"encryptedMetaData")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionMode#interruptible"},"interruptible")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionMode#preregister"},"preRegister"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"autostart"},"autoStart"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"autoStart"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"If the election should start automatically"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L75"},"api/election.ts:75")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"dynamiccensus"},"dynamicCensus"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"dynamicCensus"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"If the election has a dynamic census"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L85"},"api/election.ts:85")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"encryptedmetadata"},"encryptedMetaData"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"encryptedMetaData"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"If the election has encrypted metadata"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L90"},"api/election.ts:90")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"interruptible"},"interruptible"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"interruptible"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"If the election is interruptible"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L80"},"api/election.ts:80")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"preregister"},"preRegister"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"preRegister"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"If the election has preregister phase"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L95"},"api/election.ts:95")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b7cc9ed0.028d2d3f.js b/assets/js/b7cc9ed0.028d2d3f.js deleted file mode 100644 index a1a66b994..000000000 --- a/assets/js/b7cc9ed0.028d2d3f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9097],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),d=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},c=function(e){var t=d(e.components);return r.createElement(s.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,l=e.originalType,s=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),u=d(n),m=i,k=u["".concat(s,".").concat(m)]||u[m]||p[m]||l;return n?r.createElement(k,a(a({ref:t},c),{},{components:n})):r.createElement(k,a({ref:t},c))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=n.length,a=new Array(l);a[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:i,a[1]=o;for(var d=2;d{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>p,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var r=n(87462),i=(n(67294),n(3905));const l={},a=void 0,o={unversionedId:"sdk/reference/enums/ElectionStatus",id:"sdk/reference/enums/ElectionStatus",title:"ElectionStatus",description:"@vocdoni/sdk / Exports / ElectionStatus",source:"@site/docs/sdk/reference/enums/ElectionStatus.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/ElectionStatus",permalink:"/sdk/reference/enums/ElectionStatus",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ElectionResultsTypeNames",permalink:"/sdk/reference/enums/ElectionResultsTypeNames"},next:{title:"ElectionStatusReady",permalink:"/sdk/reference/enums/ElectionStatusReady"}},s={},d=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"CANCELED",id:"canceled",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ENDED",id:"ended",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ONGOING",id:"ongoing",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"PAUSED",id:"paused",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"PROCESS_UNKNOWN",id:"process_unknown",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"RESULTS",id:"results",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"UPCOMING",id:"upcoming",level:3},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:d};function p(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ElectionStatus"),(0,i.kt)("h1",{id:"enumeration-electionstatus"},"Enumeration: ElectionStatus"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionStatus#canceled"},"CANCELED")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionStatus#ended"},"ENDED")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionStatus#ongoing"},"ONGOING")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionStatus#paused"},"PAUSED")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionStatus#process_unknown"},"PROCESS","_","UNKNOWN")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionStatus#results"},"RESULTS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionStatus#upcoming"},"UPCOMING"))),(0,i.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,i.kt)("h3",{id:"canceled"},"CANCELED"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"CANCELED")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"CANCELED"')),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L15"},"types/election/published.ts:15")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ended"},"ENDED"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ENDED")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"ENDED"')),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L14"},"types/election/published.ts:14")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ongoing"},"ONGOING"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ONGOING")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"ONGOING"')),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L13"},"types/election/published.ts:13")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"paused"},"PAUSED"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"PAUSED")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"PAUSED"')),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L16"},"types/election/published.ts:16")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"process_unknown"},"PROCESS","_","UNKNOWN"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"PROCESS","_","UNKNOWN")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"PROCESS_UNKNOWN"')),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L11"},"types/election/published.ts:11")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"results"},"RESULTS"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"RESULTS")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"RESULTS"')),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L17"},"types/election/published.ts:17")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"upcoming"},"UPCOMING"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"UPCOMING")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"UPCOMING"')),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L12"},"types/election/published.ts:12")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b7cc9ed0.42e14c12.js b/assets/js/b7cc9ed0.42e14c12.js new file mode 100644 index 000000000..0d8e6ed78 --- /dev/null +++ b/assets/js/b7cc9ed0.42e14c12.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9097],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var i=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function a(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=i.createContext({}),p=function(e){var t=i.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},d=function(e){var t=p(e.components);return i.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},c=i.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,s=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),c=p(n),m=r,k=c["".concat(s,".").concat(m)]||c[m]||u[m]||l;return n?i.createElement(k,a(a({ref:t},d),{},{components:n})):i.createElement(k,a({ref:t},d))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,a=new Array(l);a[0]=c;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:r,a[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>u,frontMatter:()=>l,metadata:()=>o,toc:()=>p});var i=n(87462),r=(n(67294),n(3905));const l={},a=void 0,o={unversionedId:"sdk/reference/enums/ElectionStatus",id:"sdk/reference/enums/ElectionStatus",title:"ElectionStatus",description:"@vocdoni/sdk / Exports / ElectionStatus",source:"@site/docs/sdk/reference/enums/ElectionStatus.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/ElectionStatus",permalink:"/sdk/reference/enums/ElectionStatus",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ElectionResultsTypeNames",permalink:"/sdk/reference/enums/ElectionResultsTypeNames"},next:{title:"ElectionStatusReady",permalink:"/sdk/reference/enums/ElectionStatusReady"}},s={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"CANCELED",id:"canceled",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ENDED",id:"ended",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ONGOING",id:"ongoing",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"PAUSED",id:"paused",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"PROCESS_UNKNOWN",id:"process_unknown",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"RESULTS",id:"results",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"UPCOMING",id:"upcoming",level:3},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:p};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,i.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ElectionStatus"),(0,r.kt)("h1",{id:"enumeration-electionstatus"},"Enumeration: ElectionStatus"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionStatus#canceled"},"CANCELED")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionStatus#ended"},"ENDED")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionStatus#ongoing"},"ONGOING")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionStatus#paused"},"PAUSED")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionStatus#process_unknown"},"PROCESS","_","UNKNOWN")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionStatus#results"},"RESULTS")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ElectionStatus#upcoming"},"UPCOMING"))),(0,r.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,r.kt)("h3",{id:"canceled"},"CANCELED"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"CANCELED")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"CANCELED"')),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L15"},"types/election/published.ts:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ended"},"ENDED"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ENDED")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"ENDED"')),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L14"},"types/election/published.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ongoing"},"ONGOING"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ONGOING")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"ONGOING"')),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L13"},"types/election/published.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"paused"},"PAUSED"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"PAUSED")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"PAUSED"')),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L16"},"types/election/published.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"process_unknown"},"PROCESS","_","UNKNOWN"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"PROCESS","_","UNKNOWN")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"PROCESS_UNKNOWN"')),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L11"},"types/election/published.ts:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"results"},"RESULTS"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"RESULTS")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"RESULTS"')),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L17"},"types/election/published.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"upcoming"},"UPCOMING"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"UPCOMING")," = ",(0,r.kt)("inlineCode",{parentName:"p"},'"UPCOMING"')),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L12"},"types/election/published.ts:12")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b7def961.76601344.js b/assets/js/b7def961.76601344.js new file mode 100644 index 000000000..c390bdc08 --- /dev/null +++ b/assets/js/b7def961.76601344.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1011],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var a=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=a.createContext({}),c=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=c(e.components);return a.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},p=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,s=e.parentName,d=r(e,["components","mdxType","originalType","parentName"]),p=c(n),m=o,h=p["".concat(s,".").concat(m)]||p[m]||u[m]||i;return n?a.createElement(h,l(l({ref:t},d),{},{components:n})):a.createElement(h,l({ref:t},d))}));function m(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,l=new Array(i);l[0]=p;var r={};for(var s in t)hasOwnProperty.call(t,s)&&(r[s]=t[s]);r.originalType=e,r.mdxType="string"==typeof e?e:o,l[1]=r;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>c});var a=n(87462),o=(n(67294),n(3905));const i={},l="Integration Details",r={unversionedId:"sdk/integration-details/integration-details",id:"sdk/integration-details/integration-details",title:"Integration Details",description:"The tutorial covers the basics, but here are some details you'll need to consider when integrating the Vocdoni SDK into your application.",source:"@site/docs/sdk/integration-details/integration-details.md",sourceDirName:"sdk/integration-details",slug:"/sdk/integration-details/",permalink:"/sdk/integration-details/",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"SDK Tutorial",permalink:"/sdk/tutorial"},next:{title:"Census Types",permalink:"/sdk/integration-details/census-types/"}},s={},c=[{value:"Vocdoni Tokens",id:"vocdoni-tokens",level:2},{value:"Census Types",id:"census-types",level:2},{value:"Anonymous Voting",id:"anonymous-voting",level:2},{value:"Election Types",id:"election-types",level:2},{value:"Environment",id:"environment",level:2},{value:"Production",id:"production",level:4},{value:"Staging",id:"staging",level:4},{value:"Development",id:"development",level:4},{value:"Election Status",id:"election-status",level:2},{value:"Pause",id:"pause",level:4},{value:"Cancel",id:"cancel",level:4},{value:"End",id:"end",level:4},{value:"Continue",id:"continue",level:4},{value:"Other SDK Tools",id:"other-sdk-tools",level:2},{value:"Generate a random Wallet",id:"generate-a-random-wallet",level:4},{value:"Generate deterministic Wallet from data",id:"generate-deterministic-wallet-from-data",level:4}],d={toc:c};function u(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"integration-details"},"Integration Details"),(0,o.kt)("p",null,"The tutorial covers the basics, but here are some details you'll need to consider when integrating the Vocdoni SDK into your application."),(0,o.kt)("h2",{id:"vocdoni-tokens"},"Vocdoni Tokens"),(0,o.kt)("p",null,"Running voting processes in the production environment requires the use of Vocdoni Tokens. Read the guide ",(0,o.kt)("a",{parentName:"p",href:"integration-details/vocdoni-tokens"},"here"),"."),(0,o.kt)("h2",{id:"census-types"},"Census Types"),(0,o.kt)("p",null,"There are many ways to define a census of voters using the Vocdoni SDK. Each census type has different design considerations and use-cases. Read the guide ",(0,o.kt)("a",{parentName:"p",href:"integration-details/census-types"},"here")),(0,o.kt)("h2",{id:"anonymous-voting"},"Anonymous Voting"),(0,o.kt)("p",null,"Anonymous voting is available in some form with all three census types, with the strongest anonymity being anonymous off-chain Merkle tree elections. Minor modifications are usually necessary to convert censuses to being fully anonymous. Read the section on ",(0,o.kt)("a",{parentName:"p",href:"integration-details/census-types"},"census types")," to see how to enable anonymity."),(0,o.kt)("h2",{id:"election-types"},"Election Types"),(0,o.kt)("p",null,"The Vocdoni ",(0,o.kt)("a",{parentName:"p",href:"/protocol/ballot-protocol"},"Ballot Protocol")," provides a flexible way to define many types of election. Check out ",(0,o.kt)("a",{parentName:"p",href:"/sdk/integration-details/voting-types"},"Voting Types")," for an overview of the possibilities, including ranked-choice, quadratic, weighted, and approval voting."),(0,o.kt)("h2",{id:"environment"},"Environment"),(0,o.kt)("h4",{id:"production"},"Production"),(0,o.kt)("p",null,"This is the environment for any production use cases. This environment is slightly more complicated to use, as it requires the manual use of ",(0,o.kt)("a",{parentName:"p",href:"/sdk/integration-details#vocdoni-tokens"},"Vocdoni Tokens")),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"const client = new VocdoniSDKClient({\n env: EnvOptions.PROD, // mandatory, can be 'dev', 'stg', or 'prod'\n wallet: signer, // optional, the signer used (Metamask, Walletconnect)\n})\n")),(0,o.kt)("h4",{id:"staging"},"Staging"),(0,o.kt)("p",null,"This is the ",(0,o.kt)("strong",{parentName:"p"},"recommended")," environment for most testing use cases, since the\n",(0,o.kt)("inlineCode",{parentName:"p"},"dev")," environment is more subject to blockchain resets and downtimes than\nthe ",(0,o.kt)("inlineCode",{parentName:"p"},"stg")," one."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"const client = new VocdoniSDKClient({\n env: EnvOptions.STG, // mandatory, can be 'dev', 'stg', or 'prod'\n wallet: signer, // optional, the signer used (Metamask, Walletconnect)\n})\n")),(0,o.kt)("h4",{id:"development"},"Development"),(0,o.kt)("p",null,"This environment is for development testing and is subject to breaking changes and downtime."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"const client = new VocdoniSDKClient({\n env: EnvOptions.DEV, // mandatory, can be 'dev', 'stg', or 'prod'\n wallet: signer, // optional, the signer used (Metamask, Walletconnect)\n})\n")),(0,o.kt)("h2",{id:"election-status"},"Election Status"),(0,o.kt)("p",null,"Depending on your use case, you may need to pause, cancel, or otherwise pay attention to the state of an election.\n",(0,o.kt)("a",{parentName:"p",href:"/protocol#election-lifecycle-states"},"Election lifecycle states")," details all of the possible statuses an election can have once it has been published to the blockchain."),(0,o.kt)("h4",{id:"pause"},"Pause"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"(async () => {\n await client.pauseElection(id)\n const election = await client.fetchElection(id)\n console.log(election.status) // Matches ElectionStatus.PAUSED\n})();\n")),(0,o.kt)("h4",{id:"cancel"},"Cancel"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"(async () => {\n await client.cancelElection(id)\n const election = await client.fetchElection(id)\n console.log(election.status) // Matches ElectionStatus.CANCELED\n})();\n")),(0,o.kt)("h4",{id:"end"},"End"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"(async () => {\n await client.endElection(id)\n const election = await client.fetchElection(id)\n console.log(election.status) // Matches ElectionStatus.ENDED\n})();\n")),(0,o.kt)("h4",{id:"continue"},"Continue"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"(async () => {\n await client.continueElection(id)\n const election = await client.fetchElection(id)\n console.log(election.status) // Matches ElectionStatus.READY\n})();\n")),(0,o.kt)("h2",{id:"other-sdk-tools"},"Other SDK Tools"),(0,o.kt)("h4",{id:"generate-a-random-wallet"},"Generate a random Wallet"),(0,o.kt)("p",null,"You can use the ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#generaterandomwallet"},(0,o.kt)("inlineCode",{parentName:"a"},"client.generateRandomWallet"))," function to generate a random Wallet and assign it to the client.\nThis function returns the private key of the Wallet."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"const privateKey = client.generateRandomWallet();\nconsole.log(privateKey) // the private key of the wallet\n")),(0,o.kt)("h4",{id:"generate-deterministic-wallet-from-data"},"Generate deterministic Wallet from data"),(0,o.kt)("p",null,"For some cases where the voters don't have custody over an existing Wallet, we can generate a deterministic\nWallet based on arbitrary data, like, for example, the user and hash password from a custom CRM."),(0,o.kt)("p",null,"Here is an example of ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient#generatewalletfromdata"},(0,o.kt)("inlineCode",{parentName:"a"},"client.generateWalletFromData"))," where a Wallet is generated using the username and the hash of the password\nwhich we would use to identify the user in our platform. This Wallet can then be used for the\ncensus and for voting purposes. This enables users to keep the same private key without having to store it in their browser or application."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"// 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08 is the sha256 of 'test'\nconst userWallet = VocdoniSDKClient.generateWalletFromData(['user1', '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08']);\nconsole.log(userWallet) // address is 0x8AF1b3EDB817b5854e3311d583905a3421F49829\n")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b80cad64.44dde3cf.js b/assets/js/b80cad64.44dde3cf.js new file mode 100644 index 000000000..463c5a02b --- /dev/null +++ b/assets/js/b80cad64.44dde3cf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8149],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>f});var r=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var c=r.createContext({}),l=function(e){var n=r.useContext(c),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},p=function(e){var n=l(e.components);return r.createElement(c.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=l(t),f=a,k=d["".concat(c,".").concat(f)]||d[f]||u[f]||o;return t?r.createElement(k,i(i({ref:n},p),{},{components:t})):r.createElement(k,i({ref:n},p))}));function f(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var o=t.length,i=new Array(o);i[0]=d;var s={};for(var c in n)hasOwnProperty.call(n,c)&&(s[c]=n[c]);s.originalType=e,s.mdxType="string"==typeof e?e:a,i[1]=s;for(var l=2;l{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var r=t(87462),a=(t(67294),t(3905));const o={},i=void 0,s={unversionedId:"sdk/reference/interfaces/IBlockTransactionsResponse",id:"sdk/reference/interfaces/IBlockTransactionsResponse",title:"IBlockTransactionsResponse",description:"@vocdoni/sdk / Exports / IBlockTransactionsResponse",source:"@site/docs/sdk/reference/interfaces/IBlockTransactionsResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IBlockTransactionsResponse",permalink:"/sdk/reference/interfaces/IBlockTransactionsResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IApprovalElectionParameters",permalink:"/sdk/reference/interfaces/IApprovalElectionParameters"},next:{title:"IBudgetElectionParametersInfo",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"}},c={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"blockNumber",id:"blocknumber",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"transactionCount",id:"transactioncount",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"transactions",id:"transactions",level:3},{value:"Defined in",id:"defined-in-2",level:4}],p={toc:l};function u(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IBlockTransactionsResponse"),(0,a.kt)("h1",{id:"interface-iblocktransactionsresponse"},"Interface: IBlockTransactionsResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IBlockTransactionsResponse#blocknumber"},"blockNumber")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IBlockTransactionsResponse#transactioncount"},"transactionCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IBlockTransactionsResponse#transactions"},"transactions"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"blocknumber"},"blockNumber"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"blockNumber"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L312"},"api/chain.ts:312")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"transactioncount"},"transactionCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"transactionCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L313"},"api/chain.ts:313")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"transactions"},"transactions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"transactions"),": ",(0,a.kt)("a",{parentName:"p",href:"IChainTxReference"},(0,a.kt)("inlineCode",{parentName:"a"},"IChainTxReference")),"[]"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L314"},"api/chain.ts:314")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b80cad64.77a4769e.js b/assets/js/b80cad64.77a4769e.js deleted file mode 100644 index 901dd177f..000000000 --- a/assets/js/b80cad64.77a4769e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8149],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>u});var r=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=r.createContext({}),l=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},p=function(e){var n=l(e.components);return r.createElement(s.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},f=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),f=l(t),u=a,k=f["".concat(s,".").concat(u)]||f[u]||d[u]||o;return t?r.createElement(k,i(i({ref:n},p),{},{components:t})):r.createElement(k,i({ref:n},p))}));function u(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var o=t.length,i=new Array(o);i[0]=f;var c={};for(var s in n)hasOwnProperty.call(n,s)&&(c[s]=n[s]);c.originalType=e,c.mdxType="string"==typeof e?e:a,i[1]=c;for(var l=2;l{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var r=t(87462),a=(t(67294),t(3905));const o={},i=void 0,c={unversionedId:"sdk/reference/interfaces/IBlockTransactionsResponse",id:"sdk/reference/interfaces/IBlockTransactionsResponse",title:"IBlockTransactionsResponse",description:"@vocdoni/sdk / Exports / IBlockTransactionsResponse",source:"@site/docs/sdk/reference/interfaces/IBlockTransactionsResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IBlockTransactionsResponse",permalink:"/sdk/reference/interfaces/IBlockTransactionsResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IApprovalElectionParameters",permalink:"/sdk/reference/interfaces/IApprovalElectionParameters"},next:{title:"IBudgetElectionParametersInfo",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"}},s={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"blockNumber",id:"blocknumber",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"transactionCount",id:"transactioncount",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"transactions",id:"transactions",level:3},{value:"Defined in",id:"defined-in-2",level:4}],p={toc:l};function d(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IBlockTransactionsResponse"),(0,a.kt)("h1",{id:"interface-iblocktransactionsresponse"},"Interface: IBlockTransactionsResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBlockTransactionsResponse#blocknumber"},"blockNumber")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBlockTransactionsResponse#transactioncount"},"transactionCount")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBlockTransactionsResponse#transactions"},"transactions"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"blocknumber"},"blockNumber"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"blockNumber"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L312"},"api/chain.ts:312")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"transactioncount"},"transactionCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"transactionCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L313"},"api/chain.ts:313")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"transactions"},"transactions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"transactions"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainTxReference"},(0,a.kt)("inlineCode",{parentName:"a"},"IChainTxReference")),"[]"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L314"},"api/chain.ts:314")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b83e4bd7.089230c8.js b/assets/js/b83e4bd7.089230c8.js new file mode 100644 index 000000000..9d6680333 --- /dev/null +++ b/assets/js/b83e4bd7.089230c8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9229],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var p=r.createContext({}),l=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},c=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=l(n),f=o,m=d["".concat(p,".").concat(f)]||d[f]||u[f]||i;return n?r.createElement(m,a(a({ref:t},c),{},{components:n})):r.createElement(m,a({ref:t},c))}));function f(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=d;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s.mdxType="string"==typeof e?e:o,a[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=n(87462),o=(n(67294),n(3905));const i={},a=void 0,s={unversionedId:"sdk/reference/interfaces/IVoteSubmitResponse",id:"sdk/reference/interfaces/IVoteSubmitResponse",title:"IVoteSubmitResponse",description:"@vocdoni/sdk / Exports / IVoteSubmitResponse",source:"@site/docs/sdk/reference/interfaces/IVoteSubmitResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IVoteSubmitResponse",permalink:"/sdk/reference/interfaces/IVoteSubmitResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IVoteMode",permalink:"/sdk/reference/interfaces/IVoteMode"},next:{title:"IVoteType",permalink:"/sdk/reference/interfaces/IVoteType"}},p={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"txHash",id:"txhash",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"voteID",id:"voteid",level:3},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:l};function u(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IVoteSubmitResponse"),(0,o.kt)("h1",{id:"interface-ivotesubmitresponse"},"Interface: IVoteSubmitResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteSubmitResponse#txhash"},"txHash")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IVoteSubmitResponse#voteid"},"voteID"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"txhash"},"txHash"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"txHash"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The hash of the transaction"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/vote.ts#L14"},"api/vote.ts:14")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"voteid"},"voteID"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"voteID"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The identifier of the vote, also called nullifier."),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/vote.ts#L19"},"api/vote.ts:19")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b83e4bd7.c65abe86.js b/assets/js/b83e4bd7.c65abe86.js deleted file mode 100644 index 2e3f29f62..000000000 --- a/assets/js/b83e4bd7.c65abe86.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9229],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>u});var n=r(67294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var p=n.createContext({}),l=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},c=function(e){var t=l(e.components);return n.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,i=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),f=l(r),u=o,m=f["".concat(p,".").concat(u)]||f[u]||d[u]||i;return r?n.createElement(m,a(a({ref:t},c),{},{components:r})):n.createElement(m,a({ref:t},c))}));function u(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=r.length,a=new Array(i);a[0]=f;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s.mdxType="string"==typeof e?e:o,a[1]=s;for(var l=2;l{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var n=r(87462),o=(r(67294),r(3905));const i={},a=void 0,s={unversionedId:"sdk/reference/interfaces/IVoteSubmitResponse",id:"sdk/reference/interfaces/IVoteSubmitResponse",title:"IVoteSubmitResponse",description:"@vocdoni/sdk / Exports / IVoteSubmitResponse",source:"@site/docs/sdk/reference/interfaces/IVoteSubmitResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IVoteSubmitResponse",permalink:"/sdk/reference/interfaces/IVoteSubmitResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IVoteMode",permalink:"/sdk/reference/interfaces/IVoteMode"},next:{title:"IVoteType",permalink:"/sdk/reference/interfaces/IVoteType"}},p={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"txHash",id:"txhash",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"voteID",id:"voteid",level:3},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:l};function d(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IVoteSubmitResponse"),(0,o.kt)("h1",{id:"interface-ivotesubmitresponse"},"Interface: IVoteSubmitResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteSubmitResponse#txhash"},"txHash")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IVoteSubmitResponse#voteid"},"voteID"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"txhash"},"txHash"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"txHash"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The hash of the transaction"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/vote.ts#L14"},"api/vote.ts:14")),(0,o.kt)("hr",null),(0,o.kt)("h3",{id:"voteid"},"voteID"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"voteID"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The identifier of the vote, also called nullifier."),(0,o.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/vote.ts#L19"},"api/vote.ts:19")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b862b811.d8273df5.js b/assets/js/b862b811.fcdf8d3c.js similarity index 58% rename from assets/js/b862b811.d8273df5.js rename to assets/js/b862b811.fcdf8d3c.js index f8c72ef76..0945c1d43 100644 --- a/assets/js/b862b811.d8273df5.js +++ b/assets/js/b862b811.fcdf8d3c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9756],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var r=n(67294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var p=r.createContext({}),l=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,s=e.mdxType,a=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),u=l(n),f=s,g=u["".concat(p,".").concat(f)]||u[f]||d[f]||a;return n?r.createElement(g,i(i({ref:t},c),{},{components:n})):r.createElement(g,i({ref:t},c))}));function f(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var a=n.length,i=new Array(a);i[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:s,i[1]=o;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>d,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var r=n(87462),s=(n(67294),n(3905));const a={},i=void 0,o={unversionedId:"sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated",id:"sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated",title:"ICensus3StrategiesListResponsePaginated",description:"@vocdoni/sdk / Exports / ICensus3StrategiesListResponsePaginated",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategiesListResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategiesListResponse"},next:{title:"ICensus3StrategiesOperator",permalink:"/sdk/reference/interfaces/ICensus3StrategiesOperator"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"pagination",id:"pagination",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"strategies",id:"strategies",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:l};function d(e){let{components:t,...n}=e;return(0,s.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3StrategiesListResponsePaginated"),(0,s.kt)("h1",{id:"interface-icensus3strategieslistresponsepaginated"},"Interface: ICensus3StrategiesListResponsePaginated"),(0,s.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("p",{parentName:"li"},(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategiesListResponse"},(0,s.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesListResponse"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("strong",{parentName:"p"},(0,s.kt)("inlineCode",{parentName:"strong"},"ICensus3StrategiesListResponsePaginated"))))),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated#pagination"},"pagination")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated#strategies"},"strategies"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"pagination"},"pagination"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"pagination"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"Census3Pagination")),(0,s.kt)("p",null,"The pagination information"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L29"},"api/census3/strategy.ts:29")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"strategies"},"strategies"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"strategies"),": ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3strategy"},(0,s.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),"[]"),(0,s.kt)("p",null,"The list of the strategies identifiers"),(0,s.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategiesListResponse"},"ICensus3StrategiesListResponse"),".",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategiesListResponse#strategies"},"strategies")),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L22"},"api/census3/strategy.ts:22")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9756],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var r=n(67294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var p=r.createContext({}),l=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,s=e.mdxType,a=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=l(n),f=s,g=d["".concat(p,".").concat(f)]||d[f]||u[f]||a;return n?r.createElement(g,i(i({ref:t},c),{},{components:n})):r.createElement(g,i({ref:t},c))}));function f(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var a=n.length,i=new Array(a);i[0]=d;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:s,i[1]=o;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var r=n(87462),s=(n(67294),n(3905));const a={},i=void 0,o={unversionedId:"sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated",id:"sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated",title:"ICensus3StrategiesListResponsePaginated",description:"@vocdoni/sdk / Exports / ICensus3StrategiesListResponsePaginated",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategiesListResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategiesListResponse"},next:{title:"ICensus3StrategiesOperator",permalink:"/sdk/reference/interfaces/ICensus3StrategiesOperator"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"pagination",id:"pagination",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"strategies",id:"strategies",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:l};function u(e){let{components:t,...n}=e;return(0,s.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3StrategiesListResponsePaginated"),(0,s.kt)("h1",{id:"interface-icensus3strategieslistresponsepaginated"},"Interface: ICensus3StrategiesListResponsePaginated"),(0,s.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("p",{parentName:"li"},(0,s.kt)("a",{parentName:"p",href:"ICensus3StrategiesListResponse"},(0,s.kt)("inlineCode",{parentName:"a"},"ICensus3StrategiesListResponse"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("strong",{parentName:"p"},(0,s.kt)("inlineCode",{parentName:"strong"},"ICensus3StrategiesListResponsePaginated"))))),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus3StrategiesListResponsePaginated#pagination"},"pagination")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus3StrategiesListResponsePaginated#strategies"},"strategies"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"pagination"},"pagination"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"pagination"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"Census3Pagination")),(0,s.kt)("p",null,"The pagination information"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L29"},"api/census3/strategy.ts:29")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"strategies"},"strategies"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"strategies"),": ",(0,s.kt)("a",{parentName:"p",href:"../modules#census3strategy"},(0,s.kt)("inlineCode",{parentName:"a"},"Census3Strategy")),"[]"),(0,s.kt)("p",null,"The list of the strategies identifiers"),(0,s.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3StrategiesListResponse"},"ICensus3StrategiesListResponse"),".",(0,s.kt)("a",{parentName:"p",href:"ICensus3StrategiesListResponse#strategies"},"strategies")),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L22"},"api/census3/strategy.ts:22")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/bec6d9ae.538db9e4.js b/assets/js/bec6d9ae.538db9e4.js deleted file mode 100644 index e60214835..000000000 --- a/assets/js/bec6d9ae.538db9e4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[211],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function d(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),c=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):d(d({},t),e)),n},p=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),u=c(n),m=r,k=u["".concat(l,".").concat(m)]||u[m]||s[m]||i;return n?a.createElement(k,d(d({ref:t},p),{},{components:n})):a.createElement(k,d({ref:t},p))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,d=new Array(i);d[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:r,d[1]=o;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>d,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=n(87462),r=(n(67294),n(3905));const i={},d=void 0,o={unversionedId:"sdk/reference/interfaces/AccountMetadata",id:"sdk/reference/interfaces/AccountMetadata",title:"AccountMetadata",description:"@vocdoni/sdk / Exports / AccountMetadata",source:"@site/docs/sdk/reference/interfaces/AccountMetadata.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/AccountMetadata",permalink:"/sdk/reference/interfaces/AccountMetadata",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"VoteSteps",permalink:"/sdk/reference/enums/VoteSteps"},next:{title:"AdminTx",permalink:"/sdk/reference/interfaces/AdminTx"}},l={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"languages",id:"languages",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"media",id:"media",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"meta",id:"meta",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"newsFeed",id:"newsfeed",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"version",id:"version",level:3},{value:"Defined in",id:"defined-in-6",level:4}],p={toc:c};function s(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / AccountMetadata"),(0,r.kt)("h1",{id:"interface-accountmetadata"},"Interface: AccountMetadata"),(0,r.kt)("p",null,"JSON metadata. Intended to be stored on IPFS or similar.\nMore info: ",(0,r.kt)("a",{parentName:"p",href:"https://vocdoni.io/docs/#/architecture/components/entity?id=meta"},"https://vocdoni.io/docs/#/architecture/components/entity?id=meta")),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AccountMetadata#description"},"description")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AccountMetadata#languages"},"languages")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AccountMetadata#media"},"media")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AccountMetadata#meta"},"meta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AccountMetadata#name"},"name")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AccountMetadata#newsfeed"},"newsFeed")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/AccountMetadata#version"},"version"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/account.ts#L53"},"types/metadata/account.ts:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"languages"},"languages"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"languages"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/account.ts#L50"},"types/metadata/account.ts:50")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"media"},"media"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"media"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"avatar")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"header")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"logo")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/account.ts#L57"},"types/metadata/account.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[key: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/account.ts#L62"},"types/metadata/account.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/account.ts#L52"},"types/metadata/account.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"newsfeed"},"newsFeed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"newsFeed"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/account.ts#L55"},"types/metadata/account.ts:55")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"version"},"version"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"version"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"1.0"')),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/account.ts#L49"},"types/metadata/account.ts:49")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/bec6d9ae.89858c70.js b/assets/js/bec6d9ae.89858c70.js new file mode 100644 index 000000000..cd2bb43cb --- /dev/null +++ b/assets/js/bec6d9ae.89858c70.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[211],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function d(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),p=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):d(d({},t),e)),n},c=function(e){var t=p(e.components);return a.createElement(l.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),u=p(n),m=r,k=u["".concat(l,".").concat(m)]||u[m]||s[m]||i;return n?a.createElement(k,d(d({ref:t},c),{},{components:n})):a.createElement(k,d({ref:t},c))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,d=new Array(i);d[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:r,d[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>d,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var a=n(87462),r=(n(67294),n(3905));const i={},d=void 0,o={unversionedId:"sdk/reference/interfaces/AccountMetadata",id:"sdk/reference/interfaces/AccountMetadata",title:"AccountMetadata",description:"@vocdoni/sdk / Exports / AccountMetadata",source:"@site/docs/sdk/reference/interfaces/AccountMetadata.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/AccountMetadata",permalink:"/sdk/reference/interfaces/AccountMetadata",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"VoteSteps",permalink:"/sdk/reference/enums/VoteSteps"},next:{title:"AdminTx",permalink:"/sdk/reference/interfaces/AdminTx"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"languages",id:"languages",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"media",id:"media",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"meta",id:"meta",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"newsFeed",id:"newsfeed",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"version",id:"version",level:3},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:p};function s(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / AccountMetadata"),(0,r.kt)("h1",{id:"interface-accountmetadata"},"Interface: AccountMetadata"),(0,r.kt)("p",null,"JSON metadata. Intended to be stored on IPFS or similar.\nMore info: ",(0,r.kt)("a",{parentName:"p",href:"https://vocdoni.io/docs/#/architecture/components/entity?id=meta"},"https://vocdoni.io/docs/#/architecture/components/entity?id=meta")),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountMetadata#description"},"description")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountMetadata#languages"},"languages")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountMetadata#media"},"media")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountMetadata#meta"},"meta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountMetadata#name"},"name")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountMetadata#newsfeed"},"newsFeed")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"AccountMetadata#version"},"version"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/account.ts#L53"},"types/metadata/account.ts:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"languages"},"languages"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"languages"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/account.ts#L50"},"types/metadata/account.ts:50")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"media"},"media"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"media"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"avatar")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"header")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"logo")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/account.ts#L57"},"types/metadata/account.ts:57")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[key: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/account.ts#L62"},"types/metadata/account.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/account.ts#L52"},"types/metadata/account.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"newsfeed"},"newsFeed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"newsFeed"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/account.ts#L55"},"types/metadata/account.ts:55")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"version"},"version"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"version"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"1.0"')),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/account.ts#L49"},"types/metadata/account.ts:49")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c121c8d5.5abf8a97.js b/assets/js/c121c8d5.5abf8a97.js deleted file mode 100644 index 8ed3b3d0f..000000000 --- a/assets/js/c121c8d5.5abf8a97.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3195],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>c});var r=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function p(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=r.createContext({}),d=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):p(p({},n),e)),t},m=function(e){var n=d(e.components);return r.createElement(l.Provider,{value:n},e.children)},k={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},s=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),s=d(t),c=a,f=s["".concat(l,".").concat(c)]||s[c]||k[c]||i;return t?r.createElement(f,p(p({ref:n},m),{},{components:t})):r.createElement(f,p({ref:n},m))}));function c(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,p=new Array(i);p[0]=s;var o={};for(var l in n)hasOwnProperty.call(n,l)&&(o[l]=n[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,p[1]=o;for(var d=2;d{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>p,default:()=>k,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=t(87462),a=(t(67294),t(3905));const i={},p=void 0,o={unversionedId:"sdk/reference/interfaces/Proof",id:"sdk/reference/interfaces/Proof",title:"Proof",description:"@vocdoni/sdk / Exports / Proof",source:"@site/docs/sdk/reference/interfaces/Proof.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/Proof",permalink:"/sdk/reference/interfaces/Proof",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Process",permalink:"/sdk/reference/interfaces/Process"},next:{title:"RegisterKeyTx",permalink:"/sdk/reference/interfaces/RegisterKeyTx"}},l={},d=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"payload",id:"payload",level:3},{value:"Defined in",id:"defined-in",level:4}],m={toc:d};function k(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},m,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / Proof"),(0,a.kt)("h1",{id:"interface-proof"},"Interface: Proof"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/Proof#payload"},"payload"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"payload"},"payload"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"payload"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"graviton"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"graviton"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"siblings"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," } } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"iden3"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"iden3"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"siblings"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," } } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"ethereumStorage"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"ethereumStorage"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"siblings"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array"),"[] ; ",(0,a.kt)("inlineCode",{parentName:"p"},"value"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," } } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"ethereumAccount"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"ethereumAccount"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"balance"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"codeHash"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"nonce"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"siblings"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array"),"[] ; ",(0,a.kt)("inlineCode",{parentName:"p"},"storageHash"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," } } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"ca"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"ca"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"bundle"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"address"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"processId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," } ; ",(0,a.kt)("inlineCode",{parentName:"p"},"signature"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ProofCA_Type")," } } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"arbo"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"arbo"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"keyType"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ProofArbo_KeyType")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"siblings"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ProofArbo_Type")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"value"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," } } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"zkSnark"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"zkSnark"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"a"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,a.kt)("inlineCode",{parentName:"p"},"b"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,a.kt)("inlineCode",{parentName:"p"},"c"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,a.kt)("inlineCode",{parentName:"p"},"circuitParametersIndex"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"publicInputs"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[] } } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"minimeStorage"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"minimeStorage"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"proofNextBlock?"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"siblings"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array"),"[] ; ",(0,a.kt)("inlineCode",{parentName:"p"},"value"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," } ; ",(0,a.kt)("inlineCode",{parentName:"p"},"proofPrevBlock"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"siblings"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array"),"[] ; ",(0,a.kt)("inlineCode",{parentName:"p"},"value"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," } } }"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L341"},"api/chain/transactions.ts:341")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c121c8d5.bc78618b.js b/assets/js/c121c8d5.bc78618b.js new file mode 100644 index 000000000..a5eb9ba02 --- /dev/null +++ b/assets/js/c121c8d5.bc78618b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3195],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>c});var r=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function p(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=r.createContext({}),d=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):p(p({},n),e)),t},m=function(e){var n=d(e.components);return r.createElement(l.Provider,{value:n},e.children)},k={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},s=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),s=d(t),c=a,N=s["".concat(l,".").concat(c)]||s[c]||k[c]||i;return t?r.createElement(N,p(p({ref:n},m),{},{components:t})):r.createElement(N,p({ref:n},m))}));function c(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,p=new Array(i);p[0]=s;var o={};for(var l in n)hasOwnProperty.call(n,l)&&(o[l]=n[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,p[1]=o;for(var d=2;d{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>p,default:()=>k,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=t(87462),a=(t(67294),t(3905));const i={},p=void 0,o={unversionedId:"sdk/reference/interfaces/Proof",id:"sdk/reference/interfaces/Proof",title:"Proof",description:"@vocdoni/sdk / Exports / Proof",source:"@site/docs/sdk/reference/interfaces/Proof.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/Proof",permalink:"/sdk/reference/interfaces/Proof",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Process",permalink:"/sdk/reference/interfaces/Process"},next:{title:"RegisterKeyTx",permalink:"/sdk/reference/interfaces/RegisterKeyTx"}},l={},d=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"payload",id:"payload",level:3},{value:"Defined in",id:"defined-in",level:4}],m={toc:d};function k(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},m,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / Proof"),(0,a.kt)("h1",{id:"interface-proof"},"Interface: Proof"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Proof#payload"},"payload"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"payload"},"payload"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"payload"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"graviton"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"graviton"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"siblings"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," } } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"iden3"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"iden3"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"siblings"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," } } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"ethereumStorage"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"ethereumStorage"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"siblings"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array"),"[] ; ",(0,a.kt)("inlineCode",{parentName:"p"},"value"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," } } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"ethereumAccount"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"ethereumAccount"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"balance"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"codeHash"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"nonce"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"siblings"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array"),"[] ; ",(0,a.kt)("inlineCode",{parentName:"p"},"storageHash"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," } } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"ca"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"ca"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"bundle"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"address"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"processId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," } ; ",(0,a.kt)("inlineCode",{parentName:"p"},"signature"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ProofCA_Type")," } } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"arbo"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"arbo"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"keyType"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ProofArbo_KeyType")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"siblings"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ProofArbo_Type")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"value"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," } } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"zkSnark"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"zkSnark"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"a"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,a.kt)("inlineCode",{parentName:"p"},"b"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,a.kt)("inlineCode",{parentName:"p"},"c"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,a.kt)("inlineCode",{parentName:"p"},"circuitParametersIndex"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"publicInputs"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[] } } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"$case"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"minimeStorage"')," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"minimeStorage"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"proofNextBlock?"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"siblings"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array"),"[] ; ",(0,a.kt)("inlineCode",{parentName:"p"},"value"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," } ; ",(0,a.kt)("inlineCode",{parentName:"p"},"proofPrevBlock"),": ","{"," ",(0,a.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"siblings"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array"),"[] ; ",(0,a.kt)("inlineCode",{parentName:"p"},"value"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Uint8Array")," } } }"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L341"},"api/chain/transactions.ts:341")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c2c73492.4b54ab38.js b/assets/js/c2c73492.6d065d8d.js similarity index 57% rename from assets/js/c2c73492.4b54ab38.js rename to assets/js/c2c73492.6d065d8d.js index 6e8631ead..3ab4a25cc 100644 --- a/assets/js/c2c73492.4b54ab38.js +++ b/assets/js/c2c73492.6d065d8d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1865],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var a=r.createContext({}),l=function(e){var t=r.useContext(a),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=l(e.components);return r.createElement(a.Provider,{value:t},e.children)},f={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,a=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),d=l(n),u=o,v=d["".concat(a,".").concat(u)]||d[u]||f[u]||i;return n?r.createElement(v,s(s({ref:t},p),{},{components:n})):r.createElement(v,s({ref:t},p))}));function u(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,s=new Array(i);s[0]=d;var c={};for(var a in t)hasOwnProperty.call(t,a)&&(c[a]=t[a]);c.originalType=e,c.mdxType="string"==typeof e?e:o,s[1]=c;for(var l=2;l{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>f,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var r=n(87462),o=(n(67294),n(3905));const i={},s=void 0,c={unversionedId:"sdk/reference/interfaces/IElectionVoteListResponse",id:"sdk/reference/interfaces/IElectionVoteListResponse",title:"IElectionVoteListResponse",description:"@vocdoni/sdk / Exports / IElectionVoteListResponse",source:"@site/docs/sdk/reference/interfaces/IElectionVoteListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionVoteListResponse",permalink:"/sdk/reference/interfaces/IElectionVoteListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionVote",permalink:"/sdk/reference/interfaces/IElectionVote"},next:{title:"IEncryptionKey",permalink:"/sdk/reference/interfaces/IEncryptionKey"}},a={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"votes",id:"votes",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:l};function f(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IElectionVoteListResponse"),(0,o.kt)("h1",{id:"interface-ielectionvotelistresponse"},"Interface: IElectionVoteListResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionVoteListResponse#votes"},"votes"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"votes"},"votes"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"votes"),": ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionVote"},(0,o.kt)("inlineCode",{parentName:"a"},"IElectionVote")),"[]"),(0,o.kt)("p",null,"List of votes"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L315"},"api/election.ts:315")))}f.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1865],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>d});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var c=r.createContext({}),l=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=l(e.components);return r.createElement(c.Provider,{value:t},e.children)},f={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,c=e.parentName,p=a(e,["components","mdxType","originalType","parentName"]),u=l(n),d=o,v=u["".concat(c,".").concat(d)]||u[d]||f[d]||i;return n?r.createElement(v,s(s({ref:t},p),{},{components:n})):r.createElement(v,s({ref:t},p))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,s=new Array(i);s[0]=u;var a={};for(var c in t)hasOwnProperty.call(t,c)&&(a[c]=t[c]);a.originalType=e,a.mdxType="string"==typeof e?e:o,s[1]=a;for(var l=2;l{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>f,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var r=n(87462),o=(n(67294),n(3905));const i={},s=void 0,a={unversionedId:"sdk/reference/interfaces/IElectionVoteListResponse",id:"sdk/reference/interfaces/IElectionVoteListResponse",title:"IElectionVoteListResponse",description:"@vocdoni/sdk / Exports / IElectionVoteListResponse",source:"@site/docs/sdk/reference/interfaces/IElectionVoteListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionVoteListResponse",permalink:"/sdk/reference/interfaces/IElectionVoteListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionVote",permalink:"/sdk/reference/interfaces/IElectionVote"},next:{title:"IEncryptionKey",permalink:"/sdk/reference/interfaces/IEncryptionKey"}},c={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"votes",id:"votes",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:l};function f(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IElectionVoteListResponse"),(0,o.kt)("h1",{id:"interface-ielectionvotelistresponse"},"Interface: IElectionVoteListResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IElectionVoteListResponse#votes"},"votes"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"votes"},"votes"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"votes"),": ",(0,o.kt)("a",{parentName:"p",href:"IElectionVote"},(0,o.kt)("inlineCode",{parentName:"a"},"IElectionVote")),"[]"),(0,o.kt)("p",null,"List of votes"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L315"},"api/election.ts:315")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c5434c58.a486a98a.js b/assets/js/c5434c58.a486a98a.js new file mode 100644 index 000000000..69a1fff4a --- /dev/null +++ b/assets/js/c5434c58.a486a98a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7694],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>u});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),f=p(n),u=i,k=f["".concat(s,".").concat(u)]||f[u]||d[u]||a;return n?r.createElement(k,o(o({ref:t},c),{},{components:n})):r.createElement(k,o({ref:t},c))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=f;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:i,o[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>p});var r=n(87462),i=(n(67294),n(3905));const a={},o=void 0,l={unversionedId:"sdk/reference/interfaces/RegisterKeyTx",id:"sdk/reference/interfaces/RegisterKeyTx",title:"RegisterKeyTx",description:"@vocdoni/sdk / Exports / RegisterKeyTx",source:"@site/docs/sdk/reference/interfaces/RegisterKeyTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/RegisterKeyTx",permalink:"/sdk/reference/interfaces/RegisterKeyTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Proof",permalink:"/sdk/reference/interfaces/Proof"},next:{title:"SendTokensTx",permalink:"/sdk/reference/interfaces/SendTokensTx"}},s={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"newKey",id:"newkey",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"processId",id:"processid",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"proof",id:"proof",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"weight",id:"weight",level:3},{value:"Defined in",id:"defined-in-4",level:4}],c={toc:p};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / RegisterKeyTx"),(0,i.kt)("h1",{id:"interface-registerkeytx"},"Interface: RegisterKeyTx"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"RegisterKeyTx#newkey"},"newKey")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"RegisterKeyTx#nonce"},"nonce")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"RegisterKeyTx#processid"},"processId")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"RegisterKeyTx#proof"},"proof")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"RegisterKeyTx#weight"},"weight"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"newkey"},"newKey"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"newKey"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,i.kt)("p",null,"New key to register"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L121"},"api/chain/transactions.ts:121")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"nonce"},"nonce"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"nonce"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique number per vote attempt, so that replay attacks can't reuse this payload"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L115"},"api/chain/transactions.ts:115")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"processid"},"processId"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"processId"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,i.kt)("p",null,"The process for which the vote is casted"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L117"},"api/chain/transactions.ts:117")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"proof"},"proof"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"proof"),": ",(0,i.kt)("a",{parentName:"p",href:"Proof"},(0,i.kt)("inlineCode",{parentName:"a"},"Proof"))),(0,i.kt)("p",null,"Franchise proof"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L119"},"api/chain/transactions.ts:119")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"weight"},"weight"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"weight"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Weight to delegate to newKey"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L123"},"api/chain/transactions.ts:123")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c5434c58.c6c94b3c.js b/assets/js/c5434c58.c6c94b3c.js deleted file mode 100644 index 3f29ad934..000000000 --- a/assets/js/c5434c58.c6c94b3c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[7694],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=r.createContext({}),l=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=l(e.components);return r.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),f=l(n),u=i,k=f["".concat(c,".").concat(u)]||f[u]||d[u]||a;return n?r.createElement(k,o(o({ref:t},p),{},{components:n})):r.createElement(k,o({ref:t},p))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=f;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s.mdxType="string"==typeof e?e:i,o[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>s,toc:()=>l});var r=n(87462),i=(n(67294),n(3905));const a={},o=void 0,s={unversionedId:"sdk/reference/interfaces/RegisterKeyTx",id:"sdk/reference/interfaces/RegisterKeyTx",title:"RegisterKeyTx",description:"@vocdoni/sdk / Exports / RegisterKeyTx",source:"@site/docs/sdk/reference/interfaces/RegisterKeyTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/RegisterKeyTx",permalink:"/sdk/reference/interfaces/RegisterKeyTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Proof",permalink:"/sdk/reference/interfaces/Proof"},next:{title:"SendTokensTx",permalink:"/sdk/reference/interfaces/SendTokensTx"}},c={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"newKey",id:"newkey",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"processId",id:"processid",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"proof",id:"proof",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"weight",id:"weight",level:3},{value:"Defined in",id:"defined-in-4",level:4}],p={toc:l};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / RegisterKeyTx"),(0,i.kt)("h1",{id:"interface-registerkeytx"},"Interface: RegisterKeyTx"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/RegisterKeyTx#newkey"},"newKey")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/RegisterKeyTx#nonce"},"nonce")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/RegisterKeyTx#processid"},"processId")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/RegisterKeyTx#proof"},"proof")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/RegisterKeyTx#weight"},"weight"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"newkey"},"newKey"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"newKey"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,i.kt)("p",null,"New key to register"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L121"},"api/chain/transactions.ts:121")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"nonce"},"nonce"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"nonce"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique number per vote attempt, so that replay attacks can't reuse this payload"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L115"},"api/chain/transactions.ts:115")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"processid"},"processId"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"processId"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Uint8Array")),(0,i.kt)("p",null,"The process for which the vote is casted"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L117"},"api/chain/transactions.ts:117")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"proof"},"proof"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"proof"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/Proof"},(0,i.kt)("inlineCode",{parentName:"a"},"Proof"))),(0,i.kt)("p",null,"Franchise proof"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L119"},"api/chain/transactions.ts:119")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"weight"},"weight"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"weight"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Weight to delegate to newKey"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L123"},"api/chain/transactions.ts:123")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c626f2cc.3c9200b5.js b/assets/js/c626f2cc.3c9200b5.js deleted file mode 100644 index 80c639280..000000000 --- a/assets/js/c626f2cc.3c9200b5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[422],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>m});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),o=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=o(e.components);return a.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),c=o(n),m=r,u=c["".concat(p,".").concat(m)]||c[m]||k[m]||i;return n?a.createElement(u,l(l({ref:t},s),{},{components:n})):a.createElement(u,l({ref:t},s))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=c;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,d={unversionedId:"sdk/reference/classes/VocdoniSDKClient",id:"sdk/reference/classes/VocdoniSDKClient",title:"VocdoniSDKClient",description:"@vocdoni/sdk / Exports / VocdoniSDKClient",source:"@site/docs/sdk/reference/classes/VocdoniSDKClient.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/VocdoniSDKClient",permalink:"/sdk/reference/classes/VocdoniSDKClient",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"VocdoniCensus3Client",permalink:"/sdk/reference/classes/VocdoniCensus3Client"},next:{title:"Vote",permalink:"/sdk/reference/classes/Vote"}},p={},o=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"accountData",id:"accountdata",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"accountService",id:"accountservice",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"anonymousService",id:"anonymousservice",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"censusService",id:"censusservice",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"chainService",id:"chainservice",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"cspService",id:"cspservice",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"election",id:"election",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"electionId",id:"electionid",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"electionService",id:"electionservice",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"explorerUrl",id:"explorerurl",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"faucetService",id:"faucetservice",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"fileService",id:"fileservice",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"voteService",id:"voteservice",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"wallet",id:"wallet",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"Methods",id:"methods-1",level:2},{value:"calcZKProofForWallet",id:"calczkproofforwallet",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"calculateCID",id:"calculatecid",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"calculateElectionCost",id:"calculateelectioncost",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"cancelElection",id:"cancelelection",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"changeElectionCensus",id:"changeelectioncensus",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"changeElectionStatus",id:"changeelectionstatus",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"collectFaucetTokens",id:"collectfaucettokens",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"continueElection",id:"continueelection",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"createAccount",id:"createaccount",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"createAccountInfo",id:"createaccountinfo",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"createCensus",id:"createcensus",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"createElection",id:"createelection",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"createElectionSteps",id:"createelectionsteps",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"cspInfo",id:"cspinfo",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"cspSign",id:"cspsign",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"cspStep",id:"cspstep",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"cspUrl",id:"cspurl",level:3},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"cspVote",id:"cspvote",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"endElection",id:"endelection",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"estimateElectionCost",id:"estimateelectioncost",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"fetchAccount",id:"fetchaccount",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"fetchAccountInfo",id:"fetchaccountinfo",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"fetchCensusInfo",id:"fetchcensusinfo",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"fetchChainCosts",id:"fetchchaincosts",level:3},{value:"Returns",id:"returns-24",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"fetchChainId",id:"fetchchainid",level:3},{value:"Returns",id:"returns-25",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"fetchCircuits",id:"fetchcircuits",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-26",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"fetchElection",id:"fetchelection",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"fetchElections",id:"fetchelections",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-28",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"fetchFaucetPayload",id:"fetchfaucetpayload",level:3},{value:"Returns",id:"returns-29",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"fetchProof",id:"fetchproof",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"fetchProofForWallet",id:"fetchproofforwallet",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"generateRandomWallet",id:"generaterandomwallet",level:3},{value:"Returns",id:"returns-32",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"hasAlreadyVoted",id:"hasalreadyvoted",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"isAbleToVote",id:"isabletovote",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-34",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"isInCensus",id:"isincensus",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"parseFaucetPackage",id:"parsefaucetpackage",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"pauseElection",id:"pauseelection",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"sendTokens",id:"sendtokens",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"Returns",id:"returns-38",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"setAccountInfo",id:"setaccountinfo",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-39",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"setAccountSIK",id:"setaccountsik",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-40",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"setCircuits",id:"setcircuits",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-41",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"setElectionId",id:"setelectionid",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-42",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"submitVote",id:"submitvote",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-43",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"submitVoteSteps",id:"submitvotesteps",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-44",level:4},{value:"Defined in",id:"defined-in-59",level:4},{value:"updateAccountInfo",id:"updateaccountinfo",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Defined in",id:"defined-in-60",level:4},{value:"votesLeftCount",id:"votesleftcount",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-46",level:4},{value:"Defined in",id:"defined-in-61",level:4},{value:"waitForTransaction",id:"waitfortransaction",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"Returns",id:"returns-47",level:4},{value:"Defined in",id:"defined-in-62",level:4},{value:"generateWalletFromData",id:"generatewalletfromdata",level:3},{value:"Parameters",id:"parameters-42",level:4},{value:"Returns",id:"returns-48",level:4},{value:"Defined in",id:"defined-in-63",level:4}],s={toc:o};function k(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / VocdoniSDKClient"),(0,r.kt)("h1",{id:"class-vocdonisdkclient"},"Class: VocdoniSDKClient"),(0,r.kt)("p",null,"Main Vocdoni client object. It's a wrapper for all the methods in api, core\nand types, allowing you to easily use the vocdoni API from a single entry\npoint."),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#accountdata"},"accountData")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#accountservice"},"accountService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#anonymousservice"},"anonymousService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#censusservice"},"censusService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#chainservice"},"chainService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#cspservice"},"cspService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#election"},"election")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#electionid"},"electionId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#electionservice"},"electionService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#explorerurl"},"explorerUrl")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#faucetservice"},"faucetService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#fileservice"},"fileService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#url"},"url")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#voteservice"},"voteService")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#wallet"},"wallet"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#calczkproofforwallet"},"calcZKProofForWallet")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#calculatecid"},"calculateCID")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#calculateelectioncost"},"calculateElectionCost")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#cancelelection"},"cancelElection")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#changeelectioncensus"},"changeElectionCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#changeelectionstatus"},"changeElectionStatus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#collectfaucettokens"},"collectFaucetTokens")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#continueelection"},"continueElection")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#createaccount"},"createAccount")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#createaccountinfo"},"createAccountInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#createcensus"},"createCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#createelection"},"createElection")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#createelectionsteps"},"createElectionSteps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#cspinfo"},"cspInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#cspsign"},"cspSign")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#cspstep"},"cspStep")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#cspurl"},"cspUrl")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#cspvote"},"cspVote")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#endelection"},"endElection")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#estimateelectioncost"},"estimateElectionCost")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#fetchaccount"},"fetchAccount")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#fetchaccountinfo"},"fetchAccountInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#fetchcensusinfo"},"fetchCensusInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#fetchchaincosts"},"fetchChainCosts")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#fetchchainid"},"fetchChainId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#fetchcircuits"},"fetchCircuits")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#fetchelection"},"fetchElection")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#fetchelections"},"fetchElections")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#fetchfaucetpayload"},"fetchFaucetPayload")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#fetchproof"},"fetchProof")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#fetchproofforwallet"},"fetchProofForWallet")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#generaterandomwallet"},"generateRandomWallet")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#hasalreadyvoted"},"hasAlreadyVoted")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#isabletovote"},"isAbleToVote")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#isincensus"},"isInCensus")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#parsefaucetpackage"},"parseFaucetPackage")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#pauseelection"},"pauseElection")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#sendtokens"},"sendTokens")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#setaccountinfo"},"setAccountInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#setaccountsik"},"setAccountSIK")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#setcircuits"},"setCircuits")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#setelectionid"},"setElectionId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#submitvote"},"submitVote")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#submitvotesteps"},"submitVoteSteps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#updateaccountinfo"},"updateAccountInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#votesleftcount"},"votesLeftCount")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#waitfortransaction"},"waitForTransaction")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VocdoniSDKClient#generatewalletfromdata"},"generateWalletFromData"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new VocdoniSDKClient"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"opts"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient"},(0,r.kt)("inlineCode",{parentName:"a"},"VocdoniSDKClient"))),(0,r.kt)("p",null,"Instantiate new VocdoniSDK client."),(0,r.kt)("p",null,"To instantiate the client just pass the ",(0,r.kt)("inlineCode",{parentName:"p"},"ClientOptions")," you want or empty object to let defaults."),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"const client = new VocdoniSDKClient({EnvOptions.PROD})")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"opts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#clientoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"ClientOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"optional arguments")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VocdoniSDKClient"},(0,r.kt)("inlineCode",{parentName:"a"},"VocdoniSDKClient"))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L127"},"client.ts:127")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"accountdata"},"accountData"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"accountData"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountData"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#archivedaccountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"ArchivedAccountData"))," = ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L100"},"client.ts:100")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"accountservice"},"accountService"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"accountService"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/AccountService"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountService"))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L111"},"client.ts:111")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"anonymousservice"},"anonymousService"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"anonymousService"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/AnonymousService"},(0,r.kt)("inlineCode",{parentName:"a"},"AnonymousService"))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L105"},"client.ts:105")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censusservice"},"censusService"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"censusService"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CensusService"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusService"))),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L103"},"client.ts:103")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"chainservice"},"chainService"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"chainService"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ChainService"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainService"))),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L104"},"client.ts:104")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"cspservice"},"cspService"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"cspService"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CspService"},(0,r.kt)("inlineCode",{parentName:"a"},"CspService"))),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L106"},"client.ts:106")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"election"},"election"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"election"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))," = ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L101"},"client.ts:101")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electionid"},"electionId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"electionId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L115"},"client.ts:115")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electionservice"},"electionService"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"electionService"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ElectionService"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionService"))),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L107"},"client.ts:107")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"explorerurl"},"explorerUrl"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"explorerUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L116"},"client.ts:116")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"faucetservice"},"faucetService"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"faucetService"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/FaucetService"},(0,r.kt)("inlineCode",{parentName:"a"},"FaucetService"))),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L110"},"client.ts:110")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fileservice"},"fileService"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"fileService"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/FileService"},(0,r.kt)("inlineCode",{parentName:"a"},"FileService"))),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L109"},"client.ts:109")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"url"},"url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L113"},"client.ts:113")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"voteservice"},"voteService"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"voteService"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VoteService"},(0,r.kt)("inlineCode",{parentName:"a"},"VoteService"))),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L108"},"client.ts:108")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"wallet"},"wallet"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"wallet"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Wallet")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Signer")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L114"},"client.ts:114")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"calczkproofforwallet"},"calcZKProofForWallet"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"calcZKProofForWallet"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"election"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"wallet"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"votePackage"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"password?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#zkproof"},(0,r.kt)("inlineCode",{parentName:"a"},"ZkProof")),">"),(0,r.kt)("p",null,"Calculates ZK proof from given wallet."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"election")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/PublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedElection"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wallet")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Signer")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signature")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"votePackage")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Buffer")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"password")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"'0'"))))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#zkproof"},(0,r.kt)("inlineCode",{parentName:"a"},"ZkProof")),">"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L282"},"client.ts:282")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"calculatecid"},"calculateCID"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"calculateCID"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Fetches the CID expected for the specified data content."),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The data of which we want the CID of")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Resulting CID"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L1041"},"client.ts:1041")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"calculateelectioncost"},"calculateElectionCost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"calculateElectionCost"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"Calculate the election cost"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"election")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/UnpublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"UnpublishedElection")))))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"The cost in tokens."),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L1031"},"client.ts:1031")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"cancelelection"},"cancelElection"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"cancelElection"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Cancels an election."),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the election")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L620"},"client.ts:620")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"changeelectioncensus"},"changeElectionCensus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"changeElectionCensus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusURI"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Changes the census of an election."),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the election")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The new census id (root)")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusURI")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The new census URI")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L666"},"client.ts:666")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"changeelectionstatus"},"changeElectionStatus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"changeElectionStatus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"newStatus"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Changes the status of an election."),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the election")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"newStatus")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#allelectionstatus"},(0,r.kt)("inlineCode",{parentName:"a"},"AllElectionStatus"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The new status")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L641"},"client.ts:641")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"collectfaucettokens"},"collectFaucetTokens"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"collectFaucetTokens"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"faucetPackage?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,r.kt)("p",null,"Calls the faucet to get new tokens. Only under development."),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"faucetPackage?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The faucet package")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,r.kt)("p",null,"Account data information updated with new balance"),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L480"},"client.ts:480")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"continueelection"},"continueElection"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"continueElection"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Continues an election."),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the election")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L630"},"client.ts:630")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createaccount"},"createAccount"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createAccount"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,r.kt)("p",null,"Registers an account against vochain, so it can create new elections."),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Additional options, like extra information of the account, or the faucet package string")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options.account?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Account"},(0,r.kt)("inlineCode",{parentName:"a"},"Account"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options.faucetPackage?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options.password?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options.sik?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L412"},"client.ts:412")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createaccountinfo"},"createAccountInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createAccountInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"options"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,r.kt)("p",null,"Creates an account with information."),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Additional options, like extra information of the account, or the faucet package string.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options.account")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Account"},(0,r.kt)("inlineCode",{parentName:"a"},"Account"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options.faucetPackage?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options.password?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options.signedSikPayload?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L323"},"client.ts:323")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createcensus"},"createCensus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createCensus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"census"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Publishes the given census."),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"census")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/PlainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PlainCensus"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/WeightedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"WeightedCensus"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The census to be published.")))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L940"},"client.ts:940")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createelection"},"createElection"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createElection"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Creates a new voting election."),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"election")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/UnpublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The election object to be created.")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Resulting election id."),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L506"},"client.ts:506")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createelectionsteps"},"createElectionSteps"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createElectionSteps"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"AsyncGenerator"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#electioncreationstepvalue"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionCreationStepValue")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"Creates a new voting election by steps with async returns."),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"election")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/UnpublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The election object to be created.")))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"AsyncGenerator"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#electioncreationstepvalue"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionCreationStepValue")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"The async step returns."),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L522"},"client.ts:522")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"cspinfo"},"cspInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"cspInfo"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICspInfoResponse"),">"),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICspInfoResponse"),">"),(0,r.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L979"},"client.ts:979")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"cspsign"},"cspSign"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"cspSign"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"token"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"token")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L990"},"client.ts:990")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"cspstep"},"cspStep"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"cspStep"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"stepNumber"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"authToken?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICspIntermediateStepResponse")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ICspFinalStepResponse"),">"),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"stepNumber")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICspIntermediateStepResponse")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ICspFinalStepResponse"),">"),(0,r.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L983"},"client.ts:983")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"cspurl"},"cspUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"cspUrl"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L974"},"client.ts:974")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"cspvote"},"cspVote"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"cspVote"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"vote"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"proof_type?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CspVote"},(0,r.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"vote")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Vote"},(0,r.kt)("inlineCode",{parentName:"a"},"Vote")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signature")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"proof_type?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CspProofType"},(0,r.kt)("inlineCode",{parentName:"a"},"CspProofType")))))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CspVote"},(0,r.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,r.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L995"},"client.ts:995")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"endelection"},"endElection"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"endElection"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Ends an election."),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the election")))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L600"},"client.ts:600")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"estimateelectioncost"},"estimateElectionCost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"estimateElectionCost"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"Estimates the election cost"),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"election")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/UnpublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"UnpublishedElection")))))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"The cost in tokens."),(0,r.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L1022"},"client.ts:1022")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchaccount"},"fetchAccount"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchAccount"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,r.kt)("p",null,"Fetches account."),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The account address to fetch the information")))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,r.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L196"},"client.ts:196")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchaccountinfo"},"fetchAccountInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchAccountInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"address?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountData"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#archivedaccountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"ArchivedAccountData")),">"),(0,r.kt)("p",null,"Fetches account information."),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The account address to fetch the information")))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountData"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#archivedaccountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"ArchivedAccountData")),">"),(0,r.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L177"},"client.ts:177")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchcensusinfo"},"fetchCensusInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchCensusInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"size"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"weight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"bigint")," }",">"),(0,r.kt)("p",null,"Fetches the information of a given census."),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-23"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"p"},"size"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"weight"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"bigint")," }",">"),(0,r.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L950"},"client.ts:950")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchchaincosts"},"fetchChainCosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchChainCosts"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainGetCostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCostsResponse")),">"),(0,r.kt)("p",null,"Fetches blockchain costs information if needed."),(0,r.kt)("h4",{id:"returns-24"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainGetCostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCostsResponse")),">"),(0,r.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L1004"},"client.ts:1004")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchchainid"},"fetchChainId"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchChainId"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Fetches blockchain information if needed and returns the chain id."),(0,r.kt)("h4",{id:"returns-25"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L1013"},"client.ts:1013")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchcircuits"},"fetchCircuits"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchCircuits"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"circuits?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits")),">"),(0,r.kt)("p",null,"Fetches circuits for anonymous voting"),(0,r.kt)("h4",{id:"parameters-22"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"circuits?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Omit"),"\\<",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits")),", ",(0,r.kt)("inlineCode",{parentName:"td"},'"zKeyData"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},'"vKeyData"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},'"wasmData"'),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Additional options for custom circuits")))),(0,r.kt)("h4",{id:"returns-26"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits")),">"),(0,r.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L960"},"client.ts:960")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchelection"},"fetchElection"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchElection"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ArchivedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"ArchivedElection")),">"),(0,r.kt)("p",null,"Fetches info about an election."),(0,r.kt)("h4",{id:"parameters-23"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the election")))),(0,r.kt)("h4",{id:"returns-27"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ArchivedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"ArchivedElection")),">"),(0,r.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L224"},"client.ts:224")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchelections"},"fetchElections"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchElections"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"account?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<(",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ArchivedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"ArchivedElection"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/InvalidElection"},(0,r.kt)("inlineCode",{parentName:"a"},"InvalidElection")),")[]",">"),(0,r.kt)("h4",{id:"parameters-24"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"account?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0"))))),(0,r.kt)("h4",{id:"returns-28"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<(",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ArchivedElection"},(0,r.kt)("inlineCode",{parentName:"a"},"ArchivedElection"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/InvalidElection"},(0,r.kt)("inlineCode",{parentName:"a"},"InvalidElection")),")[]",">"),(0,r.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L231"},"client.ts:231")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchfaucetpayload"},"fetchFaucetPayload"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchFaucetPayload"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Fetches a faucet payload. Only for development."),(0,r.kt)("h4",{id:"returns-29"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L1050"},"client.ts:1050")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchproof"},"fetchProof"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchProof"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#censusproof"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusProof")),">"),(0,r.kt)("p",null,"Fetches proof that an address is part of the specified census."),(0,r.kt)("h4",{id:"parameters-25"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Census we want to check the address against")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The address to be found")))),(0,r.kt)("h4",{id:"returns-30"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#censusproof"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusProof")),">"),(0,r.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L930"},"client.ts:930")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchproofforwallet"},"fetchProofForWallet"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchProofForWallet"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"wallet"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#censusproof"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusProof")),">"),(0,r.kt)("p",null,"Fetches proof that an address is part of the specified census."),(0,r.kt)("h4",{id:"parameters-26"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wallet")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Signer"))))),(0,r.kt)("h4",{id:"returns-31"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#censusproof"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusProof")),">"),(0,r.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L245"},"client.ts:245")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"generaterandomwallet"},"generateRandomWallet"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"generateRandomWallet"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Assigns a random Wallet to the client and returns its private key."),(0,r.kt)("h4",{id:"returns-32"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The private key."),(0,r.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L901"},"client.ts:901")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hasalreadyvoted"},"hasAlreadyVoted"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"hasAlreadyVoted"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Checks if the user has already voted"),(0,r.kt)("h4",{id:"parameters-27"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#walletoption"},(0,r.kt)("inlineCode",{parentName:"a"},"WalletOption"))," & ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#electionidoption"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionIdOption"))," & ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#voteidoption"},(0,r.kt)("inlineCode",{parentName:"a"},"VoteIdOption")),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for has already voted")))),(0,r.kt)("h4",{id:"returns-33"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The id of the vote"),(0,r.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L711"},"client.ts:711")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isabletovote"},"isAbleToVote"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isAbleToVote"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Checks if the user is able to vote"),(0,r.kt)("h4",{id:"parameters-28"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#walletoption"},(0,r.kt)("inlineCode",{parentName:"a"},"WalletOption"))," & ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#electionidoption"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionIdOption"))," & ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#voteidoption"},(0,r.kt)("inlineCode",{parentName:"a"},"VoteIdOption")),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for is able to vote")))),(0,r.kt)("h4",{id:"returns-34"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L743"},"client.ts:743")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isincensus"},"isInCensus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isInCensus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Checks if the user is in census."),(0,r.kt)("h4",{id:"parameters-29"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#walletoption"},(0,r.kt)("inlineCode",{parentName:"a"},"WalletOption"))," & ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#electionidoption"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionIdOption")),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for is in census")))),(0,r.kt)("h4",{id:"returns-35"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L690"},"client.ts:690")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parsefaucetpackage"},"parseFaucetPackage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"parseFaucetPackage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"faucetPackage"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#faucetpackage"},(0,r.kt)("inlineCode",{parentName:"a"},"FaucetPackage"))),(0,r.kt)("p",null,"Parses a faucet package."),(0,r.kt)("h4",{id:"parameters-30"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"faucetPackage")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The encoded faucet package")))),(0,r.kt)("h4",{id:"returns-36"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#faucetpackage"},(0,r.kt)("inlineCode",{parentName:"a"},"FaucetPackage"))),(0,r.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L1061"},"client.ts:1061")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"pauseelection"},"pauseElection"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"pauseElection"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Pauses an election."),(0,r.kt)("h4",{id:"parameters-31"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the election")))),(0,r.kt)("h4",{id:"returns-37"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L610"},"client.ts:610")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendtokens"},"sendTokens"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendTokens"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"options"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Send tokens from one account to another."),(0,r.kt)("h4",{id:"parameters-32"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#sendtokensoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"SendTokensOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for send tokens")))),(0,r.kt)("h4",{id:"returns-38"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L451"},"client.ts:451")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setaccountinfo"},"setAccountInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setAccountInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"promAccountData"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,r.kt)("p",null,"Updates an account with information"),(0,r.kt)("h4",{id:"parameters-33"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"promAccountData")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Promise"),"\\<","{"," ",(0,r.kt)("inlineCode",{parentName:"td"},"message"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"metadata"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"tx"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"Uint8Array")," }",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Account data promise in Tx form.")))),(0,r.kt)("h4",{id:"returns-39"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,r.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L392"},"client.ts:392")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setaccountsik"},"setAccountSIK"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setAccountSIK"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"password"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"censusProof"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"wallet"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"parameters-34"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signature")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"password")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusProof")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#censusproof"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusProof")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wallet")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Signer"))))),(0,r.kt)("h4",{id:"returns-40"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L249"},"client.ts:249")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setcircuits"},"setCircuits"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setCircuits"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"circuits"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,r.kt)("p",null,"Sets circuits for anonymous voting"),(0,r.kt)("h4",{id:"parameters-35"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"circuits")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Custom circuits")))),(0,r.kt)("h4",{id:"returns-41"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#chaincircuits"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,r.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L970"},"client.ts:970")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setelectionid"},"setElectionId"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setElectionId"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Sets an election id. Required by other methods like submitVote or createElection."),(0,r.kt)("h4",{id:"parameters-36"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"electionId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Election id string")))),(0,r.kt)("h4",{id:"returns-42"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L167"},"client.ts:167")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"submitvote"},"submitVote"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"submitVote"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"vote"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Submits a vote."),(0,r.kt)("h4",{id:"parameters-37"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"vote")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Vote"},(0,r.kt)("inlineCode",{parentName:"a"},"Vote"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/AnonymousVote"},(0,r.kt)("inlineCode",{parentName:"a"},"AnonymousVote"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/CspVote"},(0,r.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The vote (or votes) to be sent.")))),(0,r.kt)("h4",{id:"returns-43"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Vote confirmation id."),(0,r.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L790"},"client.ts:790")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"submitvotesteps"},"submitVoteSteps"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"submitVoteSteps"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"vote"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"AsyncGenerator"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#votestepvalue"},(0,r.kt)("inlineCode",{parentName:"a"},"VoteStepValue")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"Submits a vote by steps."),(0,r.kt)("h4",{id:"parameters-38"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"vote")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Vote"},(0,r.kt)("inlineCode",{parentName:"a"},"Vote"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/AnonymousVote"},(0,r.kt)("inlineCode",{parentName:"a"},"AnonymousVote"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/CspVote"},(0,r.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The vote (or votes) to be sent.")))),(0,r.kt)("h4",{id:"returns-44"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"AsyncGenerator"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#votestepvalue"},(0,r.kt)("inlineCode",{parentName:"a"},"VoteStepValue")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"Vote confirmation id."),(0,r.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L806"},"client.ts:806")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"updateaccountinfo"},"updateAccountInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"updateAccountInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"account"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,r.kt)("p",null,"Updates an account with information"),(0,r.kt)("h4",{id:"parameters-39"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"account")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Account"},(0,r.kt)("inlineCode",{parentName:"a"},"Account"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Account data.")))),(0,r.kt)("h4",{id:"returns-45"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,r.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,r.kt)("h4",{id:"defined-in-60"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L366"},"client.ts:366")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"votesleftcount"},"votesLeftCount"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"votesLeftCount"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"Checks how many times a user can submit their vote"),(0,r.kt)("h4",{id:"parameters-40"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#walletoption"},(0,r.kt)("inlineCode",{parentName:"a"},"WalletOption"))," & ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#electionidoption"},(0,r.kt)("inlineCode",{parentName:"a"},"ElectionIdOption"))," & ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/modules#voteidoption"},(0,r.kt)("inlineCode",{parentName:"a"},"VoteIdOption")),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for votes left count")))),(0,r.kt)("h4",{id:"returns-46"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("h4",{id:"defined-in-61"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L753"},"client.ts:753")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"waitfortransaction"},"waitForTransaction"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"waitForTransaction"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"tx"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"wait?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"attempts?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"A convenience method to wait for a transaction to be executed. It will\nloop trying to get the transaction information, and will retry every time\nit fails."),(0,r.kt)("h4",{id:"parameters-41"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Transaction to wait for")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wait?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The delay in milliseconds between tries")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"attempts?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The attempts to try before failing")))),(0,r.kt)("h4",{id:"returns-47"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-62"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L1075"},"client.ts:1075")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"generatewalletfromdata"},"generateWalletFromData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"generateWalletFromData"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Wallet")),(0,r.kt)("p",null,"Returns a Wallet based on the inputs."),(0,r.kt)("h4",{id:"parameters-42"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The data inputs which should generate the Wallet")))),(0,r.kt)("h4",{id:"returns-48"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Wallet")),(0,r.kt)("p",null,"The deterministic wallet."),(0,r.kt)("h4",{id:"defined-in-63"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/client.ts#L913"},"client.ts:913")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c626f2cc.ca43cab6.js b/assets/js/c626f2cc.ca43cab6.js new file mode 100644 index 000000000..262ad2de6 --- /dev/null +++ b/assets/js/c626f2cc.ca43cab6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[422],{3905:(e,t,n)=>{n.d(t,{Zo:()=>k,kt:()=>c});var a=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function r(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var p=a.createContext({}),o=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},k=function(e){var t=o(e.components);return a.createElement(p.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,l=e.originalType,p=e.parentName,k=d(e,["components","mdxType","originalType","parentName"]),m=o(n),c=i,u=m["".concat(p,".").concat(c)]||m[c]||s[c]||l;return n?a.createElement(u,r(r({ref:t},k),{},{components:n})):a.createElement(u,r({ref:t},k))}));function c(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=n.length,r=new Array(l);r[0]=m;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:i,r[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>r,default:()=>s,frontMatter:()=>l,metadata:()=>d,toc:()=>o});var a=n(87462),i=(n(67294),n(3905));const l={},r=void 0,d={unversionedId:"sdk/reference/classes/VocdoniSDKClient",id:"sdk/reference/classes/VocdoniSDKClient",title:"VocdoniSDKClient",description:"@vocdoni/sdk / Exports / VocdoniSDKClient",source:"@site/docs/sdk/reference/classes/VocdoniSDKClient.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/VocdoniSDKClient",permalink:"/sdk/reference/classes/VocdoniSDKClient",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"VocdoniCensus3Client",permalink:"/sdk/reference/classes/VocdoniCensus3Client"},next:{title:"Vote",permalink:"/sdk/reference/classes/Vote"}},p={},o=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"accountData",id:"accountdata",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"accountService",id:"accountservice",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"anonymousService",id:"anonymousservice",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"censusService",id:"censusservice",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"chainService",id:"chainservice",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"cspService",id:"cspservice",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"election",id:"election",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"electionId",id:"electionid",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"electionService",id:"electionservice",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"explorerUrl",id:"explorerurl",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"faucetService",id:"faucetservice",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"fileService",id:"fileservice",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"voteService",id:"voteservice",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"wallet",id:"wallet",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"Methods",id:"methods-1",level:2},{value:"calcZKProofForWallet",id:"calczkproofforwallet",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"calculateCID",id:"calculatecid",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"calculateElectionCost",id:"calculateelectioncost",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"cancelElection",id:"cancelelection",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"changeElectionCensus",id:"changeelectioncensus",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"changeElectionStatus",id:"changeelectionstatus",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"collectFaucetTokens",id:"collectfaucettokens",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"continueElection",id:"continueelection",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"createAccount",id:"createaccount",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"createAccountInfo",id:"createaccountinfo",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"createCensus",id:"createcensus",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"createElection",id:"createelection",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"createElectionSteps",id:"createelectionsteps",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"cspInfo",id:"cspinfo",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"cspSign",id:"cspsign",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"cspStep",id:"cspstep",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"cspUrl",id:"cspurl",level:3},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"cspVote",id:"cspvote",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"endElection",id:"endelection",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"estimateElectionCost",id:"estimateelectioncost",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"fetchAccount",id:"fetchaccount",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"fetchAccountInfo",id:"fetchaccountinfo",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"fetchCensusInfo",id:"fetchcensusinfo",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"fetchChainCosts",id:"fetchchaincosts",level:3},{value:"Returns",id:"returns-24",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"fetchChainId",id:"fetchchainid",level:3},{value:"Returns",id:"returns-25",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"fetchCircuits",id:"fetchcircuits",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-26",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"fetchElection",id:"fetchelection",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"fetchElections",id:"fetchelections",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-28",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"fetchFaucetPayload",id:"fetchfaucetpayload",level:3},{value:"Returns",id:"returns-29",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"fetchProof",id:"fetchproof",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"fetchProofForWallet",id:"fetchproofforwallet",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"generateRandomWallet",id:"generaterandomwallet",level:3},{value:"Returns",id:"returns-32",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"hasAlreadyVoted",id:"hasalreadyvoted",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"isAbleToVote",id:"isabletovote",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-34",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"isInCensus",id:"isincensus",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"parseFaucetPackage",id:"parsefaucetpackage",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"pauseElection",id:"pauseelection",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"sendTokens",id:"sendtokens",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"Returns",id:"returns-38",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"setAccountInfo",id:"setaccountinfo",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-39",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"setAccountSIK",id:"setaccountsik",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-40",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"setCircuits",id:"setcircuits",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-41",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"setElectionId",id:"setelectionid",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-42",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"submitVote",id:"submitvote",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-43",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"submitVoteSteps",id:"submitvotesteps",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-44",level:4},{value:"Defined in",id:"defined-in-59",level:4},{value:"updateAccountInfo",id:"updateaccountinfo",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Defined in",id:"defined-in-60",level:4},{value:"votesLeftCount",id:"votesleftcount",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-46",level:4},{value:"Defined in",id:"defined-in-61",level:4},{value:"waitForTransaction",id:"waitfortransaction",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"Returns",id:"returns-47",level:4},{value:"Defined in",id:"defined-in-62",level:4},{value:"generateWalletFromData",id:"generatewalletfromdata",level:3},{value:"Parameters",id:"parameters-42",level:4},{value:"Returns",id:"returns-48",level:4},{value:"Defined in",id:"defined-in-63",level:4}],k={toc:o};function s(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / VocdoniSDKClient"),(0,i.kt)("h1",{id:"class-vocdonisdkclient"},"Class: VocdoniSDKClient"),(0,i.kt)("p",null,"Main Vocdoni client object. It's a wrapper for all the methods in api, core\nand types, allowing you to easily use the vocdoni API from a single entry\npoint."),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"constructors"},"Constructors"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#constructor"},"constructor"))),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#accountdata"},"accountData")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#accountservice"},"accountService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#anonymousservice"},"anonymousService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#censusservice"},"censusService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#chainservice"},"chainService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#cspservice"},"cspService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#election"},"election")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#electionid"},"electionId")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#electionservice"},"electionService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#explorerurl"},"explorerUrl")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#faucetservice"},"faucetService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#fileservice"},"fileService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#url"},"url")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#voteservice"},"voteService")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#wallet"},"wallet"))),(0,i.kt)("h3",{id:"methods"},"Methods"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#calczkproofforwallet"},"calcZKProofForWallet")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#calculatecid"},"calculateCID")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#calculateelectioncost"},"calculateElectionCost")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#cancelelection"},"cancelElection")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#changeelectioncensus"},"changeElectionCensus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#changeelectionstatus"},"changeElectionStatus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#collectfaucettokens"},"collectFaucetTokens")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#continueelection"},"continueElection")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#createaccount"},"createAccount")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#createaccountinfo"},"createAccountInfo")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#createcensus"},"createCensus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#createelection"},"createElection")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#createelectionsteps"},"createElectionSteps")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#cspinfo"},"cspInfo")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#cspsign"},"cspSign")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#cspstep"},"cspStep")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#cspurl"},"cspUrl")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#cspvote"},"cspVote")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#endelection"},"endElection")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#estimateelectioncost"},"estimateElectionCost")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#fetchaccount"},"fetchAccount")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#fetchaccountinfo"},"fetchAccountInfo")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#fetchcensusinfo"},"fetchCensusInfo")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#fetchchaincosts"},"fetchChainCosts")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#fetchchainid"},"fetchChainId")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#fetchcircuits"},"fetchCircuits")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#fetchelection"},"fetchElection")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#fetchelections"},"fetchElections")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#fetchfaucetpayload"},"fetchFaucetPayload")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#fetchproof"},"fetchProof")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#fetchproofforwallet"},"fetchProofForWallet")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#generaterandomwallet"},"generateRandomWallet")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#hasalreadyvoted"},"hasAlreadyVoted")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#isabletovote"},"isAbleToVote")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#isincensus"},"isInCensus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#parsefaucetpackage"},"parseFaucetPackage")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#pauseelection"},"pauseElection")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#sendtokens"},"sendTokens")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#setaccountinfo"},"setAccountInfo")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#setaccountsik"},"setAccountSIK")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#setcircuits"},"setCircuits")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#setelectionid"},"setElectionId")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#submitvote"},"submitVote")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#submitvotesteps"},"submitVoteSteps")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#updateaccountinfo"},"updateAccountInfo")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#votesleftcount"},"votesLeftCount")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#waitfortransaction"},"waitForTransaction")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VocdoniSDKClient#generatewalletfromdata"},"generateWalletFromData"))),(0,i.kt)("h2",{id:"constructors-1"},"Constructors"),(0,i.kt)("h3",{id:"constructor"},"constructor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"new VocdoniSDKClient"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"opts"),"): ",(0,i.kt)("a",{parentName:"p",href:"VocdoniSDKClient"},(0,i.kt)("inlineCode",{parentName:"a"},"VocdoniSDKClient"))),(0,i.kt)("p",null,"Instantiate new VocdoniSDK client."),(0,i.kt)("p",null,"To instantiate the client just pass the ",(0,i.kt)("inlineCode",{parentName:"p"},"ClientOptions")," you want or empty object to let defaults."),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"const client = new VocdoniSDKClient({EnvOptions.PROD})")),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"opts")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"../modules#clientoptions"},(0,i.kt)("inlineCode",{parentName:"a"},"ClientOptions"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"optional arguments")))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"VocdoniSDKClient"},(0,i.kt)("inlineCode",{parentName:"a"},"VocdoniSDKClient"))),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L127"},"client.ts:127")),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"accountdata"},"accountData"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,i.kt)("strong",{parentName:"p"},"accountData"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountData"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"../modules#archivedaccountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"ArchivedAccountData"))," = ",(0,i.kt)("inlineCode",{parentName:"p"},"null")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L100"},"client.ts:100")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"accountservice"},"accountService"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"accountService"),": ",(0,i.kt)("a",{parentName:"p",href:"AccountService"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountService"))),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L111"},"client.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"anonymousservice"},"anonymousService"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"anonymousService"),": ",(0,i.kt)("a",{parentName:"p",href:"AnonymousService"},(0,i.kt)("inlineCode",{parentName:"a"},"AnonymousService"))),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L105"},"client.ts:105")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"censusservice"},"censusService"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"censusService"),": ",(0,i.kt)("a",{parentName:"p",href:"CensusService"},(0,i.kt)("inlineCode",{parentName:"a"},"CensusService"))),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L103"},"client.ts:103")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"chainservice"},"chainService"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"chainService"),": ",(0,i.kt)("a",{parentName:"p",href:"ChainService"},(0,i.kt)("inlineCode",{parentName:"a"},"ChainService"))),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L104"},"client.ts:104")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"cspservice"},"cspService"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"cspService"),": ",(0,i.kt)("a",{parentName:"p",href:"CspService"},(0,i.kt)("inlineCode",{parentName:"a"},"CspService"))),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L106"},"client.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"election"},"election"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,i.kt)("strong",{parentName:"p"},"election"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))," = ",(0,i.kt)("inlineCode",{parentName:"p"},"null")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L101"},"client.ts:101")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electionid"},"electionId"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"electionId"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L115"},"client.ts:115")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electionservice"},"electionService"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"electionService"),": ",(0,i.kt)("a",{parentName:"p",href:"ElectionService"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionService"))),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L107"},"client.ts:107")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"explorerurl"},"explorerUrl"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"explorerUrl"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L116"},"client.ts:116")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"faucetservice"},"faucetService"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"faucetService"),": ",(0,i.kt)("a",{parentName:"p",href:"FaucetService"},(0,i.kt)("inlineCode",{parentName:"a"},"FaucetService"))),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L110"},"client.ts:110")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fileservice"},"fileService"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"fileService"),": ",(0,i.kt)("a",{parentName:"p",href:"FileService"},(0,i.kt)("inlineCode",{parentName:"a"},"FileService"))),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L109"},"client.ts:109")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"url"},"url"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"url"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L113"},"client.ts:113")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"voteservice"},"voteService"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"voteService"),": ",(0,i.kt)("a",{parentName:"p",href:"VoteService"},(0,i.kt)("inlineCode",{parentName:"a"},"VoteService"))),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L108"},"client.ts:108")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"wallet"},"wallet"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"wallet"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Wallet")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Signer")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L114"},"client.ts:114")),(0,i.kt)("h2",{id:"methods-1"},"Methods"),(0,i.kt)("h3",{id:"calczkproofforwallet"},"calcZKProofForWallet"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"calcZKProofForWallet"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"election"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"wallet"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"votePackage"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"password?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#zkproof"},(0,i.kt)("inlineCode",{parentName:"a"},"ZkProof")),">"),(0,i.kt)("p",null,"Calculates ZK proof from given wallet."),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"election")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"PublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"PublishedElection"))),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wallet")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"Signer")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"signature")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"votePackage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Buffer")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"password")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"'0'"))))),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#zkproof"},(0,i.kt)("inlineCode",{parentName:"a"},"ZkProof")),">"),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L282"},"client.ts:282")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"calculatecid"},"calculateCID"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"calculateCID"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Fetches the CID expected for the specified data content."),(0,i.kt)("h4",{id:"parameters-2"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"data")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The data of which we want the CID of")))),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Resulting CID"),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L1041"},"client.ts:1041")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"calculateelectioncost"},"calculateElectionCost"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"calculateElectionCost"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,i.kt)("p",null,"Calculate the election cost"),(0,i.kt)("h4",{id:"parameters-3"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"election")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection")))))),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,i.kt)("p",null,"The cost in tokens."),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L1031"},"client.ts:1031")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"cancelelection"},"cancelElection"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"cancelElection"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionId?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Cancels an election."),(0,i.kt)("h4",{id:"parameters-4"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionId?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The id of the election")))),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L620"},"client.ts:620")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"changeelectioncensus"},"changeElectionCensus"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"changeElectionCensus"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionId"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"censusURI"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Changes the census of an election."),(0,i.kt)("h4",{id:"parameters-5"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionId")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The id of the election")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"censusId")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The new census id (root)")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"censusURI")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The new census URI")))),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L666"},"client.ts:666")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"changeelectionstatus"},"changeElectionStatus"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"changeElectionStatus"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionId"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"newStatus"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Changes the status of an election."),(0,i.kt)("h4",{id:"parameters-6"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionId")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The id of the election")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"newStatus")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"../modules#allelectionstatus"},(0,i.kt)("inlineCode",{parentName:"a"},"AllElectionStatus"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"The new status")))),(0,i.kt)("h4",{id:"returns-6"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L641"},"client.ts:641")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"collectfaucettokens"},"collectFaucetTokens"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"collectFaucetTokens"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"faucetPackage?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#accountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,i.kt)("p",null,"Calls the faucet to get new tokens. Only under development."),(0,i.kt)("h4",{id:"parameters-7"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"faucetPackage?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The faucet package")))),(0,i.kt)("h4",{id:"returns-7"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#accountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,i.kt)("p",null,"Account data information updated with new balance"),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L480"},"client.ts:480")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"continueelection"},"continueElection"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"continueElection"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionId?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Continues an election."),(0,i.kt)("h4",{id:"parameters-8"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionId?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The id of the election")))),(0,i.kt)("h4",{id:"returns-8"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L630"},"client.ts:630")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"createaccount"},"createAccount"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"createAccount"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#accountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,i.kt)("p",null,"Registers an account against vochain, so it can create new elections."),(0,i.kt)("h4",{id:"parameters-9"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Object")),(0,i.kt)("td",{parentName:"tr",align:"left"},"Additional options, like extra information of the account, or the faucet package string")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.account?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"Account"},(0,i.kt)("inlineCode",{parentName:"a"},"Account"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"-")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.faucetPackage?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"-")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.password?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"-")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.sik?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean")),(0,i.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,i.kt)("h4",{id:"returns-9"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#accountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L412"},"client.ts:412")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"createaccountinfo"},"createAccountInfo"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"createAccountInfo"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"options"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#accountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,i.kt)("p",null,"Creates an account with information."),(0,i.kt)("h4",{id:"parameters-10"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Object")),(0,i.kt)("td",{parentName:"tr",align:"left"},"Additional options, like extra information of the account, or the faucet package string.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.account")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"Account"},(0,i.kt)("inlineCode",{parentName:"a"},"Account"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"-")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.faucetPackage?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"-")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.password?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"-")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.signedSikPayload?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,i.kt)("h4",{id:"returns-10"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#accountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L323"},"client.ts:323")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"createcensus"},"createCensus"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"createCensus"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"census"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Publishes the given census."),(0,i.kt)("h4",{id:"parameters-11"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"census")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/PlainCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"PlainCensus"))," ","|"," ",(0,i.kt)("a",{parentName:"td",href:"WeightedCensus"},(0,i.kt)("inlineCode",{parentName:"a"},"WeightedCensus"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"The census to be published.")))),(0,i.kt)("h4",{id:"returns-11"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L940"},"client.ts:940")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"createelection"},"createElection"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"createElection"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Creates a new voting election."),(0,i.kt)("h4",{id:"parameters-12"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"election")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"The election object to be created.")))),(0,i.kt)("h4",{id:"returns-12"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Resulting election id."),(0,i.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L506"},"client.ts:506")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"createelectionsteps"},"createElectionSteps"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"createElectionSteps"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"AsyncGenerator"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#electioncreationstepvalue"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionCreationStepValue")),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Creates a new voting election by steps with async returns."),(0,i.kt)("h4",{id:"parameters-13"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"election")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"The election object to be created.")))),(0,i.kt)("h4",{id:"returns-13"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"AsyncGenerator"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#electioncreationstepvalue"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionCreationStepValue")),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"The async step returns."),(0,i.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L522"},"client.ts:522")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"cspinfo"},"cspInfo"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"cspInfo"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"ICspInfoResponse"),">"),(0,i.kt)("h4",{id:"returns-14"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"ICspInfoResponse"),">"),(0,i.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L979"},"client.ts:979")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"cspsign"},"cspSign"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"cspSign"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"address"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"token"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"parameters-14"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"address")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"token")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-15"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L990"},"client.ts:990")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"cspstep"},"cspStep"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"cspStep"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"stepNumber"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"authToken?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"ICspIntermediateStepResponse")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"ICspFinalStepResponse"),">"),(0,i.kt)("h4",{id:"parameters-15"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"stepNumber")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"data")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"authToken?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-16"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"ICspIntermediateStepResponse")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"ICspFinalStepResponse"),">"),(0,i.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L983"},"client.ts:983")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"cspurl"},"cspUrl"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"cspUrl"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"returns-17"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L974"},"client.ts:974")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"cspvote"},"cspVote"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"cspVote"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"vote"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"proof_type?"),"): ",(0,i.kt)("a",{parentName:"p",href:"CspVote"},(0,i.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,i.kt)("h4",{id:"parameters-16"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"vote")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"Vote"},(0,i.kt)("inlineCode",{parentName:"a"},"Vote")))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"signature")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"proof_type?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"../enums/CspProofType"},(0,i.kt)("inlineCode",{parentName:"a"},"CspProofType")))))),(0,i.kt)("h4",{id:"returns-18"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"CspVote"},(0,i.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,i.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L995"},"client.ts:995")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"endelection"},"endElection"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"endElection"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionId?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Ends an election."),(0,i.kt)("h4",{id:"parameters-17"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionId?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The id of the election")))),(0,i.kt)("h4",{id:"returns-19"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L600"},"client.ts:600")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"estimateelectioncost"},"estimateElectionCost"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"estimateElectionCost"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"election"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,i.kt)("p",null,"Estimates the election cost"),(0,i.kt)("h4",{id:"parameters-18"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"election")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection")))))),(0,i.kt)("h4",{id:"returns-20"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,i.kt)("p",null,"The cost in tokens."),(0,i.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L1022"},"client.ts:1022")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fetchaccount"},"fetchAccount"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fetchAccount"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"address?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#accountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,i.kt)("p",null,"Fetches account."),(0,i.kt)("h4",{id:"parameters-19"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"address?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The account address to fetch the information")))),(0,i.kt)("h4",{id:"returns-21"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#accountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,i.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L196"},"client.ts:196")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fetchaccountinfo"},"fetchAccountInfo"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fetchAccountInfo"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"address?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountData"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"../modules#archivedaccountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"ArchivedAccountData")),">"),(0,i.kt)("p",null,"Fetches account information."),(0,i.kt)("h4",{id:"parameters-20"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"address?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The account address to fetch the information")))),(0,i.kt)("h4",{id:"returns-22"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules#accountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountData"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"../modules#archivedaccountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"ArchivedAccountData")),">"),(0,i.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L177"},"client.ts:177")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fetchcensusinfo"},"fetchCensusInfo"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fetchCensusInfo"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"censusId"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"size"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,i.kt)("inlineCode",{parentName:"a"},"CensusType"))," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"weight"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"bigint")," }",">"),(0,i.kt)("p",null,"Fetches the information of a given census."),(0,i.kt)("h4",{id:"parameters-21"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"censusId")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-23"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<","{"," ",(0,i.kt)("inlineCode",{parentName:"p"},"size"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,i.kt)("inlineCode",{parentName:"a"},"CensusType"))," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"weight"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"bigint")," }",">"),(0,i.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L950"},"client.ts:950")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fetchchaincosts"},"fetchChainCosts"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fetchChainCosts"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../interfaces/IChainGetCostsResponse"},(0,i.kt)("inlineCode",{parentName:"a"},"IChainGetCostsResponse")),">"),(0,i.kt)("p",null,"Fetches blockchain costs information if needed."),(0,i.kt)("h4",{id:"returns-24"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../interfaces/IChainGetCostsResponse"},(0,i.kt)("inlineCode",{parentName:"a"},"IChainGetCostsResponse")),">"),(0,i.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L1004"},"client.ts:1004")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fetchchainid"},"fetchChainId"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fetchChainId"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Fetches blockchain information if needed and returns the chain id."),(0,i.kt)("h4",{id:"returns-25"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L1013"},"client.ts:1013")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fetchcircuits"},"fetchCircuits"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fetchCircuits"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"circuits?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#chaincircuits"},(0,i.kt)("inlineCode",{parentName:"a"},"ChainCircuits")),">"),(0,i.kt)("p",null,"Fetches circuits for anonymous voting"),(0,i.kt)("h4",{id:"parameters-22"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"circuits?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Omit"),"\\<",(0,i.kt)("a",{parentName:"td",href:"../modules#chaincircuits"},(0,i.kt)("inlineCode",{parentName:"a"},"ChainCircuits")),", ",(0,i.kt)("inlineCode",{parentName:"td"},'"zKeyData"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"vKeyData"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"wasmData"'),">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"Additional options for custom circuits")))),(0,i.kt)("h4",{id:"returns-26"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#chaincircuits"},(0,i.kt)("inlineCode",{parentName:"a"},"ChainCircuits")),">"),(0,i.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L960"},"client.ts:960")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fetchelection"},"fetchElection"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fetchElection"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionId?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"ArchivedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"ArchivedElection")),">"),(0,i.kt)("p",null,"Fetches info about an election."),(0,i.kt)("h4",{id:"parameters-23"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionId?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The id of the election")))),(0,i.kt)("h4",{id:"returns-27"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"ArchivedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"ArchivedElection")),">"),(0,i.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L224"},"client.ts:224")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fetchelections"},"fetchElections"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fetchElections"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"account?"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"page?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<(",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ArchivedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"ArchivedElection"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"InvalidElection"},(0,i.kt)("inlineCode",{parentName:"a"},"InvalidElection")),")[]",">"),(0,i.kt)("h4",{id:"parameters-24"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"account?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"page")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"0"))))),(0,i.kt)("h4",{id:"returns-28"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<(",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"PublishedElection"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ArchivedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"ArchivedElection"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"InvalidElection"},(0,i.kt)("inlineCode",{parentName:"a"},"InvalidElection")),")[]",">"),(0,i.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L231"},"client.ts:231")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fetchfaucetpayload"},"fetchFaucetPayload"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fetchFaucetPayload"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Fetches a faucet payload. Only for development."),(0,i.kt)("h4",{id:"returns-29"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L1050"},"client.ts:1050")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fetchproof"},"fetchProof"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fetchProof"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#censusproof"},(0,i.kt)("inlineCode",{parentName:"a"},"CensusProof")),">"),(0,i.kt)("p",null,"Fetches proof that an address is part of the specified census."),(0,i.kt)("h4",{id:"parameters-25"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"censusId")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"Census we want to check the address against")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"key")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The address to be found")))),(0,i.kt)("h4",{id:"returns-30"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#censusproof"},(0,i.kt)("inlineCode",{parentName:"a"},"CensusProof")),">"),(0,i.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L930"},"client.ts:930")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fetchproofforwallet"},"fetchProofForWallet"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fetchProofForWallet"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"censusId"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"wallet"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#censusproof"},(0,i.kt)("inlineCode",{parentName:"a"},"CensusProof")),">"),(0,i.kt)("p",null,"Fetches proof that an address is part of the specified census."),(0,i.kt)("h4",{id:"parameters-26"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"censusId")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wallet")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"Signer"))))),(0,i.kt)("h4",{id:"returns-31"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#censusproof"},(0,i.kt)("inlineCode",{parentName:"a"},"CensusProof")),">"),(0,i.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L245"},"client.ts:245")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generaterandomwallet"},"generateRandomWallet"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"generateRandomWallet"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Assigns a random Wallet to the client and returns its private key."),(0,i.kt)("h4",{id:"returns-32"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The private key."),(0,i.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L901"},"client.ts:901")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"hasalreadyvoted"},"hasAlreadyVoted"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"hasAlreadyVoted"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Checks if the user has already voted"),(0,i.kt)("h4",{id:"parameters-27"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/modules#walletoption"},(0,i.kt)("inlineCode",{parentName:"a"},"WalletOption"))," & ",(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/modules#electionidoption"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionIdOption"))," & ",(0,i.kt)("a",{parentName:"td",href:"../modules#voteidoption"},(0,i.kt)("inlineCode",{parentName:"a"},"VoteIdOption")),">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"Options for has already voted")))),(0,i.kt)("h4",{id:"returns-33"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"The id of the vote"),(0,i.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L711"},"client.ts:711")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"isabletovote"},"isAbleToVote"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"isAbleToVote"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,i.kt)("p",null,"Checks if the user is able to vote"),(0,i.kt)("h4",{id:"parameters-28"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/modules#walletoption"},(0,i.kt)("inlineCode",{parentName:"a"},"WalletOption"))," & ",(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/modules#electionidoption"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionIdOption"))," & ",(0,i.kt)("a",{parentName:"td",href:"../modules#voteidoption"},(0,i.kt)("inlineCode",{parentName:"a"},"VoteIdOption")),">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"Options for is able to vote")))),(0,i.kt)("h4",{id:"returns-34"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,i.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L743"},"client.ts:743")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"isincensus"},"isInCensus"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"isInCensus"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,i.kt)("p",null,"Checks if the user is in census."),(0,i.kt)("h4",{id:"parameters-29"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/modules#walletoption"},(0,i.kt)("inlineCode",{parentName:"a"},"WalletOption"))," & ",(0,i.kt)("a",{parentName:"td",href:"../modules#electionidoption"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionIdOption")),">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"Options for is in census")))),(0,i.kt)("h4",{id:"returns-35"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,i.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L690"},"client.ts:690")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"parsefaucetpackage"},"parseFaucetPackage"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"parseFaucetPackage"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"faucetPackage"),"): ",(0,i.kt)("a",{parentName:"p",href:"../modules#faucetpackage"},(0,i.kt)("inlineCode",{parentName:"a"},"FaucetPackage"))),(0,i.kt)("p",null,"Parses a faucet package."),(0,i.kt)("h4",{id:"parameters-30"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"faucetPackage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The encoded faucet package")))),(0,i.kt)("h4",{id:"returns-36"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"../modules#faucetpackage"},(0,i.kt)("inlineCode",{parentName:"a"},"FaucetPackage"))),(0,i.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L1061"},"client.ts:1061")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"pauseelection"},"pauseElection"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"pauseElection"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionId?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Pauses an election."),(0,i.kt)("h4",{id:"parameters-31"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionId?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The id of the election")))),(0,i.kt)("h4",{id:"returns-37"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L610"},"client.ts:610")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sendtokens"},"sendTokens"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"sendTokens"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"options"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"Send tokens from one account to another."),(0,i.kt)("h4",{id:"parameters-32"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"../modules#sendtokensoptions"},(0,i.kt)("inlineCode",{parentName:"a"},"SendTokensOptions"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"Options for send tokens")))),(0,i.kt)("h4",{id:"returns-38"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L451"},"client.ts:451")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"setaccountinfo"},"setAccountInfo"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"setAccountInfo"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"promAccountData"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#accountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,i.kt)("p",null,"Updates an account with information"),(0,i.kt)("h4",{id:"parameters-33"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"promAccountData")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Promise"),"\\<","{"," ",(0,i.kt)("inlineCode",{parentName:"td"},"message"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"metadata"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"tx"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"Uint8Array")," }",">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"Account data promise in Tx form.")))),(0,i.kt)("h4",{id:"returns-39"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#accountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,i.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L392"},"client.ts:392")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"setaccountsik"},"setAccountSIK"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"setAccountSIK"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionId"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"signature"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"password"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"censusProof"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"wallet"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"parameters-34"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionId")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"signature")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"password")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"censusProof")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"../modules#censusproof"},(0,i.kt)("inlineCode",{parentName:"a"},"CensusProof")))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wallet")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"Signer"))))),(0,i.kt)("h4",{id:"returns-40"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L249"},"client.ts:249")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"setcircuits"},"setCircuits"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"setCircuits"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"circuits"),"): ",(0,i.kt)("a",{parentName:"p",href:"../modules#chaincircuits"},(0,i.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,i.kt)("p",null,"Sets circuits for anonymous voting"),(0,i.kt)("h4",{id:"parameters-35"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"circuits")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"../modules#chaincircuits"},(0,i.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"Custom circuits")))),(0,i.kt)("h4",{id:"returns-41"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"../modules#chaincircuits"},(0,i.kt)("inlineCode",{parentName:"a"},"ChainCircuits"))),(0,i.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L970"},"client.ts:970")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"setelectionid"},"setElectionId"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"setElectionId"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"electionId"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("p",null,"Sets an election id. Required by other methods like submitVote or createElection."),(0,i.kt)("h4",{id:"parameters-36"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"electionId")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"Election id string")))),(0,i.kt)("h4",{id:"returns-42"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L167"},"client.ts:167")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"submitvote"},"submitVote"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"submitVote"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"vote"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Submits a vote."),(0,i.kt)("h4",{id:"parameters-37"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"vote")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Vote"},(0,i.kt)("inlineCode",{parentName:"a"},"Vote"))," ","|"," ",(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/AnonymousVote"},(0,i.kt)("inlineCode",{parentName:"a"},"AnonymousVote"))," ","|"," ",(0,i.kt)("a",{parentName:"td",href:"CspVote"},(0,i.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"The vote (or votes) to be sent.")))),(0,i.kt)("h4",{id:"returns-43"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Vote confirmation id."),(0,i.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L790"},"client.ts:790")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"submitvotesteps"},"submitVoteSteps"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"submitVoteSteps"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"vote"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"AsyncGenerator"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#votestepvalue"},(0,i.kt)("inlineCode",{parentName:"a"},"VoteStepValue")),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Submits a vote by steps."),(0,i.kt)("h4",{id:"parameters-38"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"vote")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Vote"},(0,i.kt)("inlineCode",{parentName:"a"},"Vote"))," ","|"," ",(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/AnonymousVote"},(0,i.kt)("inlineCode",{parentName:"a"},"AnonymousVote"))," ","|"," ",(0,i.kt)("a",{parentName:"td",href:"CspVote"},(0,i.kt)("inlineCode",{parentName:"a"},"CspVote"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"The vote (or votes) to be sent.")))),(0,i.kt)("h4",{id:"returns-44"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"AsyncGenerator"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#votestepvalue"},(0,i.kt)("inlineCode",{parentName:"a"},"VoteStepValue")),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Vote confirmation id."),(0,i.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L806"},"client.ts:806")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"updateaccountinfo"},"updateAccountInfo"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"updateAccountInfo"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"account"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#accountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,i.kt)("p",null,"Updates an account with information"),(0,i.kt)("h4",{id:"parameters-39"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"account")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"Account"},(0,i.kt)("inlineCode",{parentName:"a"},"Account"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"Account data.")))),(0,i.kt)("h4",{id:"returns-45"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("a",{parentName:"p",href:"../modules#accountdata"},(0,i.kt)("inlineCode",{parentName:"a"},"AccountData")),">"),(0,i.kt)("h4",{id:"defined-in-60"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L366"},"client.ts:366")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votesleftcount"},"votesLeftCount"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"votesLeftCount"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,i.kt)("p",null,"Checks how many times a user can submit their vote"),(0,i.kt)("h4",{id:"parameters-40"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/modules#walletoption"},(0,i.kt)("inlineCode",{parentName:"a"},"WalletOption"))," & ",(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/modules#electionidoption"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionIdOption"))," & ",(0,i.kt)("a",{parentName:"td",href:"../modules#voteidoption"},(0,i.kt)("inlineCode",{parentName:"a"},"VoteIdOption")),">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"Options for votes left count")))),(0,i.kt)("h4",{id:"returns-46"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,i.kt)("h4",{id:"defined-in-61"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L753"},"client.ts:753")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"waitfortransaction"},"waitForTransaction"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"waitForTransaction"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"tx"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"wait?"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"attempts?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("p",null,"A convenience method to wait for a transaction to be executed. It will\nloop trying to get the transaction information, and will retry every time\nit fails."),(0,i.kt)("h4",{id:"parameters-41"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"tx")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"Transaction to wait for")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wait?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The delay in milliseconds between tries")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"attempts?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The attempts to try before failing")))),(0,i.kt)("h4",{id:"returns-47"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-62"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L1075"},"client.ts:1075")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generatewalletfromdata"},"generateWalletFromData"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"generateWalletFromData"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Wallet")),(0,i.kt)("p",null,"Returns a Wallet based on the inputs."),(0,i.kt)("h4",{id:"parameters-42"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"data")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,i.kt)("td",{parentName:"tr",align:"left"},"The data inputs which should generate the Wallet")))),(0,i.kt)("h4",{id:"returns-48"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Wallet")),(0,i.kt)("p",null,"The deterministic wallet."),(0,i.kt)("h4",{id:"defined-in-63"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/client.ts#L913"},"client.ts:913")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c84aae18.7d18f8a8.js b/assets/js/c84aae18.7d18f8a8.js new file mode 100644 index 000000000..db677f642 --- /dev/null +++ b/assets/js/c84aae18.7d18f8a8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4324],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>m});var i=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function r(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=i.createContext({}),o=function(e){var t=i.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},s=function(e){var t=o(e.components);return i.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,p=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),k=o(n),m=a,h=k["".concat(p,".").concat(m)]||k[m]||u[m]||l;return n?i.createElement(h,r(r({ref:t},s),{},{components:n})):i.createElement(h,r({ref:t},s))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,r=new Array(l);r[0]=k;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:a,r[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>r,default:()=>u,frontMatter:()=>l,metadata:()=>d,toc:()=>o});var i=n(87462),a=(n(67294),n(3905));const l={},r=void 0,d={unversionedId:"sdk/reference/classes/BudgetElection",id:"sdk/reference/classes/BudgetElection",title:"BudgetElection",description:"@vocdoni/sdk / Exports / BudgetElection",source:"@site/docs/sdk/reference/classes/BudgetElection.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/BudgetElection",permalink:"/sdk/reference/classes/BudgetElection",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ArchivedElection",permalink:"/sdk/reference/classes/ArchivedElection"},next:{title:"Census",permalink:"/sdk/reference/classes/Census"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_addSDKVersion",id:"_addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_census",id:"_census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_description",id:"_description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"_electionType",id:"_electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"_endDate",id:"_enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"_forceFullBudget",id:"_forcefullbudget",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"_header",id:"_header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"_maxCensusSize",id:"_maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"_meta",id:"_meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"_minStep",id:"_minstep",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"_questions",id:"_questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"_startDate",id:"_startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"_streamUri",id:"_streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"_temporarySecretIdentity",id:"_temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"_title",id:"_title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"_voteType",id:"_votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"census",id:"census",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"description",id:"description",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"duration",id:"duration",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"endDate",id:"enddate",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"forceFullBudget",id:"forcefullbudget",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"header",id:"header",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-25",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-26",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"maxBudget",id:"maxbudget",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-27",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-28",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"meta",id:"meta",level:3},{value:"Returns",id:"returns-20",level:4},{value:"Inherited from",id:"inherited-from-29",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Inherited from",id:"inherited-from-30",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"minStep",id:"minstep",level:3},{value:"Returns",id:"returns-22",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"questions",id:"questions",level:3},{value:"Returns",id:"returns-24",level:4},{value:"Inherited from",id:"inherited-from-31",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Inherited from",id:"inherited-from-32",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"startDate",id:"startdate",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Inherited from",id:"inherited-from-33",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Inherited from",id:"inherited-from-34",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Returns",id:"returns-28",level:4},{value:"Inherited from",id:"inherited-from-35",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Inherited from",id:"inherited-from-36",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Returns",id:"returns-30",level:4},{value:"Inherited from",id:"inherited-from-37",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Inherited from",id:"inherited-from-38",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"title",id:"title",level:3},{value:"Returns",id:"returns-32",level:4},{value:"Inherited from",id:"inherited-from-39",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Inherited from",id:"inherited-from-40",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"useCensusWeightAsBudget",id:"usecensusweightasbudget",level:3},{value:"Returns",id:"returns-34",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"voteType",id:"votetype",level:3},{value:"Returns",id:"returns-36",level:4},{value:"Inherited from",id:"inherited-from-41",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Inherited from",id:"inherited-from-42",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"Methods",id:"methods-1",level:2},{value:"addQuestion",id:"addquestion",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-38",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"generateEnvelopeType",id:"generateenvelopetype",level:3},{value:"Returns",id:"returns-39",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"generateMetadata",id:"generatemetadata",level:3},{value:"Returns",id:"returns-40",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"generateMode",id:"generatemode",level:3},{value:"Returns",id:"returns-41",level:4},{value:"Inherited from",id:"inherited-from-43",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"generateVoteOptions",id:"generatevoteoptions",level:3},{value:"Returns",id:"returns-42",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-43",level:4},{value:"Inherited from",id:"inherited-from-44",level:4},{value:"Defined in",id:"defined-in-59",level:4},{value:"removeQuestion",id:"removequestion",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-44",level:4},{value:"Inherited from",id:"inherited-from-45",level:4},{value:"Defined in",id:"defined-in-60",level:4},{value:"checkVote",id:"checkvote",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Defined in",id:"defined-in-61",level:4},{value:"from",id:"from",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-46",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-62",level:4}],s={toc:o};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / BudgetElection"),(0,a.kt)("h1",{id:"class-budgetelection"},"Class: BudgetElection"),(0,a.kt)("p",null,"Represents a budget election"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"BudgetElection"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_addsdkversion"},"_","addSDKVersion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_census"},"_","census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_description"},"_","description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_electiontype"},"_","electionType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_enddate"},"_","endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_forcefullbudget"},"_","forceFullBudget")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_header"},"_","header")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_maxcensussize"},"_","maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_meta"},"_","meta")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_minstep"},"_","minStep")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_questions"},"_","questions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_startdate"},"_","startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_streamuri"},"_","streamUri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_temporarysecretidentity"},"_","temporarySecretIdentity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_title"},"_","title")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_votetype"},"_","voteType"))),(0,a.kt)("h3",{id:"accessors"},"Accessors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#addsdkversion"},"addSDKVersion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#census"},"census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#description"},"description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#duration"},"duration")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#electiontype"},"electionType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#enddate"},"endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#forcefullbudget"},"forceFullBudget")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#header"},"header")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#maxbudget"},"maxBudget")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#maxcensussize"},"maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#meta"},"meta")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#minstep"},"minStep")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#questions"},"questions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#startdate"},"startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#streamuri"},"streamUri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#temporarysecretidentity"},"temporarySecretIdentity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#title"},"title")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#usecensusweightasbudget"},"useCensusWeightAsBudget")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#votetype"},"voteType"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#addquestion"},"addQuestion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#generateenvelopetype"},"generateEnvelopeType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#generatemetadata"},"generateMetadata")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#generatemode"},"generateMode")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#generatevoteoptions"},"generateVoteOptions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#get"},"get")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#removequestion"},"removeQuestion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#checkvote"},"checkVote")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"BudgetElection#from"},"from"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new BudgetElection"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"BudgetElection"},(0,a.kt)("inlineCode",{parentName:"a"},"BudgetElection"))),(0,a.kt)("p",null,"Constructs a budget election"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../modules#ibudgetelectionparameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParameters"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"Budget election parameters")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"BudgetElection"},(0,a.kt)("inlineCode",{parentName:"a"},"BudgetElection"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L35"},"types/election/budget.ts:35")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"_addsdkversion"},"_","addSDKVersion"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","addSDKVersion"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_addsdkversion"},"_addSDKVersion")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L175"},"types/election/election.ts:175")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_census"},"_","census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","census"),": ",(0,a.kt)("a",{parentName:"p",href:"Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_census"},"_census")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L172"},"types/election/election.ts:172")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_description"},"_","description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_description"},"_description")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L163"},"types/election/election.ts:163")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_electiontype"},"_","electionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","electionType"),": ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_electiontype"},"_electionType")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L169"},"types/election/election.ts:169")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_enddate"},"_","endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","endDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_enddate"},"_endDate")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L168"},"types/election/election.ts:168")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_forcefullbudget"},"_","forceFullBudget"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","forceFullBudget"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L28"},"types/election/budget.ts:28")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_header"},"_","header"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","header"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_header"},"_header")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L164"},"types/election/election.ts:164")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_maxcensussize"},"_","maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","maxCensusSize"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_maxcensussize"},"_maxCensusSize")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L173"},"types/election/election.ts:173")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_meta"},"_","meta"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","meta"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_meta"},"_meta")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L166"},"types/election/election.ts:166")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_minstep"},"_","minStep"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","minStep"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L27"},"types/election/budget.ts:27")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_questions"},"_","questions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","questions"),": ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_questions"},"_questions")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L171"},"types/election/election.ts:171")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_startdate"},"_","startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","startDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_startdate"},"_startDate")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L167"},"types/election/election.ts:167")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_streamuri"},"_","streamUri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","streamUri"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_streamuri"},"_streamUri")),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L165"},"types/election/election.ts:165")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_temporarysecretidentity"},"_","temporarySecretIdentity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","temporarySecretIdentity"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_temporarysecretidentity"},"_temporarySecretIdentity")),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L174"},"types/election/election.ts:174")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_title"},"_","title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","title"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_title"},"_title")),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L162"},"types/election/election.ts:162")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_votetype"},"_","voteType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","voteType"),": ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_votetype"},"_voteType")),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L170"},"types/election/election.ts:170")),(0,a.kt)("h2",{id:"accessors-1"},"Accessors"),(0,a.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"addSDKVersion"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.addSDKVersion"),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L275"},"types/election/unpublished.ts:275")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"addSDKVersion"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.addSDKVersion"),(0,a.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L279"},"types/election/unpublished.ts:279")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"census"},"census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"census"),"(): ",(0,a.kt)("a",{parentName:"p",href:"Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.census"),(0,a.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L249"},"types/election/unpublished.ts:249")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"census"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census")))))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.census"),(0,a.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L253"},"types/election/unpublished.ts:253")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"description"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.description"),(0,a.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L173"},"types/election/unpublished.ts:173")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"description"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.description"),(0,a.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L177"},"types/election/unpublished.ts:177")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"duration"},"duration"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"duration"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.duration"),(0,a.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L138"},"types/election/unpublished.ts:138")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"electiontype"},"electionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"electionType"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"inherited-from-21"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.electionType"),(0,a.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L225"},"types/election/unpublished.ts:225")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"electionType"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-4"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType")))))),(0,a.kt)("h4",{id:"returns-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-22"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.electionType"),(0,a.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L229"},"types/election/unpublished.ts:229")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enddate"},"endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"endDate"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"returns-10"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-23"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.endDate"),(0,a.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L215"},"types/election/unpublished.ts:215")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"endDate"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-5"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,a.kt)("h4",{id:"returns-11"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-24"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.endDate"),(0,a.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L219"},"types/election/unpublished.ts:219")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"forcefullbudget"},"forceFullBudget"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"forceFullBudget"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-12"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L132"},"types/election/budget.ts:132")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"forceFullBudget"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-6"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-13"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L136"},"types/election/budget.ts:136")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"header"},"header"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"header"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-14"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-25"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.header"),(0,a.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L181"},"types/election/unpublished.ts:181")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"header"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-7"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-15"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-26"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.header"),(0,a.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L185"},"types/election/unpublished.ts:185")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxbudget"},"maxBudget"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"maxBudget"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-16"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L148"},"types/election/budget.ts:148")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"maxBudget"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-8"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-17"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L152"},"types/election/budget.ts:152")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-18"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-27"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.maxCensusSize"),(0,a.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L258"},"types/election/unpublished.ts:258")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-9"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-19"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-28"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.maxCensusSize"),(0,a.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L262"},"types/election/unpublished.ts:262")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"meta"},"meta"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"meta"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"returns-20"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-29"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.meta"),(0,a.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L197"},"types/election/unpublished.ts:197")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"meta"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-10"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"any"))))),(0,a.kt)("h4",{id:"returns-21"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-30"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.meta"),(0,a.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L201"},"types/election/unpublished.ts:201")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"minstep"},"minStep"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"minStep"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-22"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L124"},"types/election/budget.ts:124")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"minStep"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-11"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-23"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L128"},"types/election/budget.ts:128")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"questions"},"questions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"questions"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"returns-24"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"inherited-from-31"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.questions"),(0,a.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L241"},"types/election/unpublished.ts:241")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"questions"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-12"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]")))),(0,a.kt)("h4",{id:"returns-25"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-32"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.questions"),(0,a.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L245"},"types/election/unpublished.ts:245")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"startdate"},"startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"startDate"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"returns-26"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-33"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.startDate"),(0,a.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L206"},"types/election/unpublished.ts:206")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"startDate"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-13"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,a.kt)("h4",{id:"returns-27"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-34"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.startDate"),(0,a.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L210"},"types/election/unpublished.ts:210")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"streamuri"},"streamUri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"streamUri"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-28"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-35"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.streamUri"),(0,a.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L189"},"types/election/unpublished.ts:189")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"streamUri"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-14"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-29"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-36"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.streamUri"),(0,a.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L193"},"types/election/unpublished.ts:193")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-30"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-37"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.temporarySecretIdentity"),(0,a.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L267"},"types/election/unpublished.ts:267")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-15"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-31"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-38"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.temporarySecretIdentity"),(0,a.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L271"},"types/election/unpublished.ts:271")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"title"},"title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"title"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"returns-32"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-39"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.title"),(0,a.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L164"},"types/election/unpublished.ts:164")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"title"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-16"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,a.kt)("h4",{id:"returns-33"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-40"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.title"),(0,a.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L168"},"types/election/unpublished.ts:168")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"usecensusweightasbudget"},"useCensusWeightAsBudget"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"useCensusWeightAsBudget"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-34"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L140"},"types/election/budget.ts:140")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"useCensusWeightAsBudget"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-17"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-35"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L144"},"types/election/budget.ts:144")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votetype"},"voteType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"voteType"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"returns-36"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"inherited-from-41"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.voteType"),(0,a.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L233"},"types/election/unpublished.ts:233")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"voteType"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-18"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,a.kt)("h4",{id:"returns-37"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-42"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.voteType"),(0,a.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L237"},"types/election/unpublished.ts:237")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"addquestion"},"addQuestion"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"addQuestion"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"title"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"description"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"choices"),"): ",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"parameters-19"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"title")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"description")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"choices")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(","{"," ",(0,a.kt)("inlineCode",{parentName:"td"},"title"),": ",(0,a.kt)("inlineCode",{parentName:"td"},"string")," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"td"},"title"),": ",(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">"," })[]")))),(0,a.kt)("h4",{id:"returns-38"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#addquestion"},"addQuestion")),(0,a.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L49"},"types/election/budget.ts:49")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generateenvelopetype"},"generateEnvelopeType"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateEnvelopeType"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"returns-39"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"overrides-2"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#generateenvelopetype"},"generateEnvelopeType")),(0,a.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L78"},"types/election/budget.ts:78")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generatemetadata"},"generateMetadata"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateMetadata"),"(): ",(0,a.kt)("a",{parentName:"p",href:"../interfaces/ElectionMetadata"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,a.kt)("h4",{id:"returns-40"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"../interfaces/ElectionMetadata"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,a.kt)("h4",{id:"overrides-3"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#generatemetadata"},"generateMetadata")),(0,a.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L88"},"types/election/budget.ts:88")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generatemode"},"generateMode"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateMode"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"returns-41"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"inherited-from-43"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#generatemode"},"generateMode")),(0,a.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L154"},"types/election/unpublished.ts:154")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generatevoteoptions"},"generateVoteOptions"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateVoteOptions"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"returns-42"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"overrides-4"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#generatevoteoptions"},"generateVoteOptions")),(0,a.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L68"},"types/election/budget.ts:68")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"get"},"get"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"get"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"dot"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"parameters-20"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"dot")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-43"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-44"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#get"},"get")),(0,a.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L266"},"types/election/election.ts:266")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"removequestion"},"removeQuestion"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"removeQuestion"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"questionNumber"),"): ",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"parameters-21"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"questionNumber")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-44"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"inherited-from-45"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#removequestion"},"removeQuestion")),(0,a.kt)("h4",{id:"defined-in-60"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L60"},"types/election/unpublished.ts:60")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"checkvote"},"checkVote"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"checkVote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"vote"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"resultsType"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"voteType"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-22"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"vote")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote")))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"resultsType")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../modules#electionresultstype"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionResultsType")))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"voteType")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,a.kt)("h4",{id:"returns-45"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-61"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L104"},"types/election/budget.ts:104")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"from"},"from"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"from"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"BudgetElection"},(0,a.kt)("inlineCode",{parentName:"a"},"BudgetElection"))),(0,a.kt)("p",null,"Returns an unpublished election object"),(0,a.kt)("h4",{id:"parameters-23"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"../modules#ibudgetelectionparameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParameters"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"Unpublished Election parameters")))),(0,a.kt)("h4",{id:"returns-46"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"BudgetElection"},(0,a.kt)("inlineCode",{parentName:"a"},"BudgetElection"))),(0,a.kt)("h4",{id:"overrides-5"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"UnpublishedElection#from"},"from")),(0,a.kt)("h4",{id:"defined-in-62"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L45"},"types/election/budget.ts:45")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c84aae18.800d62e5.js b/assets/js/c84aae18.800d62e5.js deleted file mode 100644 index 948054d57..000000000 --- a/assets/js/c84aae18.800d62e5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4324],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>m});var i=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=i.createContext({}),s=function(e){var t=i.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},o=function(e){var t=s(e.components);return i.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},u=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,p=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),u=s(n),m=a,c=u["".concat(p,".").concat(m)]||u[m]||k[m]||r;return n?i.createElement(c,l(l({ref:t},o),{},{components:n})):i.createElement(c,l({ref:t},o))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,l=new Array(r);l[0]=u;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:a,l[1]=d;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>k,frontMatter:()=>r,metadata:()=>d,toc:()=>s});var i=n(87462),a=(n(67294),n(3905));const r={},l=void 0,d={unversionedId:"sdk/reference/classes/BudgetElection",id:"sdk/reference/classes/BudgetElection",title:"BudgetElection",description:"@vocdoni/sdk / Exports / BudgetElection",source:"@site/docs/sdk/reference/classes/BudgetElection.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/BudgetElection",permalink:"/sdk/reference/classes/BudgetElection",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ArchivedElection",permalink:"/sdk/reference/classes/ArchivedElection"},next:{title:"Census",permalink:"/sdk/reference/classes/Census"}},p={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_addSDKVersion",id:"_addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_census",id:"_census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_description",id:"_description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"_electionType",id:"_electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"_endDate",id:"_enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"_forceFullBudget",id:"_forcefullbudget",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"_header",id:"_header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"_maxCensusSize",id:"_maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"_meta",id:"_meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"_minStep",id:"_minstep",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"_questions",id:"_questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"_startDate",id:"_startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"_streamUri",id:"_streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"_temporarySecretIdentity",id:"_temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"_title",id:"_title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"_voteType",id:"_votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"census",id:"census",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"description",id:"description",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"duration",id:"duration",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"endDate",id:"enddate",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"forceFullBudget",id:"forcefullbudget",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"header",id:"header",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-25",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-26",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"maxBudget",id:"maxbudget",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-27",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-28",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"meta",id:"meta",level:3},{value:"Returns",id:"returns-20",level:4},{value:"Inherited from",id:"inherited-from-29",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Inherited from",id:"inherited-from-30",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"minStep",id:"minstep",level:3},{value:"Returns",id:"returns-22",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"questions",id:"questions",level:3},{value:"Returns",id:"returns-24",level:4},{value:"Inherited from",id:"inherited-from-31",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Inherited from",id:"inherited-from-32",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"startDate",id:"startdate",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Inherited from",id:"inherited-from-33",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Inherited from",id:"inherited-from-34",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Returns",id:"returns-28",level:4},{value:"Inherited from",id:"inherited-from-35",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Inherited from",id:"inherited-from-36",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Returns",id:"returns-30",level:4},{value:"Inherited from",id:"inherited-from-37",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Inherited from",id:"inherited-from-38",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"title",id:"title",level:3},{value:"Returns",id:"returns-32",level:4},{value:"Inherited from",id:"inherited-from-39",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Inherited from",id:"inherited-from-40",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"useCensusWeightAsBudget",id:"usecensusweightasbudget",level:3},{value:"Returns",id:"returns-34",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"voteType",id:"votetype",level:3},{value:"Returns",id:"returns-36",level:4},{value:"Inherited from",id:"inherited-from-41",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Inherited from",id:"inherited-from-42",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"Methods",id:"methods-1",level:2},{value:"addQuestion",id:"addquestion",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-38",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"generateEnvelopeType",id:"generateenvelopetype",level:3},{value:"Returns",id:"returns-39",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"generateMetadata",id:"generatemetadata",level:3},{value:"Returns",id:"returns-40",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"generateMode",id:"generatemode",level:3},{value:"Returns",id:"returns-41",level:4},{value:"Inherited from",id:"inherited-from-43",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"generateVoteOptions",id:"generatevoteoptions",level:3},{value:"Returns",id:"returns-42",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-43",level:4},{value:"Inherited from",id:"inherited-from-44",level:4},{value:"Defined in",id:"defined-in-59",level:4},{value:"removeQuestion",id:"removequestion",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-44",level:4},{value:"Inherited from",id:"inherited-from-45",level:4},{value:"Defined in",id:"defined-in-60",level:4},{value:"checkVote",id:"checkvote",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Defined in",id:"defined-in-61",level:4},{value:"from",id:"from",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-46",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-62",level:4}],o={toc:s};function k(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / BudgetElection"),(0,a.kt)("h1",{id:"class-budgetelection"},"Class: BudgetElection"),(0,a.kt)("p",null,"Represents a budget election"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"BudgetElection"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_addsdkversion"},"_","addSDKVersion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_census"},"_","census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_description"},"_","description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_electiontype"},"_","electionType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_enddate"},"_","endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_forcefullbudget"},"_","forceFullBudget")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_header"},"_","header")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_maxcensussize"},"_","maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_meta"},"_","meta")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_minstep"},"_","minStep")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_questions"},"_","questions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_startdate"},"_","startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_streamuri"},"_","streamUri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_temporarysecretidentity"},"_","temporarySecretIdentity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_title"},"_","title")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#_votetype"},"_","voteType"))),(0,a.kt)("h3",{id:"accessors"},"Accessors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#addsdkversion"},"addSDKVersion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#census"},"census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#description"},"description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#duration"},"duration")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#electiontype"},"electionType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#enddate"},"endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#forcefullbudget"},"forceFullBudget")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#header"},"header")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#maxbudget"},"maxBudget")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#maxcensussize"},"maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#meta"},"meta")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#minstep"},"minStep")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#questions"},"questions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#startdate"},"startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#streamuri"},"streamUri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#temporarysecretidentity"},"temporarySecretIdentity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#title"},"title")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#usecensusweightasbudget"},"useCensusWeightAsBudget")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#votetype"},"voteType"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#addquestion"},"addQuestion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#generateenvelopetype"},"generateEnvelopeType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#generatemetadata"},"generateMetadata")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#generatemode"},"generateMode")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#generatevoteoptions"},"generateVoteOptions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#get"},"get")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#removequestion"},"removeQuestion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#checkvote"},"checkVote")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/BudgetElection#from"},"from"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new BudgetElection"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/BudgetElection"},(0,a.kt)("inlineCode",{parentName:"a"},"BudgetElection"))),(0,a.kt)("p",null,"Constructs a budget election"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/modules#ibudgetelectionparameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParameters"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"Budget election parameters")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/BudgetElection"},(0,a.kt)("inlineCode",{parentName:"a"},"BudgetElection"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L35"},"types/election/budget.ts:35")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"_addsdkversion"},"_","addSDKVersion"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","addSDKVersion"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_addsdkversion"},"_addSDKVersion")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L175"},"types/election/election.ts:175")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_census"},"_","census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","census"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_census"},"_census")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L172"},"types/election/election.ts:172")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_description"},"_","description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_description"},"_description")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L163"},"types/election/election.ts:163")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_electiontype"},"_","electionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","electionType"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_electiontype"},"_electionType")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L169"},"types/election/election.ts:169")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_enddate"},"_","endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","endDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_enddate"},"_endDate")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L168"},"types/election/election.ts:168")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_forcefullbudget"},"_","forceFullBudget"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","forceFullBudget"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L28"},"types/election/budget.ts:28")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_header"},"_","header"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","header"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_header"},"_header")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L164"},"types/election/election.ts:164")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_maxcensussize"},"_","maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","maxCensusSize"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_maxcensussize"},"_maxCensusSize")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L173"},"types/election/election.ts:173")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_meta"},"_","meta"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","meta"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_meta"},"_meta")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L166"},"types/election/election.ts:166")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_minstep"},"_","minStep"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","minStep"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L27"},"types/election/budget.ts:27")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_questions"},"_","questions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","questions"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_questions"},"_questions")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L171"},"types/election/election.ts:171")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_startdate"},"_","startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","startDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_startdate"},"_startDate")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L167"},"types/election/election.ts:167")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_streamuri"},"_","streamUri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","streamUri"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_streamuri"},"_streamUri")),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L165"},"types/election/election.ts:165")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_temporarysecretidentity"},"_","temporarySecretIdentity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","temporarySecretIdentity"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_temporarysecretidentity"},"_temporarySecretIdentity")),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L174"},"types/election/election.ts:174")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_title"},"_","title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","title"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_title"},"_title")),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L162"},"types/election/election.ts:162")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"_votetype"},"_","voteType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,a.kt)("strong",{parentName:"p"},"_","voteType"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#_votetype"},"_voteType")),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L170"},"types/election/election.ts:170")),(0,a.kt)("h2",{id:"accessors-1"},"Accessors"),(0,a.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"addSDKVersion"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.addSDKVersion"),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L275"},"types/election/unpublished.ts:275")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"addSDKVersion"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.addSDKVersion"),(0,a.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L279"},"types/election/unpublished.ts:279")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"census"},"census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"census"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.census"),(0,a.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L249"},"types/election/unpublished.ts:249")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"census"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census")))))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.census"),(0,a.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L253"},"types/election/unpublished.ts:253")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"description"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.description"),(0,a.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L173"},"types/election/unpublished.ts:173")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"description"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.description"),(0,a.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L177"},"types/election/unpublished.ts:177")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"duration"},"duration"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"duration"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.duration"),(0,a.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L138"},"types/election/unpublished.ts:138")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"electiontype"},"electionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"electionType"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"inherited-from-21"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.electionType"),(0,a.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L225"},"types/election/unpublished.ts:225")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"electionType"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-4"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType")))))),(0,a.kt)("h4",{id:"returns-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-22"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.electionType"),(0,a.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L229"},"types/election/unpublished.ts:229")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enddate"},"endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"endDate"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"returns-10"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-23"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.endDate"),(0,a.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L215"},"types/election/unpublished.ts:215")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"endDate"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-5"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,a.kt)("h4",{id:"returns-11"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-24"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.endDate"),(0,a.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L219"},"types/election/unpublished.ts:219")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"forcefullbudget"},"forceFullBudget"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"forceFullBudget"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-12"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L132"},"types/election/budget.ts:132")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"forceFullBudget"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-6"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-13"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L136"},"types/election/budget.ts:136")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"header"},"header"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"header"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-14"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-25"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.header"),(0,a.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L181"},"types/election/unpublished.ts:181")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"header"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-7"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-15"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-26"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.header"),(0,a.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L185"},"types/election/unpublished.ts:185")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxbudget"},"maxBudget"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"maxBudget"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-16"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L148"},"types/election/budget.ts:148")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"maxBudget"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-8"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-17"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L152"},"types/election/budget.ts:152")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-18"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-27"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.maxCensusSize"),(0,a.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L258"},"types/election/unpublished.ts:258")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-9"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-19"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-28"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.maxCensusSize"),(0,a.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L262"},"types/election/unpublished.ts:262")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"meta"},"meta"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"meta"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"returns-20"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-29"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.meta"),(0,a.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L197"},"types/election/unpublished.ts:197")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"meta"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-10"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"any"))))),(0,a.kt)("h4",{id:"returns-21"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-30"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.meta"),(0,a.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L201"},"types/election/unpublished.ts:201")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"minstep"},"minStep"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"minStep"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-22"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L124"},"types/election/budget.ts:124")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"minStep"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-11"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-23"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L128"},"types/election/budget.ts:128")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"questions"},"questions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"questions"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"returns-24"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"inherited-from-31"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.questions"),(0,a.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L241"},"types/election/unpublished.ts:241")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"questions"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-12"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]")))),(0,a.kt)("h4",{id:"returns-25"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-32"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.questions"),(0,a.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L245"},"types/election/unpublished.ts:245")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"startdate"},"startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"startDate"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"returns-26"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"inherited-from-33"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.startDate"),(0,a.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L206"},"types/election/unpublished.ts:206")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"startDate"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-13"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,a.kt)("h4",{id:"returns-27"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-34"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.startDate"),(0,a.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L210"},"types/election/unpublished.ts:210")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"streamuri"},"streamUri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"streamUri"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-28"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-35"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.streamUri"),(0,a.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L189"},"types/election/unpublished.ts:189")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"streamUri"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-14"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-29"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-36"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.streamUri"),(0,a.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L193"},"types/election/unpublished.ts:193")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-30"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-37"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.temporarySecretIdentity"),(0,a.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L267"},"types/election/unpublished.ts:267")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-15"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-31"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-38"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.temporarySecretIdentity"),(0,a.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L271"},"types/election/unpublished.ts:271")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"title"},"title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"title"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"returns-32"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"inherited-from-39"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.title"),(0,a.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L164"},"types/election/unpublished.ts:164")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"title"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-16"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,a.kt)("h4",{id:"returns-33"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-40"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.title"),(0,a.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L168"},"types/election/unpublished.ts:168")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"usecensusweightasbudget"},"useCensusWeightAsBudget"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"useCensusWeightAsBudget"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-34"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L140"},"types/election/budget.ts:140")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"useCensusWeightAsBudget"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-17"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,a.kt)("h4",{id:"returns-35"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L144"},"types/election/budget.ts:144")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votetype"},"voteType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"voteType"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"returns-36"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"inherited-from-41"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.voteType"),(0,a.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L233"},"types/election/unpublished.ts:233")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"voteType"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-18"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,a.kt)("h4",{id:"returns-37"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-42"},"Inherited from"),(0,a.kt)("p",null,"UnpublishedElection.voteType"),(0,a.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L237"},"types/election/unpublished.ts:237")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"addquestion"},"addQuestion"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"addQuestion"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"title"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"description"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"choices"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"parameters-19"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"title")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"description")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"choices")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(","{"," ",(0,a.kt)("inlineCode",{parentName:"td"},"title"),": ",(0,a.kt)("inlineCode",{parentName:"td"},"string")," } ","|"," ","{"," ",(0,a.kt)("inlineCode",{parentName:"td"},"title"),": ",(0,a.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"string"),">"," })[]")))),(0,a.kt)("h4",{id:"returns-38"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#addquestion"},"addQuestion")),(0,a.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L49"},"types/election/budget.ts:49")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generateenvelopetype"},"generateEnvelopeType"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateEnvelopeType"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"returns-39"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"overrides-2"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#generateenvelopetype"},"generateEnvelopeType")),(0,a.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L78"},"types/election/budget.ts:78")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generatemetadata"},"generateMetadata"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateMetadata"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ElectionMetadata"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,a.kt)("h4",{id:"returns-40"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ElectionMetadata"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,a.kt)("h4",{id:"overrides-3"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#generatemetadata"},"generateMetadata")),(0,a.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L88"},"types/election/budget.ts:88")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generatemode"},"generateMode"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateMode"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"returns-41"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"inherited-from-43"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#generatemode"},"generateMode")),(0,a.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L154"},"types/election/unpublished.ts:154")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"generatevoteoptions"},"generateVoteOptions"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"generateVoteOptions"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"returns-42"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"object")),(0,a.kt)("h4",{id:"overrides-4"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#generatevoteoptions"},"generateVoteOptions")),(0,a.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L68"},"types/election/budget.ts:68")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"get"},"get"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"get"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"dot"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"parameters-20"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"dot")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-43"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-44"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#get"},"get")),(0,a.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L266"},"types/election/election.ts:266")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"removequestion"},"removeQuestion"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"removeQuestion"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"questionNumber"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"parameters-21"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"questionNumber")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number"))))),(0,a.kt)("h4",{id:"returns-44"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,a.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,a.kt)("h4",{id:"inherited-from-45"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#removequestion"},"removeQuestion")),(0,a.kt)("h4",{id:"defined-in-60"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L60"},"types/election/unpublished.ts:60")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"checkvote"},"checkVote"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"checkVote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"vote"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"resultsType"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"voteType"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-22"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"vote")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote")))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"resultsType")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/modules#electionresultstype"},(0,a.kt)("inlineCode",{parentName:"a"},"ElectionResultsType")))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"voteType")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,a.kt)("h4",{id:"returns-45"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-61"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L104"},"types/election/budget.ts:104")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"from"},"from"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"from"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/BudgetElection"},(0,a.kt)("inlineCode",{parentName:"a"},"BudgetElection"))),(0,a.kt)("p",null,"Returns an unpublished election object"),(0,a.kt)("h4",{id:"parameters-23"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/sdk/reference/modules#ibudgetelectionparameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParameters"))),(0,a.kt)("td",{parentName:"tr",align:"left"},"Unpublished Election parameters")))),(0,a.kt)("h4",{id:"returns-46"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/BudgetElection"},(0,a.kt)("inlineCode",{parentName:"a"},"BudgetElection"))),(0,a.kt)("h4",{id:"overrides-5"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},"UnpublishedElection"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection#from"},"from")),(0,a.kt)("h4",{id:"defined-in-62"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L45"},"types/election/budget.ts:45")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c87cc133.ab69b0c6.js b/assets/js/c87cc133.ab69b0c6.js new file mode 100644 index 000000000..9fa6f3768 --- /dev/null +++ b/assets/js/c87cc133.ab69b0c6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4674],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var o=r.createContext({}),p=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(o.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=p(n),k=a,m=c["".concat(o,".").concat(k)]||c[k]||u[k]||i;return n?r.createElement(m,l(l({ref:t},d),{},{components:n})):r.createElement(m,l({ref:t},d))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=c;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s.mdxType="string"==typeof e?e:a,l[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const i={},l=void 0,s={unversionedId:"sdk/reference/classes/Census3ServiceAPI",id:"sdk/reference/classes/Census3ServiceAPI",title:"Census3ServiceAPI",description:"@vocdoni/sdk / Exports / Census3ServiceAPI",source:"@site/docs/sdk/reference/classes/Census3ServiceAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Census3ServiceAPI",permalink:"/sdk/reference/classes/Census3ServiceAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Census3CensusAPI",permalink:"/sdk/reference/classes/Census3CensusAPI"},next:{title:"Census3StrategyAPI",permalink:"/sdk/reference/classes/Census3StrategyAPI"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"info",id:"info",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"serializePagination",id:"serializepagination",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4}],d={toc:p};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / Census3ServiceAPI"),(0,a.kt)("h1",{id:"class-census3serviceapi"},"Class: Census3ServiceAPI"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"Census3API")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Census3ServiceAPI"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Census3ServiceAPI#constructor"},"constructor"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Census3ServiceAPI#info"},"info")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Census3ServiceAPI#isapierror"},"isApiError")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Census3ServiceAPI#isundefinederror"},"isUndefinedError")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Census3ServiceAPI#serializepagination"},"serializePagination"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new Census3ServiceAPI"),"(): ",(0,a.kt)("a",{parentName:"p",href:"Census3ServiceAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"Census3ServiceAPI"))),(0,a.kt)("p",null,"Cannot be constructed."),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"Census3ServiceAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"Census3ServiceAPI"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"Census3API.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/service.ts#L36"},"api/census3/service.ts:36")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"info"},"info"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"info"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"../interfaces/ICensus3ServiceInfoResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"ICensus3ServiceInfoResponse")),">"),(0,a.kt)("p",null,"Fetches supported chains from the service"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"url")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"../interfaces/ICensus3ServiceInfoResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"ICensus3ServiceInfoResponse")),">"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/service.ts#L46"},"api/census3/service.ts:46")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isapierror"},"isApiError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Census3API.isApiError"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/api.ts#L101"},"api/census3/api.ts:101")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Census3API.isUndefinedError"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L64"},"api/api.ts:64")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"serializepagination"},"serializePagination"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"serializePagination"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"pagination?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"pagination?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Census3Pagination"))))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"Census3API.serializePagination"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/api.ts#L92"},"api/census3/api.ts:92")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c87cc133.e2de03bf.js b/assets/js/c87cc133.e2de03bf.js deleted file mode 100644 index 3b9c59721..000000000 --- a/assets/js/c87cc133.e2de03bf.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4674],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>k});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var o=r.createContext({}),d=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=d(e.components);return r.createElement(o.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),c=d(n),k=a,m=c["".concat(o,".").concat(k)]||c[k]||u[k]||i;return n?r.createElement(m,s(s({ref:t},p),{},{components:n})):r.createElement(m,s({ref:t},p))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,s=new Array(i);s[0]=c;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l.mdxType="string"==typeof e?e:a,s[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var r=n(87462),a=(n(67294),n(3905));const i={},s=void 0,l={unversionedId:"sdk/reference/classes/Census3ServiceAPI",id:"sdk/reference/classes/Census3ServiceAPI",title:"Census3ServiceAPI",description:"@vocdoni/sdk / Exports / Census3ServiceAPI",source:"@site/docs/sdk/reference/classes/Census3ServiceAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Census3ServiceAPI",permalink:"/sdk/reference/classes/Census3ServiceAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Census3CensusAPI",permalink:"/sdk/reference/classes/Census3CensusAPI"},next:{title:"Census3StrategyAPI",permalink:"/sdk/reference/classes/Census3StrategyAPI"}},o={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"info",id:"info",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"serializePagination",id:"serializepagination",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4}],p={toc:d};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / Census3ServiceAPI"),(0,a.kt)("h1",{id:"class-census3serviceapi"},"Class: Census3ServiceAPI"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"Census3API")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Census3ServiceAPI"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3ServiceAPI#constructor"},"constructor"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3ServiceAPI#info"},"info")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3ServiceAPI#isapierror"},"isApiError")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3ServiceAPI#isundefinederror"},"isUndefinedError")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3ServiceAPI#serializepagination"},"serializePagination"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new Census3ServiceAPI"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census3ServiceAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"Census3ServiceAPI"))),(0,a.kt)("p",null,"Cannot be constructed."),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census3ServiceAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"Census3ServiceAPI"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"Census3API.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/service.ts#L36"},"api/census3/service.ts:36")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"info"},"info"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"info"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3ServiceInfoResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"ICensus3ServiceInfoResponse")),">"),(0,a.kt)("p",null,"Fetches supported chains from the service"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"url")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3ServiceInfoResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"ICensus3ServiceInfoResponse")),">"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/service.ts#L46"},"api/census3/service.ts:46")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isapierror"},"isApiError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Census3API.isApiError"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/api.ts#L101"},"api/census3/api.ts:101")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Census3API.isUndefinedError"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L64"},"api/api.ts:64")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"serializepagination"},"serializePagination"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"serializePagination"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"pagination?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"pagination?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Census3Pagination"))))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"Census3API.serializePagination"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/api.ts#L92"},"api/census3/api.ts:92")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/caece487.76274fc9.js b/assets/js/caece487.07bd490a.js similarity index 57% rename from assets/js/caece487.76274fc9.js rename to assets/js/caece487.07bd490a.js index 3eafd2acd..5f1fc1b5e 100644 --- a/assets/js/caece487.76274fc9.js +++ b/assets/js/caece487.07bd490a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8161],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var c=r.createContext({}),l=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=l(e.components);return r.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),f=l(n),u=a,k=f["".concat(c,".").concat(u)]||f[u]||d[u]||i;return n?r.createElement(k,o(o({ref:t},p),{},{components:n})):r.createElement(k,o({ref:t},p))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=f;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=n(87462),a=(n(67294),n(3905));const i={},o=void 0,s={unversionedId:"sdk/reference/interfaces/SetTransactionCostsTx",id:"sdk/reference/interfaces/SetTransactionCostsTx",title:"SetTransactionCostsTx",description:"@vocdoni/sdk / Exports / SetTransactionCostsTx",source:"@site/docs/sdk/reference/interfaces/SetTransactionCostsTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/SetTransactionCostsTx",permalink:"/sdk/reference/interfaces/SetTransactionCostsTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"SetProcessTx",permalink:"/sdk/reference/interfaces/SetProcessTx"},next:{title:"Tx",permalink:"/sdk/reference/interfaces/Tx"}},c={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"txtype",id:"txtype",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"value",id:"value",level:3},{value:"Defined in",id:"defined-in-2",level:4}],p={toc:l};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / SetTransactionCostsTx"),(0,a.kt)("h1",{id:"interface-settransactioncoststx"},"Interface: SetTransactionCostsTx"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetTransactionCostsTx#nonce"},"nonce")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetTransactionCostsTx#txtype"},"txtype")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/SetTransactionCostsTx#value"},"value"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"nonce"},"nonce"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"nonce"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L143"},"api/chain/transactions.ts:143")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"txtype"},"txtype"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"txtype"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/TxType"},(0,a.kt)("inlineCode",{parentName:"a"},"TxType"))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L142"},"api/chain/transactions.ts:142")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"value"},"value"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"value"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L144"},"api/chain/transactions.ts:144")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8161],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>f});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var c=r.createContext({}),l=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=l(e.components);return r.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=l(n),f=a,k=u["".concat(c,".").concat(f)]||u[f]||d[f]||i;return n?r.createElement(k,o(o({ref:t},p),{},{components:n})):r.createElement(k,o({ref:t},p))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=u;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=n(87462),a=(n(67294),n(3905));const i={},o=void 0,s={unversionedId:"sdk/reference/interfaces/SetTransactionCostsTx",id:"sdk/reference/interfaces/SetTransactionCostsTx",title:"SetTransactionCostsTx",description:"@vocdoni/sdk / Exports / SetTransactionCostsTx",source:"@site/docs/sdk/reference/interfaces/SetTransactionCostsTx.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/SetTransactionCostsTx",permalink:"/sdk/reference/interfaces/SetTransactionCostsTx",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"SetProcessTx",permalink:"/sdk/reference/interfaces/SetProcessTx"},next:{title:"Tx",permalink:"/sdk/reference/interfaces/Tx"}},c={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"nonce",id:"nonce",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"txtype",id:"txtype",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"value",id:"value",level:3},{value:"Defined in",id:"defined-in-2",level:4}],p={toc:l};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / SetTransactionCostsTx"),(0,a.kt)("h1",{id:"interface-settransactioncoststx"},"Interface: SetTransactionCostsTx"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"SetTransactionCostsTx#nonce"},"nonce")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"SetTransactionCostsTx#txtype"},"txtype")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"SetTransactionCostsTx#value"},"value"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"nonce"},"nonce"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"nonce"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L143"},"api/chain/transactions.ts:143")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"txtype"},"txtype"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"txtype"),": ",(0,a.kt)("a",{parentName:"p",href:"../enums/TxType"},(0,a.kt)("inlineCode",{parentName:"a"},"TxType"))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L142"},"api/chain/transactions.ts:142")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"value"},"value"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"value"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L144"},"api/chain/transactions.ts:144")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/cce83bc5.1f1ecb27.js b/assets/js/cce83bc5.1f1ecb27.js new file mode 100644 index 000000000..9fdd4622e --- /dev/null +++ b/assets/js/cce83bc5.1f1ecb27.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6686],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var i=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=i.createContext({}),p=function(e){var t=i.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=p(e.components);return i.createElement(d.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},u=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,d=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),u=p(n),f=a,m=u["".concat(d,".").concat(f)]||u[f]||s[f]||r;return n?i.createElement(m,l(l({ref:t},c),{},{components:n})):i.createElement(m,l({ref:t},c))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,l=new Array(r);l[0]=u;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>s,frontMatter:()=>r,metadata:()=>o,toc:()=>p});var i=n(87462),a=(n(67294),n(3905));const r={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IElectionSummary",id:"sdk/reference/interfaces/IElectionSummary",title:"IElectionSummary",description:"@vocdoni/sdk / Exports / IElectionSummary",source:"@site/docs/sdk/reference/interfaces/IElectionSummary.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionSummary",permalink:"/sdk/reference/interfaces/IElectionSummary",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionParameters",permalink:"/sdk/reference/interfaces/IElectionParameters"},next:{title:"IElectionType",permalink:"/sdk/reference/interfaces/IElectionType"}},d={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"electionId",id:"electionid",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"endDate",id:"enddate",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"finalResults",id:"finalresults",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"organizationId",id:"organizationid",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"startDate",id:"startdate",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"voteCount",id:"votecount",level:3},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:p};function s(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IElectionSummary"),(0,a.kt)("h1",{id:"interface-ielectionsummary"},"Interface: IElectionSummary"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionSummary#electionid"},"electionId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionSummary#enddate"},"endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionSummary#finalresults"},"finalResults")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionSummary#organizationid"},"organizationId")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionSummary#startdate"},"startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionSummary#status"},"status")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionSummary#votecount"},"voteCount"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"electionid"},"electionId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"electionId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The id of the election"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L322"},"api/election.ts:322")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enddate"},"endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"endDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The end date of the election"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L342"},"api/election.ts:342")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"finalresults"},"finalResults"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"finalResults"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"If the election has the final results"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L352"},"api/election.ts:352")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"organizationid"},"organizationId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"organizationId"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The id of the organization"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L327"},"api/election.ts:327")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"startdate"},"startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"startDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The start date of the election"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L337"},"api/election.ts:337")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"status"},"status"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"status"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#process_unknown"},(0,a.kt)("inlineCode",{parentName:"a"},"PROCESS_UNKNOWN"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#ended"},(0,a.kt)("inlineCode",{parentName:"a"},"ENDED"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#canceled"},(0,a.kt)("inlineCode",{parentName:"a"},"CANCELED"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#paused"},(0,a.kt)("inlineCode",{parentName:"a"},"PAUSED"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#results"},(0,a.kt)("inlineCode",{parentName:"a"},"RESULTS"))," ","|"," ",(0,a.kt)("a",{parentName:"p",href:"../enums/ElectionStatusReady#ready"},(0,a.kt)("inlineCode",{parentName:"a"},"READY"))),(0,a.kt)("p",null,"The status of the election"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L332"},"api/election.ts:332")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votecount"},"voteCount"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"voteCount"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of votes of the election"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L347"},"api/election.ts:347")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/cce83bc5.d422dce9.js b/assets/js/cce83bc5.d422dce9.js deleted file mode 100644 index 1a0a2ff59..000000000 --- a/assets/js/cce83bc5.d422dce9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6686],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=r.createContext({}),d=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=d(e.components);return r.createElement(c.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,c=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),u=d(n),f=i,k=u["".concat(c,".").concat(f)]||u[f]||p[f]||a;return n?r.createElement(k,l(l({ref:t},s),{},{components:n})):r.createElement(k,l({ref:t},s))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=u;var o={};for(var c in t)hasOwnProperty.call(t,c)&&(o[c]=t[c]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var d=2;d{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IElectionSummary",id:"sdk/reference/interfaces/IElectionSummary",title:"IElectionSummary",description:"@vocdoni/sdk / Exports / IElectionSummary",source:"@site/docs/sdk/reference/interfaces/IElectionSummary.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionSummary",permalink:"/sdk/reference/interfaces/IElectionSummary",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionParameters",permalink:"/sdk/reference/interfaces/IElectionParameters"},next:{title:"IElectionType",permalink:"/sdk/reference/interfaces/IElectionType"}},c={},d=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"electionId",id:"electionid",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"endDate",id:"enddate",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"finalResults",id:"finalresults",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"organizationId",id:"organizationid",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"startDate",id:"startdate",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"voteCount",id:"votecount",level:3},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:d};function p(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IElectionSummary"),(0,i.kt)("h1",{id:"interface-ielectionsummary"},"Interface: IElectionSummary"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionSummary#electionid"},"electionId")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionSummary#enddate"},"endDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionSummary#finalresults"},"finalResults")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionSummary#organizationid"},"organizationId")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionSummary#startdate"},"startDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionSummary#status"},"status")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionSummary#votecount"},"voteCount"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"electionid"},"electionId"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"electionId"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The id of the election"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L322"},"api/election.ts:322")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enddate"},"endDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"endDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The end date of the election"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L342"},"api/election.ts:342")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"finalresults"},"finalResults"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"finalResults"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"If the election has the final results"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L352"},"api/election.ts:352")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"organizationid"},"organizationId"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"organizationId"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The id of the organization"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L327"},"api/election.ts:327")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"startdate"},"startDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"startDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The start date of the election"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L337"},"api/election.ts:337")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#process_unknown"},(0,i.kt)("inlineCode",{parentName:"a"},"PROCESS_UNKNOWN"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#ended"},(0,i.kt)("inlineCode",{parentName:"a"},"ENDED"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#canceled"},(0,i.kt)("inlineCode",{parentName:"a"},"CANCELED"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#paused"},(0,i.kt)("inlineCode",{parentName:"a"},"PAUSED"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus#results"},(0,i.kt)("inlineCode",{parentName:"a"},"RESULTS"))," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatusReady#ready"},(0,i.kt)("inlineCode",{parentName:"a"},"READY"))),(0,i.kt)("p",null,"The status of the election"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L332"},"api/election.ts:332")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votecount"},"voteCount"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"voteCount"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The number of votes of the election"),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L347"},"api/election.ts:347")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d077d113.163f8b8e.js b/assets/js/d077d113.163f8b8e.js deleted file mode 100644 index d053df991..000000000 --- a/assets/js/d077d113.163f8b8e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9436],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>d});var o=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function r(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=o.createContext({}),c=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},p=function(e){var t=c(e.components);return o.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},m=o.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),m=c(n),d=i,h=m["".concat(l,".").concat(d)]||m[d]||u[d]||a;return n?o.createElement(h,r(r({ref:t},p),{},{components:n})):o.createElement(h,r({ref:t},p))}));function d(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,r=new Array(a);r[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:i,r[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var o=n(87462),i=(n(67294),n(3905));const a={slug:"single-choice",sidebar_position:2},r="Single Choice Voting",s={unversionedId:"sdk/voting-types/single-choice",id:"sdk/voting-types/single-choice",title:"Single Choice Voting",description:"An election with a single-choice result, also known as First-past-the-post voting (FPTP or FPP) or informally called",source:"@site/docs/sdk/voting-types/single-choice.md",sourceDirName:"sdk/voting-types",slug:"/sdk/voting-types/single-choice",permalink:"/sdk/voting-types/single-choice",draft:!1,tags:[],version:"current",sidebarPosition:2,frontMatter:{slug:"single-choice",sidebar_position:2},sidebar:"defaultSidebar",previous:{title:"Voting Types",permalink:"/sdk/voting-types/"},next:{title:"Ranked Voting",permalink:"/sdk/voting-types/ranked"}},l={},c=[{value:"Setting up the election",id:"setting-up-the-election",level:2},{value:"Casting a vote",id:"casting-a-vote",level:2},{value:"Results interpretation",id:"results-interpretation",level:2}],p={toc:c};function u(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,o.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"single-choice-voting"},"Single Choice Voting"),(0,i.kt)("p",null,"An election with a single-choice result, also known as First-past-the-post voting (FPTP or FPP) or informally called\nchoose-one voting, is a voting system where each voter is typically allowed to cast only one vote for their preferred\noption or candidate. The option or candidate with the most votes wins the election."),(0,i.kt)("p",null,'This voting system is considered one of the simplest, as a single-choice election involves selecting a single winner,\nand voters can mark only one option from the list of choices or candidates. However, despite its widespread use and\nsimplicity, it has some drawbacks. Since it operates on a "winner-take-all" principle, it can lead to disproportionate\noutcomes (the candidate/option with the most votes secures victory, even if their margin of victory is slim).'),(0,i.kt)("admonition",{type:"info"},(0,i.kt)("p",{parentName:"admonition"},"This voting system supports ",(0,i.kt)("strong",{parentName:"p"},"one")," or ",(0,i.kt)("strong",{parentName:"p"},"multiple questions"),".")),(0,i.kt)("p",null,"See:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/protocol/ballot-protocol#single-choice"},"Ballot protocol implementation"))),(0,i.kt)("h2",{id:"setting-up-the-election"},"Setting up the election"),(0,i.kt)("p",null,"To establish this kind of election, you can utilize the default parameters:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"const election = Election.from({\n census,\n title: 'Do you like chocolate?',\n description: 'A simple survey to assess chocolate preferences',\n})\n")),(0,i.kt)("p",null,"After creating the election and before publishing, add the questions, ensuring each choice has a distinct value:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"election.addQuestion('Do you like chocolate without milk?', 'This is the description', [\n {\n title: 'Yes',\n value: 0,\n },\n {\n title: 'No',\n value: 1,\n },\n]).addQuestion('Do you like chocolate with milk', 'This is the description', [\n {\n title: 'Yes',\n value: 0,\n },\n {\n title: 'No',\n value: 1,\n },\n {\n title: 'Not always',\n value: 2,\n },\n])\n")),(0,i.kt)("admonition",{title:"About choices values",type:"info"},(0,i.kt)("p",{parentName:"admonition"},"Take note that the question values are ",(0,i.kt)("strong",{parentName:"p"},"incremental")," and the initial value ",(0,i.kt)("strong",{parentName:"p"},"must")," be 0")),(0,i.kt)("admonition",{title:"Multiple questions support",type:"tip"},(0,i.kt)("p",{parentName:"admonition"},"This election type can accommodate multiple questions.")),(0,i.kt)("admonition",{title:"Not all elections type supports multiple questions!",type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"This is the sole type of election that supports multiple questions. Other election types, such as ",(0,i.kt)("inlineCode",{parentName:"p"},"ranked"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"quadratic"),",\netc, ",(0,i.kt)("strong",{parentName:"p"},"only support one question per election"),".")),(0,i.kt)("p",null,"To restrict the maximum number of questions or values an election can contain, adjust the ",(0,i.kt)("inlineCode",{parentName:"p"},"maxCount")," and\n",(0,i.kt)("inlineCode",{parentName:"p"},"maxValue")," parameters in ",(0,i.kt)("inlineCode",{parentName:"p"},"voteOpts"),":"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"const election_opts: IVoteType = {\n maxCount: 2, // Represents the max number of questions\n maxValue: 3, // Represents the max number of choices for a given question.\n}\nconst election = Election.from({\n census,\n election_opts,\n //...\n})\n")),(0,i.kt)("h2",{id:"casting-a-vote"},"Casting a vote"),(0,i.kt)("p",null,"Votes can be submitted using the method below:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"client.submitVote(new Vote([0, 2]));\n")),(0,i.kt)("p",null,"Each position in the vote array corresponds to a question, and the value is the associated selected choice. In this\ninstance, we select the first choice for the first question and the third choice for the second."),(0,i.kt)("admonition",{title:"Single question vote",type:"info"},(0,i.kt)("p",{parentName:"admonition"},"For single question is same philosophy, you could configure the election as:"),(0,i.kt)("pre",{parentName:"admonition"},(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"// If you want to restrict the election creation\n// ...\n maxCount: 1, // Only one question\n maxValue: 3, // That accepts three choices\n// ...\n// And finally casting the vote\nclient.submitVote(new Vote([0, 2])); // Voting the third option\n"))),(0,i.kt)("h2",{id:"results-interpretation"},"Results interpretation"),(0,i.kt)("p",null,"Consider a scenario where 10 voters cast identical votes, i.e., ",(0,i.kt)("inlineCode",{parentName:"p"},"[0, 2]"),"."),(0,i.kt)("p",null,"The election results would be represented as a two-dimensional array:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre"}," [\n [ '10', '0', '0' ],\n [ '0', '0', '10' ]\n ]\n")),(0,i.kt)("p",null,"Each sub-array signifies the results for a question, and each position of the sub-array indicates the number of votes a\nchoice has accumulated."),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"For the first question (",(0,i.kt)("inlineCode",{parentName:"li"},"[ '10', '0', '0' ]"),"): all 10 voters chose the first option."),(0,i.kt)("li",{parentName:"ul"},"For the second question (",(0,i.kt)("inlineCode",{parentName:"li"},"[ '0', '0', '10' ]"),"): all 10 voters chose the third option.")),(0,i.kt)("p",null,"In the example above, the first question offers two options, and the second presents three. However, the results array\nfor the first question contains three elements, as the ",(0,i.kt)("inlineCode",{parentName:"p"},"maxValue")," for all questions is the same (in this case, 3, the\n",(0,i.kt)("inlineCode",{parentName:"p"},"maxValue")," of the question with the most options)."),(0,i.kt)("admonition",{title:"Single question results interpretation",type:"info"},(0,i.kt)("p",{parentName:"admonition"},"Not so different, the results array will look like:"),(0,i.kt)("pre",{parentName:"admonition"},(0,i.kt)("code",{parentName:"pre"},"[ [ '0', '0', '10' ] ]\n")),(0,i.kt)("p",{parentName:"admonition"},"For the only one question, 10 voters select the third option")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d234883f.3b2f7b62.js b/assets/js/d234883f.3b2f7b62.js deleted file mode 100644 index 64ff35182..000000000 --- a/assets/js/d234883f.3b2f7b62.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8277],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>c});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=a.createContext({}),p=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},m=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),u=p(n),c=r,h=u["".concat(s,".").concat(c)]||u[c]||k[c]||i;return n?a.createElement(h,o(o({ref:t},m),{},{components:n})):a.createElement(h,o({ref:t},m))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,o=new Array(i);o[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:r,o[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>k,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var a=n(87462),r=(n(67294),n(3905));const i={},o="Off-Chain Tree ZK Census Proof",l={unversionedId:"protocol/anonymity/zk-census-proof",id:"protocol/anonymity/zk-census-proof",title:"Off-Chain Tree ZK Census Proof",description:"This document is divided in two sections:",source:"@site/docs/protocol/anonymity/zk-census-proof.md",sourceDirName:"protocol/anonymity",slug:"/protocol/anonymity/zk-census-proof",permalink:"/protocol/anonymity/zk-census-proof",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"On-Chain Pseudo-Anonymity",permalink:"/protocol/anonymity/on-chain"},next:{title:"Ballot Protocol",permalink:"/protocol/ballot-protocol"}},s={},p=[{value:"Protocol design",id:"protocol-design",level:2},{value:"zkSNARKs for anonymous voters",id:"zksnarks-for-anonymous-voters",level:3},{value:"zkSNARK circuit",id:"zksnark-circuit",level:3},{value:"Proof generation",id:"proof-generation",level:4},{value:"Implementation spec",id:"implementation-spec",level:2},{value:"Flow",id:"flow",level:3},{value:"Steps description",id:"steps-description",level:4},{value:"Flow for csv voting",id:"flow-for-csv-voting",level:4},{value:"Flow for Ethereum Storage Proof voting",id:"flow-for-ethereum-storage-proof-voting",level:4},{value:"Merkle Tree",id:"merkle-tree",level:3},{value:"zkInputs generation",id:"zkinputs-generation",level:3},{value:"Circuit identification",id:"circuit-identification",level:3},{value:"Examples of flags combinations",id:"examples-of-flags-combinations",level:4},{value:"KeyKeepers reveal and commit keys",id:"keykeepers-reveal-and-commit-keys",level:4}],m={toc:p};function k(e){let{components:t,...i}=e;return(0,r.kt)("wrapper",(0,a.Z)({},m,i,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"off-chain-tree-zk-census-proof"},"Off-Chain Tree ZK Census Proof"),(0,r.kt)("p",null,"This document is divided in two sections:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},(0,r.kt)("a",{parentName:"strong",href:"#protocol-design"},"Protocol design")),": high level overview of the protocol."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},(0,r.kt)("a",{parentName:"strong",href:"#implementation-spec"},"Implementation spec")),": detailed specification, featuring the relevant data structures, hash functions, etc.")),(0,r.kt)("h2",{id:"protocol-design"},"Protocol design"),(0,r.kt)("p",null,"The census proof (also called franchise proof) enables user privacy and allows for fully anonymous voting."),(0,r.kt)("p",null,"The starting point is a ",(0,r.kt)("a",{parentName:"p",href:"/protocol/census/off-chain-tree"},"Merkle Proof"),", which efficiently proves that a voter's ",(0,r.kt)("em",{parentName:"p"},"zkCensusKey")," belongs to a Merkle Tree (census). However, using this proof alone would allow the organizer of a process to correlate each vote envelope with its voter's the ",(0,r.kt)("em",{parentName:"p"},"zkCensusKey")," on the database, so votes wouldn't be secret."),(0,r.kt)("p",null,"To this end, Vocdoni achieves voting anonymity by the use of ZK-Snarks."),(0,r.kt)("h3",{id:"zksnarks-for-anonymous-voters"},"zkSNARKs for anonymous voters"),(0,r.kt)("p",null,"Snark stands for ",(0,r.kt)("em",{parentName:"p"},"Succinct non-interactive argument of knowledge"),". In our case, this means proving to someone that we know something, but without revealing the contents of what we know."),(0,r.kt)("p",null,"In our case:"),(0,r.kt)("ol",null,(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("inlineCode",{parentName:"li"},"Voter")," is the owner of the ",(0,r.kt)("inlineCode",{parentName:"li"},"secret key")," corresponding to a certain ",(0,r.kt)("inlineCode",{parentName:"li"},"zkCensusKey")),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("inlineCode",{parentName:"li"},"Voter"),"'s ",(0,r.kt)("inlineCode",{parentName:"li"},"zkCensusKey")," is included in the ",(0,r.kt)("inlineCode",{parentName:"li"},"census")," Merkle Tree"),(0,r.kt)("li",{parentName:"ol"},"The nullifier provided by ",(0,r.kt)("inlineCode",{parentName:"li"},"Voter")," uniquely corresponds to their ",(0,r.kt)("inlineCode",{parentName:"li"},"secret key")," and the ",(0,r.kt)("inlineCode",{parentName:"li"},"process ID")," for a specific voting process")),(0,r.kt)("p",null,"Although the computation is CPU and memory intensive, ZK Proofs can be generated from the user client running on modest hardware. The proof is validated by the Vochain Nodes, Miners, and any Third Party monitoring the process."),(0,r.kt)("h3",{id:"zksnark-circuit"},"zkSNARK circuit"),(0,r.kt)("p",null,"Voters use the proving key generated for the circuit below to generate a ZK Proof. The circuit receives both private and public inputs."),(0,r.kt)("p",null,"Data that could reveal the identity of the voter are kept private (gray boxes in the diagram). Public inputs are submitted within the Vote Envelope, so that validators can check them against the proof and make sure that the user hasn't voted twice."),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"The same circuit can be used for any ",(0,r.kt)("inlineCode",{parentName:"li"},"process")," with a census size of the same range (10k, 100k, 1M, etc)."),(0,r.kt)("li",{parentName:"ul"},"It relies on a ",(0,r.kt)("a",{parentName:"li",href:"https://medium.com/qed-it/diving-into-the-snarks-setup-phase-b7660242a0d7"},(0,r.kt)("strong",{parentName:"a"},"trusted setup ceremony")))),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Circuit diagram",src:n(13942).Z,width:"863",height:"456"})),(0,r.kt)("p",null,"The circuit above verifies that:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"the prover is the owner of the secret key"),(0,r.kt)("li",{parentName:"ul"},"the ",(0,r.kt)("inlineCode",{parentName:"li"},"zkCensusKey")," of the secret key is inside a Hash, which is inside the Merkle Tree with the CensusRoot (",(0,r.kt)("inlineCode",{parentName:"li"},"key=Poseidon(secretKey), value=0"),")"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"H(secretKey, processID) == nullifier"))),(0,r.kt)("h4",{id:"proof-generation"},"Proof generation"),(0,r.kt)("p",null,"The franchise proof is generated by running the zkSNARK circuit."),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Private inputs:")," Index, Secret Key, Census Merkle-proof"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Public inputs:")," Census Merkle-root, Nullifier, ProcessId, Vote"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Output:")," Franchise proof")),(0,r.kt)("p",null,"Steps:"),(0,r.kt)("ol",null,(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Vote encryption"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"encrypted_vote = encrypt( selected_voting_options + random_nonce )")))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Nullifier generation"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"nullifier = hash( process_id + user_secret_key )")))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Fetch merkle proof"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"From any source that has the census merkle tree such as a Vocdoni Gateway or directly from IPFS.")))),(0,r.kt)("h2",{id:"implementation-spec"},"Implementation spec"),(0,r.kt)("h3",{id:"flow"},"Flow"),(0,r.kt)("p",null," ",(0,r.kt)("em",{parentName:"p"},"The following flow describes the "),"csv census",(0,r.kt)("em",{parentName:"p"}," flow.")),(0,r.kt)("mermaid",{value:"%%{init: {'theme':'forest'}}%%\n\nsequenceDiagram\nopt Steps 1-2 depend on the kind of census being used (csv, EthStorageProofs, ...)\n Organizer->>Vochain: 1. create new voting process (newProcessTx) & define the CensusOrigin\n User->>User: 2. generate CensusRegisterProof\nend\n\nUser->>User: 3. generate zkCensusKey\nUser->>Vochain: 4. register zkCensusKey using CensusRegisterProof that matches the CensusOrigin\nVochain->>Vochain: 5. build voting census merkle tree (in state)\nVochain->>Vochain: 6. startBlock is reached, process starts\nVochain->>Vochain: 7. last merkle tree root becomes censusRoot\nVochain->>User: 8.get MerkleProof\n# note, next line goes from User->User instead of User->IPFS to avoid spending a full column just for 1 query to IPFS\nUser->>User: 9. get ProvingKey & WitnessCalc (from IPFS GW)\nUser->>User: 10. generate zkInputs\nUser->>User: 11. generate zkSNARK proof\nUser->>Vochain: 12. cast the vote with zkSNARK proof\nVochain->>Vochain: 13. verify zkSNARK proof, accept the vote"}),(0,r.kt)("h4",{id:"steps-description"},"Steps description"),(0,r.kt)("p",null,"::: tip"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"[O]")," = Organizer"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"[U]")," = User"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"[V]")," = Vochain"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"[G]")," = Gateway\n:::")),(0,r.kt)("ol",{start:0},(0,r.kt)("li",{parentName:"ol"},"Circom ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/zk-franchise-proof-circuit"},"circuit")," is compiled & ",(0,r.kt)("strong",{parentName:"li"},"Trusted Setup")," generated"),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[O+V]")," Create new voting process (newProcessTx) & define the ",(0,r.kt)("strong",{parentName:"li"},"CensusOrigin"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"The ",(0,r.kt)("strong",{parentName:"li"},"CensusOrigin")," could be for example:\t",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Using ",(0,r.kt)("strong",{parentName:"li"},"csv file"),": Generate MerkleTree from a ",(0,r.kt)("inlineCode",{parentName:"li"},"csv")," data file, where the ",(0,r.kt)("strong",{parentName:"li"},"CensusOrigin")," determines the verification of the MerkleProof of that MerkleTree (check the ",(0,r.kt)("a",{parentName:"li",href:"#flow-for-csv-voting"},"csv voting section")," for more details)"),(0,r.kt)("li",{parentName:"ul"},"Using ",(0,r.kt)("strong",{parentName:"li"},"Ethereum storage proofs"),": The MerkleTree is the root of the EthereumTree at a certain block, and the ",(0,r.kt)("strong",{parentName:"li"},"CensusOrigin")," determines the verification of the MerkleProof of that Ethereum MerkleTree (check ",(0,r.kt)("a",{parentName:"li",href:"#flow-for-ethereum-storage-proof-voting"},"ethereum storage proof section")," for more details)"))))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," Generate CensusRegisterProof, more details:",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"#flow-for-csv-voting"},"flow for csv voting")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"#flow-for-ethereum-storage-proof-voting"},"flow for ethereum storage proof voting")))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," Generate ",(0,r.kt)("strong",{parentName:"li"},"zkCensusKey")," (used as leaf key)",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"User's ",(0,r.kt)("em",{parentName:"li"},"zkCensusKey"),": ",(0,r.kt)("inlineCode",{parentName:"li"},"zkCensusKey = Hash(userSecret)")),(0,r.kt)("li",{parentName:"ul"},"This is the key that will be added into the ",(0,r.kt)("em",{parentName:"li"},"CensusTree")))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U+V]")," ",(0,r.kt)("strong",{parentName:"li"},"Register zkCensusKey")," using ",(0,r.kt)("strong",{parentName:"li"},"CensusRegisterProof")," (registerKeyTx)")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Vochain checks that the ",(0,r.kt)("strong",{parentName:"li"},"CensusRegistryProof")," can be validated for the ",(0,r.kt)("strong",{parentName:"li"},"CensusOrigin"))),(0,r.kt)("ol",{start:5},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[V]")," Build voting ",(0,r.kt)("strong",{parentName:"li"},"census merkle tree")," (in state)",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Where each leaf contains the hash of each user's ",(0,r.kt)("inlineCode",{parentName:"li"},"secretKey")," (",(0,r.kt)("em",{parentName:"li"},"zkCensusKey"),")"),(0,r.kt)("li",{parentName:"ul"},"MerkleTree type: circom compatible",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Hash function: ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/iden3/go-iden3-crypto/blob/master/poseidon/poseidon.go"},"Poseidon")),(0,r.kt)("li",{parentName:"ul"},"Tree ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/vocdoni-node/blob/master/censustree/arbotree/wrapper.go"},"Go impl")))))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[V]")," StartBlock is reached, ",(0,r.kt)("strong",{parentName:"li"},"process starts")),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[V]")," Last merkle tree root becomes ",(0,r.kt)("strong",{parentName:"li"},"censusRoot")),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[V+U]")," ",(0,r.kt)("strong",{parentName:"li"},"Get MerkleProof"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Vochain will send the ",(0,r.kt)("em",{parentName:"li"},"'compressed MerkleProof'")," (which are the siblings compressed)"),(0,r.kt)("li",{parentName:"ul"},"Client side will need to 'decompress' it",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"The logic to decompress the siblings ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/arbo/blob/master/tree.go#L606"},"can be found here")),(0,r.kt)("li",{parentName:"ul"},"And ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/arbo/blob/master/tree.go#L577"},"here")," the explaination of the encoding"))))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U+G]")," ",(0,r.kt)("strong",{parentName:"li"},"Get ProvingKey & WitnessCalc"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"Proving Key & Witness Calc")," depend on the circuit being used"))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," ",(0,r.kt)("strong",{parentName:"li"},"Generate zkInputs"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"check the ",(0,r.kt)("a",{parentName:"li",href:"#zkinputs-generation"},"zkInputs generation")," section for more details"))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," ",(0,r.kt)("strong",{parentName:"li"},"Generate zkSNARK proof"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"using: ",(0,r.kt)("em",{parentName:"li"},"zkInputs + Proving Key + Witness Calculator")))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," ",(0,r.kt)("strong",{parentName:"li"},"Cast the vote")," with zkSNARK proof",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"contains:",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"public inputs")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"zkProof")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"vote")))))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[V]")," ",(0,r.kt)("strong",{parentName:"li"},"Verify zkSNARK proof"),", accept the vote",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Needs to know:",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"ElectionID"),(0,r.kt)("li",{parentName:"ul"},"Verification Key (depends on the circuit being used (census size))"),(0,r.kt)("li",{parentName:"ul"},"User's ",(0,r.kt)("em",{parentName:"li"},"public inputs")," + ",(0,r.kt)("em",{parentName:"li"},"zkProof"))))))),(0,r.kt)("h4",{id:"flow-for-csv-voting"},"Flow for csv voting"),(0,r.kt)("p",null,"::: tip\n",(0,r.kt)("strong",{parentName:"p"},"Important"),": This scheme assumes fully trusting the ",(0,r.kt)("em",{parentName:"p"},"organization"),", as the\n",(0,r.kt)("em",{parentName:"p"},"organization")," could add non-real users to the census that later can be used\nto issue valid votes."),(0,r.kt)("p",null,"This use case would set the flag ",(0,r.kt)("inlineCode",{parentName:"p"},"preRegister=true")," and the ",(0,r.kt)("inlineCode",{parentName:"p"},"CensusOrigin")," would be ",(0,r.kt)("inlineCode",{parentName:"p"},"OFF_CHAIN_TREE")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"OFF_CHAIN_TREE_WEIGHTED"),".\n:::"),(0,r.kt)("mermaid",{value:"%%{init: {'theme':'forest'}}%%\n\nsequenceDiagram\nopt Steps 1-2 for the csv processes\n Organizer->>Organizer: 0.1. create user login keys\n Organizer->>Organizer: 0.2. build merkleTree with login keys\n Organizer->>Vochain: 1. create new voting process (newProcessTx) & define the CensusOrigin=OFF_CHAIN_TREE\n User->>User: 2. generate CensusRegisterProof of type csv-merkletree\nend\nUser->>User: 3. generate zkCensusKey\nUser->>Vochain: 4. register zkCensusKey using CensusRegisterProof (registerKeyTx)\nNote over Organizer,User: From here continues with the normal flow"}),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"0.1. ",(0,r.kt)("em",{parentName:"li"},"[O]")," Create user ",(0,r.kt)("strong",{parentName:"li"},"login keys"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"from csv data"))),(0,r.kt)("li",{parentName:"ul"},"0.2. ",(0,r.kt)("em",{parentName:"li"},"[O]")," Build ",(0,r.kt)("strong",{parentName:"li"},"MerkleTree")," with login keys"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("ol",{parentName:"li"},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[O+V]")," Create ",(0,r.kt)("strong",{parentName:"li"},"new voting process")," (newProcessTx) & define the ",(0,r.kt)("inlineCode",{parentName:"li"},"CensusOrigin=OFF_CHAIN_TREE"))),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"CensusOrigin")," determines the checks:",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"the given ",(0,r.kt)("em",{parentName:"li"},"MerkleProof")," matches with the defined ",(0,r.kt)("em",{parentName:"li"},"Census Root")))))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("ol",{parentName:"li",start:2},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," Generate ",(0,r.kt)("strong",{parentName:"li"},"CensusRegisterProof"))),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"which is the MerkleProof that the user 'login key' is in the tree "))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("ol",{parentName:"li",start:3},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," Generate ",(0,r.kt)("strong",{parentName:"li"},"zkCensusKey")," (used as leaf key)")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"User's ",(0,r.kt)("em",{parentName:"li"},"zkCensusKey"),": ",(0,r.kt)("inlineCode",{parentName:"li"},"zkCensusKey = Hash(userSecret)"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Here ",(0,r.kt)("inlineCode",{parentName:"li"},"userSecret")," can be ",(0,r.kt)("inlineCode",{parentName:"li"},"csv user's data + secret from user")),(0,r.kt)("li",{parentName:"ul"},"This is the key that will be added into the ",(0,r.kt)("em",{parentName:"li"},"CensusTree")))))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("ol",{parentName:"li",start:4},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U+V]")," ",(0,r.kt)("strong",{parentName:"li"},"Register zkCensusKey")," using ",(0,r.kt)("strong",{parentName:"li"},"CensusRegisterProof")," (registerKeyTx)")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Vochain checks that the ",(0,r.kt)("strong",{parentName:"li"},"CensusRegistryProof")," can be validated for the ",(0,r.kt)("strong",{parentName:"li"},"CensusOrigin"))))),(0,r.kt)("p",null,"::: tip\nThe organization could also directly register ",(0,r.kt)("em",{parentName:"p"},"Users'")," secret keys to the Vochain, avoiding the need for a registration phase. This option would use the ",(0,r.kt)("inlineCode",{parentName:"p"},"ProcessMode")," flags "),(0,r.kt)("p",null,"This use case would set the flag ",(0,r.kt)("inlineCode",{parentName:"p"},"preRegister=false")," and the ",(0,r.kt)("inlineCode",{parentName:"p"},"CensusOrigin")," would be ",(0,r.kt)("inlineCode",{parentName:"p"},"OFF_CHAIN_TREE")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"OFF_CHAIN_TREE_WEIGHTED")," with the ",(0,r.kt)("inlineCode",{parentName:"p"},"CensusRoot")," determined by the Organization.\n:::"),(0,r.kt)("h4",{id:"flow-for-ethereum-storage-proof-voting"},"Flow for Ethereum Storage Proof voting"),(0,r.kt)("mermaid",{value:"%%{init: {'theme':'forest'}}%%\n\nsequenceDiagram\nopt Steps 1-2 for the Ethereum Storage Proofs processes\n Organizer->>Vochain: 1.0. create new voting process (newProcessTx) & define the CensusOrigin=ERC20\n User->>User: 2. generate CensusRegisterProof of type EthStorageProof\nend\nUser->>User: 3. generate zkCensusKey\nUser->>Vochain: 4. register zkCensusKey using CensusRegisterProof (registerKeyTx)\nNote over Organizer,User: From here continues with the normal flow"}),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("ol",{parentName:"li"},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[O+V]")," Create ",(0,r.kt)("strong",{parentName:"li"},"new voting process")," (newProcessTx) & define the ",(0,r.kt)("inlineCode",{parentName:"li"},"CensusOrigin=ERC20")," (or one of the others available such as ",(0,r.kt)("inlineCode",{parentName:"li"},"ERC777"),", ",(0,r.kt)("inlineCode",{parentName:"li"},"MINI_ME"),", etc)")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"CensusOrigin: determines to check that:",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"the given ",(0,r.kt)("em",{parentName:"li"},"MerkleProof")," matches with the defined ",(0,r.kt)("em",{parentName:"li"},"Ethereum Root")),(0,r.kt)("li",{parentName:"ul"},"the sender of the ",(0,r.kt)("em",{parentName:"li"},"MerkleProof")," is the owner of that address (check eth-signature)"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"[O]")," Define the ",(0,r.kt)("em",{parentName:"li"},"EthTreeRoot")," for the ",(0,r.kt)("strong",{parentName:"li"},"CensusOrigin")))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("ol",{parentName:"li",start:2},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," Generate ",(0,r.kt)("strong",{parentName:"li"},"CensusRegisterProof"))),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"which is the EthereumStorageProof + an ethereum signature by the address of the EthereumStorageProof (to prove ownership of the proof)"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("ol",{parentName:"li",start:3},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," Generate ",(0,r.kt)("strong",{parentName:"li"},"zkCensusKey")," (used as leaf key)")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"User's ",(0,r.kt)("em",{parentName:"li"},"zkCensusKey"),": ",(0,r.kt)("inlineCode",{parentName:"li"},"zkCensusKey = Hash(userSecret)")),(0,r.kt)("li",{parentName:"ul"},"Here ",(0,r.kt)("inlineCode",{parentName:"li"},"userSecret")," can be the value of the signature of a public known constant made by the user's EthereumKey (where the output is only known by the user, as it is used as a 'secret key'). This is the approach that Hermez zkRollup uses to derive 'snark friendly' keys from Metamask's Ethereum Keys",(0,r.kt)("pre",{parentName:"li"},(0,r.kt)("code",{parentName:"pre"},"- This is the key that will be added into the *CensusTree*\n"))))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("ol",{parentName:"li",start:4},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U+V]")," ",(0,r.kt)("strong",{parentName:"li"},"Register zkCensusKey")," using ",(0,r.kt)("strong",{parentName:"li"},"CensusRegisterProof")," (registerKeyTx)")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Vochain checks that the ",(0,r.kt)("strong",{parentName:"li"},"CensusRegistryProof")," can be validated for the ",(0,r.kt)("strong",{parentName:"li"},"CensusOrigin"))))),(0,r.kt)("h3",{id:"merkle-tree"},"Merkle Tree"),(0,r.kt)("p",null,"The MerkleTree used for building the ",(0,r.kt)("em",{parentName:"p"},"anonymous census")," needs to be a zkSNARK-friendly implementation. As currently we are using ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/iden3/circom"},"Circom")," for the zkSNARK circuits, we need to be compatible with the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/iden3/circomlib/tree/master/circuits/smt"},"circomlib")," MerkleTree implementation. A specification of the MerkleTree ",(0,r.kt)("a",{parentName:"p",href:"https://docs.iden3.io/publications/pdfs/Merkle-Tree.pdf"},"can be found here"),"."),(0,r.kt)("p",null,"In the Vochain, we're using the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/arbo"},"arbo")," MerkleTree, which is a Go implementation compatible with the Circom spec."),(0,r.kt)("p",null,"The MerkleTree uses the ",(0,r.kt)("a",{parentName:"p",href:"https://eprint.iacr.org/2019/458.pdf"},"Poseidon")," hash, which is a 'snark-friendly' hash function that later on can be proved inside a circuit without requiring too many constraints."),(0,r.kt)("p",null,"The following diagram contains a visual representation of the data structure of the Leaves of the MerkleTree being used in the scheme of the zk-census-proof."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Poseidon merkle tree with zk census proof",src:n(64723).Z,width:"418",height:"326"})),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"index")," value is determined by the ",(0,r.kt)("em",{parentName:"p"},"CensusTree")," builder, which has an ",(0,r.kt)("inlineCode",{parentName:"p"},"index")," value for each ",(0,r.kt)("em",{parentName:"p"},"CensusTree"),". This value increments with the addition of each new leaf."),(0,r.kt)("p",null,"The ",(0,r.kt)("em",{parentName:"p"},"Leaves")," are structured in this way in order to use the MerkleTrees more efficiently, allowing more user keys to fit inside a smaller tree and therefore reducing the zk circuit size. This is because the value of any given leaf's ",(0,r.kt)("em",{parentName:"p"},"key")," determines that leaf's ",(0,r.kt)("em",{parentName:"p"},"position")," on the tree. If the leaf key were determined by the ",(0,r.kt)("inlineCode",{parentName:"p"},"zkCensusKey"),", rather than an incremental ",(0,r.kt)("inlineCode",{parentName:"p"},"index"),", each new leaf would have a significant chance of collision before filling all the available leaf spots for a given height. Trees would therefore be less balanced and require larger circuits for the same census size due to inefficient use of tree space. With the incremental index approach, on the other hand, all the leaf spots can be filled without a single collision. This produces much smaller circuits for the same number of users."),(0,r.kt)("h3",{id:"zkinputs-generation"},"zkInputs generation"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-json"},'// Example of zkInputs\n{\n "censusRoot": "51642541620950251760298704744678482162425252475654827255045491135352807540162",\n "censusSiblings": ["0","0","0","0"],\n "index": "30",\n "secretKey": "6190793965647866647574058687473278714480561351424348391693421151024369116465",\n "voteHash": ["100964581237483263846637432502620436451", "278307331411790712608582894981321409946"],\n "processId": ["115971795979716226347584900263213958763", "100167351390541057173626244722405453127"],\n "nullifier": "1938187656076799017313903315498318464349291455761501098436114043715056719301",\n}\n')),(0,r.kt)("p",null,"Origin of each zkInput parameter:\n::: tip\n",(0,r.kt)("em",{parentName:"p"},"all the parameters are ",(0,r.kt)("inlineCode",{parentName:"em"},"string")," or ",(0,r.kt)("inlineCode",{parentName:"em"},"[]string")," that represent ",(0,r.kt)("inlineCode",{parentName:"em"},"bigInt")," or ",(0,r.kt)("inlineCode",{parentName:"em"},"[]bigInt")),"\n:::"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"censusRoot"),": computed by the ",(0,r.kt)("em",{parentName:"li"},"CensusAuthority")," from the ",(0,r.kt)("em",{parentName:"li"},"Census Tree")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"censusSiblings"),": computed by the ",(0,r.kt)("em",{parentName:"li"},"CensusAuthority"),", is the ",(0,r.kt)("em",{parentName:"li"},"Merkle Proof"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"the ",(0,r.kt)("em",{parentName:"li"},"User")," retrieves the ",(0,r.kt)("em",{parentName:"li"},"siblings")," from the ",(0,r.kt)("em",{parentName:"li"},"Vochain")," through the ",(0,r.kt)("em",{parentName:"li"},"Gateway")),(0,r.kt)("li",{parentName:"ul"},"the length of ",(0,r.kt)("em",{parentName:"li"},"censusSiblings")," will depend on the ",(0,r.kt)("em",{parentName:"li"},"zkCircuit"),":",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"The design of the ",(0,r.kt)("em",{parentName:"li"},"MerkleTree")," used in circomlib provokes different lengths in the siblings returned when generating a ",(0,r.kt)("em",{parentName:"li"},"MerkleProof")))),(0,r.kt)("li",{parentName:"ul"},"This is due the design of the ",(0,r.kt)("em",{parentName:"li"},"MerkleTree")," defines a tree in which the deep of the tree (from the root to the leafs) will depend on each leaf and its neighbors. More details can be found in the ",(0,r.kt)("a",{parentName:"li",href:"https://docs.iden3.io/publications/pdfs/Merkle-Tree.pdf"},(0,r.kt)("em",{parentName:"a"},"MerkleTree")," spec"),".",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"In order to input those siblings into the circuit, the ",(0,r.kt)("inlineCode",{parentName:"li"},"nLevels")," of the circuit is fixed, so the length of ",(0,r.kt)("em",{parentName:"li"},"siblings")," needs to be fixed also."),(0,r.kt)("li",{parentName:"ul"},"So, the len(siblings) will depend on the ",(0,r.kt)("em",{parentName:"li"},"zkCircuit")," being used, specifically from the ",(0,r.kt)("inlineCode",{parentName:"li"},"nLevels")," parameter of the circuit"))))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"index"),": determined by the Vochain when adding the ",(0,r.kt)("em",{parentName:"li"},"User"),"'s ",(0,r.kt)("em",{parentName:"li"},"zkCensusKey")," into the ",(0,r.kt)("em",{parentName:"li"},"CensusTree")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"secretKey"),": generated by the ",(0,r.kt)("em",{parentName:"li"},"User")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"voteHash"),": hashed value of the ",(0,r.kt)("em",{parentName:"li"},"User")," vote, composed by two big integers.",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"The raw user vote is a variable-length array of values and its values do not need to be checked in the circuit. Furthermore, the values can be encrypted."),(0,r.kt)("li",{parentName:"ul"},"Since the encoded vote values may not fit into a constant number of circuit inputs, we calculate a summary of the raw user vote using an EVM-friendly hash function: ",(0,r.kt)("inlineCode",{parentName:"li"},"sha256(vote_bytes)"),". The output of the sha256 hash is slightly larger than the field used in SNARKS, so we split the hash output (32-bytes) into 2 16-byte arrays, take them as integers (in little-endian), and use them as circuit inputs.",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"sha256")," hash is used, as if necessary in the future it can be ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/iden3/circomlib/blob/master/circuits/sha256/sha256.circom"},"verified inside")," the circuit. This usage has two characteristics to keep in mind:",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"sha256")," is twice as expensive as ",(0,r.kt)("inlineCode",{parentName:"li"},"keccak256")," in terms of gas in EVM, but it is implemented in ",(0,r.kt)("inlineCode",{parentName:"li"},"circom"),", so it can be checked inside a circuit (keccak256 is also ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/keccak256-circom"},"implemented inside a circuit"),", but it takes too many constraints for the current use case)"),(0,r.kt)("li",{parentName:"ul"},"checking the ",(0,r.kt)("inlineCode",{parentName:"li"},"sha256")," inside a circom circuit is expensive in terms of number of constraints (in the current version of this spec, this is not checked inside the circuit)"))))),(0,r.kt)("li",{parentName:"ul"},"example:",(0,r.kt)("pre",{parentName:"li"},(0,r.kt)("code",{parentName:"pre",className:"language-go"},"h := sha256.Sum256(voteBytes) // voteBytes can be the votes array converted to bytes, or the encrypted votes\nb1 := new(big.Int).SetBytes(swapEndianness(h[:16])) // swap endianness, as golang big int package works in big-endian, and we use little-endian\nb2 := new(big.Int).SetBytes(swapEndianness(h[16:]))\n")),"And the json input of the ",(0,r.kt)("inlineCode",{parentName:"li"},"voteHash")," for the circuit would be: ",(0,r.kt)("inlineCode",{parentName:"li"},'"voteHash": [b1, b2]')))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"processId"),": the process ID in which the ",(0,r.kt)("em",{parentName:"li"},"User")," is participating. As the process ID is a 32 byte array, we use the same method used for the ",(0,r.kt)("inlineCode",{parentName:"li"},"voteHash"),": the 32 bytes of process ID are splitted by the half, and each one is represented as a big integer (little-endian).",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"example:")),(0,r.kt)("pre",{parentName:"li"},(0,r.kt)("code",{parentName:"pre",className:"language-go"}," processID0 := new(big.Int).SetBytes(swapEndianness(processIDBytes[:16])) // swap endianness, as golang big int package works in big-endian, and we use little-endian\n processID1 := new(big.Int).SetBytes(swapEndianness(processIDBytes[16:]))\n"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"nullifier"),": computed by ",(0,r.kt)("em",{parentName:"li"},"User"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"nullifier = poseidon.Hash(sk, processID[0], processID[1])"))))),(0,r.kt)("h3",{id:"circuit-identification"},"Circuit identification"),(0,r.kt)("p",null,"There will be different circuits of the ",(0,r.kt)("inlineCode",{parentName:"p"},"zk-census-proof")," depending on the census size, also there could be more use cases with different circuit designs.\nBoth the client and the Vochain need a way to univocally identify those circuits, in order to user the proper ",(0,r.kt)("inlineCode",{parentName:"p"},"Proving key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Witness calculator")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"Verification key")," for each circuit."),(0,r.kt)("p",null,"Circuits are identified across the stack by using a Protobuf enum type. Each ",(0,r.kt)("inlineCode",{parentName:"p"},"ProofZkSNARK")," protobuf package will have a ",(0,r.kt)("inlineCode",{parentName:"p"},"Type")," identifier indicating which circuit the proof belongs to, so the Vochain knows which ",(0,r.kt)("inlineCode",{parentName:"p"},"Verification Key")," to use for verifying the proof."),(0,r.kt)("p",null,"Format: ",(0,r.kt)("inlineCode",{parentName:"p"},"CIRCUITNAME_PARAMETER1_PARAMETER2")),(0,r.kt)("p",null,"List of current types:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"ZKCENSUSPROOF_NLEVELS"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Circuit name: ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/zk-franchise-proof-circuit/blob/master/circuit/census.circom"},(0,r.kt)("inlineCode",{parentName:"a"},"ZKCENSUSPROOF"))),(0,r.kt)("li",{parentName:"ul"},"Parameters: ",(0,r.kt)("inlineCode",{parentName:"li"},"nLevels")),(0,r.kt)("li",{parentName:"ul"},"Example:",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"ZKCENSUSPROOF_100")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"ZKCENSUSPROOF_1000"))))))),(0,r.kt)("h1",{id:"annex"},"Annex"),(0,r.kt)("h4",{id:"examples-of-flags-combinations"},"Examples of flags combinations"),(0,r.kt)("p",null,"Below there are listed some common combinations of flags used when created a new process:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Census MerkleTree (from CSV file or private database) with pre-register: ",(0,r.kt)("inlineCode",{parentName:"li"},"preRegister=true"),", ",(0,r.kt)("inlineCode",{parentName:"li"},"CensusOrigin=OFF_CHAIN_TREE")),(0,r.kt)("li",{parentName:"ul"},"Census MerkleTree (from CSV file or private database) with the Organization defining the ",(0,r.kt)("inlineCode",{parentName:"li"},"CensusRoot")," (creating the user's keys, without pre-register phase): ",(0,r.kt)("inlineCode",{parentName:"li"},"preRegister=false"),", ",(0,r.kt)("inlineCode",{parentName:"li"},"CensusOrigin=OFF_CHAIN_TREE")),(0,r.kt)("li",{parentName:"ul"},"Ethereum Storage Proofs with an ERC20 token: ",(0,r.kt)("inlineCode",{parentName:"li"},"preRegister=false"),", ",(0,r.kt)("inlineCode",{parentName:"li"},"CensusOrigin=ERC20"))),(0,r.kt)("h4",{id:"keykeepers-reveal-and-commit-keys"},"KeyKeepers reveal and commit keys"),(0,r.kt)("p",null,"A set of commitment keys are generated for each election process by a set of trusted identities named ",(0,r.kt)("inlineCode",{parentName:"p"},"keykeepers"),". Only if all ",(0,r.kt)("inlineCode",{parentName:"p"},"keykeepers")," are malicious could they tamper with the process, so it is crucial to distribute these special identities well. Once all these keys are revealed, anyone can generate a valid proof. This mechanism is added to the circuit in order to avoid vote buying when the process is over. Since anyone can now generate a valid proof, a voter will no longer be able to prove that they are the owner of a specific vote nullifier."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Circuit with keykeepers diagram",src:n(5932).Z,width:"1273",height:"665"})),(0,r.kt)("p",null,"zkInputs of this alternative scheme:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-json"},'// Example of zkInputs\n{\n "censusRoot": "51642541620950251760298704744678482162425252475654827255045491135352807540162",\n "censusSiblings": ["0","0","0","0"],\n "secretKey": "6190793965647866647574058687473278714480561351424348391693421151024369116465",\n "voteHash": ["100964581237483263846637432502620436451", "278307331411790712608582894981321409946"],\n "processId": ["242108076058607163538102198631955675649", "142667662805314151155817304537028292174"],\n "nullifier": "1938187656076799017313903315498318464349291455761501098436114043715056719301",\n "relayerPublicKey": "100",\n "relayerProof": "21349690342514405503176665977362532634490340702670001813783738965751319356478",\n "revealKey": ["0"],\n "commitKey": ["19014214495641488759237505126948346942972912379615652741039992445865937985820"]\n}\n')),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"relayerPublicKey"),": given by the ",(0,r.kt)("em",{parentName:"li"},"KeyKeeper")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"relayerProof"),": computed by the ",(0,r.kt)("em",{parentName:"li"},"User"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"relayerProof = poseidon.Hash(nullifier, relayerPublicKey)")))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"revealKey"),": not known by the user at the proof generation moment",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"the length of this array is determined by the ",(0,r.kt)("inlineCode",{parentName:"li"},"nMiners")," parameter of the circuit"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"commitKey"),": given by the ",(0,r.kt)("em",{parentName:"li"},"KeyKeeper"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"the length of this array is determined by the ",(0,r.kt)("inlineCode",{parentName:"li"},"nMiners")," parameter of the circuit"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"poseidon.Hash(relayerPublicKey)"))))))}k.isMDXComponent=!0},13942:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/zk-census-proof-circuit-diagram-bc673914a32b2a293fca6746bb2a0e4e.png"},5932:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/zk-census-proof-circuit-with-keykeepers-keys-diagram-be6db3f298d3ab0e15046cb8233aff66.png"},64723:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/zk-census-proof-poseidon-merkletree-diagram-322663a58bc45d4bd2f43e7bf9016dd7.png"}}]); \ No newline at end of file diff --git a/assets/js/d234883f.b0f80fd5.js b/assets/js/d234883f.b0f80fd5.js new file mode 100644 index 000000000..2bd6f5a79 --- /dev/null +++ b/assets/js/d234883f.b0f80fd5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8277],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>c});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=a.createContext({}),p=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},m=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),u=p(n),c=r,h=u["".concat(s,".").concat(c)]||u[c]||k[c]||i;return n?a.createElement(h,o(o({ref:t},m),{},{components:n})):a.createElement(h,o({ref:t},m))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,o=new Array(i);o[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:r,o[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>k,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var a=n(87462),r=(n(67294),n(3905));const i={},o="Off-Chain Tree ZK Census Proof",l={unversionedId:"protocol/anonymity/zk-census-proof",id:"protocol/anonymity/zk-census-proof",title:"Off-Chain Tree ZK Census Proof",description:"This document is divided in two sections:",source:"@site/docs/protocol/anonymity/zk-census-proof.md",sourceDirName:"protocol/anonymity",slug:"/protocol/anonymity/zk-census-proof",permalink:"/protocol/anonymity/zk-census-proof",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"On-Chain Census Anonymity",permalink:"/protocol/anonymity/on-chain"},next:{title:"Ballot Protocol",permalink:"/protocol/ballot-protocol"}},s={},p=[{value:"Protocol design",id:"protocol-design",level:2},{value:"zkSNARKs for anonymous voters",id:"zksnarks-for-anonymous-voters",level:3},{value:"zkSNARK circuit",id:"zksnark-circuit",level:3},{value:"Proof generation",id:"proof-generation",level:4},{value:"Implementation spec",id:"implementation-spec",level:2},{value:"Flow",id:"flow",level:3},{value:"Steps description",id:"steps-description",level:4},{value:"Flow for csv voting",id:"flow-for-csv-voting",level:4},{value:"Flow for Ethereum Storage Proof voting",id:"flow-for-ethereum-storage-proof-voting",level:4},{value:"Merkle Tree",id:"merkle-tree",level:3},{value:"zkInputs generation",id:"zkinputs-generation",level:3},{value:"Circuit identification",id:"circuit-identification",level:3},{value:"Examples of flags combinations",id:"examples-of-flags-combinations",level:4},{value:"KeyKeepers reveal and commit keys",id:"keykeepers-reveal-and-commit-keys",level:4}],m={toc:p};function k(e){let{components:t,...i}=e;return(0,r.kt)("wrapper",(0,a.Z)({},m,i,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"off-chain-tree-zk-census-proof"},"Off-Chain Tree ZK Census Proof"),(0,r.kt)("p",null,"This document is divided in two sections:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},(0,r.kt)("a",{parentName:"strong",href:"#protocol-design"},"Protocol design")),": high level overview of the protocol."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},(0,r.kt)("a",{parentName:"strong",href:"#implementation-spec"},"Implementation spec")),": detailed specification, featuring the relevant data structures, hash functions, etc.")),(0,r.kt)("h2",{id:"protocol-design"},"Protocol design"),(0,r.kt)("p",null,"The census proof (also called franchise proof) enables user privacy and allows for fully anonymous voting."),(0,r.kt)("p",null,"The starting point is a ",(0,r.kt)("a",{parentName:"p",href:"/protocol/census/off-chain-tree"},"Merkle Proof"),", which efficiently proves that a voter's ",(0,r.kt)("em",{parentName:"p"},"zkCensusKey")," belongs to a Merkle Tree (census). However, using this proof alone would allow the organizer of a process to correlate each vote envelope with its voter's the ",(0,r.kt)("em",{parentName:"p"},"zkCensusKey")," on the database, so votes wouldn't be secret."),(0,r.kt)("p",null,"To this end, Vocdoni achieves voting anonymity by the use of ZK-Snarks."),(0,r.kt)("h3",{id:"zksnarks-for-anonymous-voters"},"zkSNARKs for anonymous voters"),(0,r.kt)("p",null,"Snark stands for ",(0,r.kt)("em",{parentName:"p"},"Succinct non-interactive argument of knowledge"),". In our case, this means proving to someone that we know something, but without revealing the contents of what we know."),(0,r.kt)("p",null,"In our case:"),(0,r.kt)("ol",null,(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("inlineCode",{parentName:"li"},"Voter")," is the owner of the ",(0,r.kt)("inlineCode",{parentName:"li"},"secret key")," corresponding to a certain ",(0,r.kt)("inlineCode",{parentName:"li"},"zkCensusKey")),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("inlineCode",{parentName:"li"},"Voter"),"'s ",(0,r.kt)("inlineCode",{parentName:"li"},"zkCensusKey")," is included in the ",(0,r.kt)("inlineCode",{parentName:"li"},"census")," Merkle Tree"),(0,r.kt)("li",{parentName:"ol"},"The nullifier provided by ",(0,r.kt)("inlineCode",{parentName:"li"},"Voter")," uniquely corresponds to their ",(0,r.kt)("inlineCode",{parentName:"li"},"secret key")," and the ",(0,r.kt)("inlineCode",{parentName:"li"},"process ID")," for a specific voting process")),(0,r.kt)("p",null,"Although the computation is CPU and memory intensive, ZK Proofs can be generated from the user client running on modest hardware. The proof is validated by the Vochain Nodes, Miners, and any Third Party monitoring the process."),(0,r.kt)("h3",{id:"zksnark-circuit"},"zkSNARK circuit"),(0,r.kt)("p",null,"Voters use the proving key generated for the circuit below to generate a ZK Proof. The circuit receives both private and public inputs."),(0,r.kt)("p",null,"Data that could reveal the identity of the voter are kept private (gray boxes in the diagram). Public inputs are submitted within the Vote Envelope, so that validators can check them against the proof and make sure that the user hasn't voted twice."),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"The same circuit can be used for any ",(0,r.kt)("inlineCode",{parentName:"li"},"process")," with a census size of the same range (10k, 100k, 1M, etc)."),(0,r.kt)("li",{parentName:"ul"},"It relies on a ",(0,r.kt)("a",{parentName:"li",href:"https://medium.com/qed-it/diving-into-the-snarks-setup-phase-b7660242a0d7"},(0,r.kt)("strong",{parentName:"a"},"trusted setup ceremony")))),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Circuit diagram",src:n(13942).Z,width:"863",height:"456"})),(0,r.kt)("p",null,"The circuit above verifies that:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"the prover is the owner of the secret key"),(0,r.kt)("li",{parentName:"ul"},"the ",(0,r.kt)("inlineCode",{parentName:"li"},"zkCensusKey")," of the secret key is inside a Hash, which is inside the Merkle Tree with the CensusRoot (",(0,r.kt)("inlineCode",{parentName:"li"},"key=Poseidon(secretKey), value=0"),")"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"H(secretKey, processID) == nullifier"))),(0,r.kt)("h4",{id:"proof-generation"},"Proof generation"),(0,r.kt)("p",null,"The franchise proof is generated by running the zkSNARK circuit."),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Private inputs:")," Index, Secret Key, Census Merkle-proof"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Public inputs:")," Census Merkle-root, Nullifier, ProcessId, Vote"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Output:")," Franchise proof")),(0,r.kt)("p",null,"Steps:"),(0,r.kt)("ol",null,(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Vote encryption"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"encrypted_vote = encrypt( selected_voting_options + random_nonce )")))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Nullifier generation"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"nullifier = hash( process_id + user_secret_key )")))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Fetch merkle proof"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"From any source that has the census merkle tree such as a Vocdoni Gateway or directly from IPFS.")))),(0,r.kt)("h2",{id:"implementation-spec"},"Implementation spec"),(0,r.kt)("h3",{id:"flow"},"Flow"),(0,r.kt)("p",null," ",(0,r.kt)("em",{parentName:"p"},"The following flow describes the "),"csv census",(0,r.kt)("em",{parentName:"p"}," flow.")),(0,r.kt)("mermaid",{value:"%%{init: {'theme':'forest'}}%%\n\nsequenceDiagram\nopt Steps 1-2 depend on the kind of census being used (csv, EthStorageProofs, ...)\n Organizer->>Vochain: 1. create new voting process (newProcessTx) & define the CensusOrigin\n User->>User: 2. generate CensusRegisterProof\nend\n\nUser->>User: 3. generate zkCensusKey\nUser->>Vochain: 4. register zkCensusKey using CensusRegisterProof that matches the CensusOrigin\nVochain->>Vochain: 5. build voting census merkle tree (in state)\nVochain->>Vochain: 6. startBlock is reached, process starts\nVochain->>Vochain: 7. last merkle tree root becomes censusRoot\nVochain->>User: 8.get MerkleProof\n# note, next line goes from User->User instead of User->IPFS to avoid spending a full column just for 1 query to IPFS\nUser->>User: 9. get ProvingKey & WitnessCalc (from IPFS GW)\nUser->>User: 10. generate zkInputs\nUser->>User: 11. generate zkSNARK proof\nUser->>Vochain: 12. cast the vote with zkSNARK proof\nVochain->>Vochain: 13. verify zkSNARK proof, accept the vote"}),(0,r.kt)("h4",{id:"steps-description"},"Steps description"),(0,r.kt)("p",null,"::: tip"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"[O]")," = Organizer"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"[U]")," = User"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"[V]")," = Vochain"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"[G]")," = Gateway\n:::")),(0,r.kt)("ol",{start:0},(0,r.kt)("li",{parentName:"ol"},"Circom ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/zk-franchise-proof-circuit"},"circuit")," is compiled & ",(0,r.kt)("strong",{parentName:"li"},"Trusted Setup")," generated"),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[O+V]")," Create new voting process (newProcessTx) & define the ",(0,r.kt)("strong",{parentName:"li"},"CensusOrigin"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"The ",(0,r.kt)("strong",{parentName:"li"},"CensusOrigin")," could be for example:\t",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Using ",(0,r.kt)("strong",{parentName:"li"},"csv file"),": Generate MerkleTree from a ",(0,r.kt)("inlineCode",{parentName:"li"},"csv")," data file, where the ",(0,r.kt)("strong",{parentName:"li"},"CensusOrigin")," determines the verification of the MerkleProof of that MerkleTree (check the ",(0,r.kt)("a",{parentName:"li",href:"#flow-for-csv-voting"},"csv voting section")," for more details)"),(0,r.kt)("li",{parentName:"ul"},"Using ",(0,r.kt)("strong",{parentName:"li"},"Ethereum storage proofs"),": The MerkleTree is the root of the EthereumTree at a certain block, and the ",(0,r.kt)("strong",{parentName:"li"},"CensusOrigin")," determines the verification of the MerkleProof of that Ethereum MerkleTree (check ",(0,r.kt)("a",{parentName:"li",href:"#flow-for-ethereum-storage-proof-voting"},"ethereum storage proof section")," for more details)"))))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," Generate CensusRegisterProof, more details:",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"#flow-for-csv-voting"},"flow for csv voting")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"#flow-for-ethereum-storage-proof-voting"},"flow for ethereum storage proof voting")))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," Generate ",(0,r.kt)("strong",{parentName:"li"},"zkCensusKey")," (used as leaf key)",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"User's ",(0,r.kt)("em",{parentName:"li"},"zkCensusKey"),": ",(0,r.kt)("inlineCode",{parentName:"li"},"zkCensusKey = Hash(userSecret)")),(0,r.kt)("li",{parentName:"ul"},"This is the key that will be added into the ",(0,r.kt)("em",{parentName:"li"},"CensusTree")))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U+V]")," ",(0,r.kt)("strong",{parentName:"li"},"Register zkCensusKey")," using ",(0,r.kt)("strong",{parentName:"li"},"CensusRegisterProof")," (registerKeyTx)")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Vochain checks that the ",(0,r.kt)("strong",{parentName:"li"},"CensusRegistryProof")," can be validated for the ",(0,r.kt)("strong",{parentName:"li"},"CensusOrigin"))),(0,r.kt)("ol",{start:5},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[V]")," Build voting ",(0,r.kt)("strong",{parentName:"li"},"census merkle tree")," (in state)",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Where each leaf contains the hash of each user's ",(0,r.kt)("inlineCode",{parentName:"li"},"secretKey")," (",(0,r.kt)("em",{parentName:"li"},"zkCensusKey"),")"),(0,r.kt)("li",{parentName:"ul"},"MerkleTree type: circom compatible",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Hash function: ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/iden3/go-iden3-crypto/blob/master/poseidon/poseidon.go"},"Poseidon")),(0,r.kt)("li",{parentName:"ul"},"Tree ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/vocdoni-node/blob/main/censustree/censustree.go"},"Go impl")))))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[V]")," StartBlock is reached, ",(0,r.kt)("strong",{parentName:"li"},"process starts")),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[V]")," Last merkle tree root becomes ",(0,r.kt)("strong",{parentName:"li"},"censusRoot")),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[V+U]")," ",(0,r.kt)("strong",{parentName:"li"},"Get MerkleProof"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Vochain will send the ",(0,r.kt)("em",{parentName:"li"},"'compressed MerkleProof'")," (which are the siblings compressed)"),(0,r.kt)("li",{parentName:"ul"},"Client side will need to 'decompress' it",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"The logic to decompress the siblings ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/arbo/blob/master/tree.go#L606"},"can be found here")),(0,r.kt)("li",{parentName:"ul"},"And ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/arbo/blob/master/tree.go#L577"},"here")," the explaination of the encoding"))))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U+G]")," ",(0,r.kt)("strong",{parentName:"li"},"Get ProvingKey & WitnessCalc"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"Proving Key & Witness Calc")," depend on the circuit being used"))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," ",(0,r.kt)("strong",{parentName:"li"},"Generate zkInputs"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"check the ",(0,r.kt)("a",{parentName:"li",href:"#zkinputs-generation"},"zkInputs generation")," section for more details"))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," ",(0,r.kt)("strong",{parentName:"li"},"Generate zkSNARK proof"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"using: ",(0,r.kt)("em",{parentName:"li"},"zkInputs + Proving Key + Witness Calculator")))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," ",(0,r.kt)("strong",{parentName:"li"},"Cast the vote")," with zkSNARK proof",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"contains:",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"public inputs")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"zkProof")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"vote")))))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[V]")," ",(0,r.kt)("strong",{parentName:"li"},"Verify zkSNARK proof"),", accept the vote",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Needs to know:",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"ElectionID"),(0,r.kt)("li",{parentName:"ul"},"Verification Key (depends on the circuit being used (census size))"),(0,r.kt)("li",{parentName:"ul"},"User's ",(0,r.kt)("em",{parentName:"li"},"public inputs")," + ",(0,r.kt)("em",{parentName:"li"},"zkProof"))))))),(0,r.kt)("h4",{id:"flow-for-csv-voting"},"Flow for csv voting"),(0,r.kt)("p",null,"::: tip\n",(0,r.kt)("strong",{parentName:"p"},"Important"),": This scheme assumes fully trusting the ",(0,r.kt)("em",{parentName:"p"},"organization"),", as the\n",(0,r.kt)("em",{parentName:"p"},"organization")," could add non-real users to the census that later can be used\nto issue valid votes."),(0,r.kt)("p",null,"This use case would set the flag ",(0,r.kt)("inlineCode",{parentName:"p"},"preRegister=true")," and the ",(0,r.kt)("inlineCode",{parentName:"p"},"CensusOrigin")," would be ",(0,r.kt)("inlineCode",{parentName:"p"},"OFF_CHAIN_TREE")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"OFF_CHAIN_TREE_WEIGHTED"),".\n:::"),(0,r.kt)("mermaid",{value:"%%{init: {'theme':'forest'}}%%\n\nsequenceDiagram\nopt Steps 1-2 for the csv processes\n Organizer->>Organizer: 0.1. create user login keys\n Organizer->>Organizer: 0.2. build merkleTree with login keys\n Organizer->>Vochain: 1. create new voting process (newProcessTx) & define the CensusOrigin=OFF_CHAIN_TREE\n User->>User: 2. generate CensusRegisterProof of type csv-merkletree\nend\nUser->>User: 3. generate zkCensusKey\nUser->>Vochain: 4. register zkCensusKey using CensusRegisterProof (registerKeyTx)\nNote over Organizer,User: From here continues with the normal flow"}),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"0.1. ",(0,r.kt)("em",{parentName:"li"},"[O]")," Create user ",(0,r.kt)("strong",{parentName:"li"},"login keys"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"from csv data"))),(0,r.kt)("li",{parentName:"ul"},"0.2. ",(0,r.kt)("em",{parentName:"li"},"[O]")," Build ",(0,r.kt)("strong",{parentName:"li"},"MerkleTree")," with login keys"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("ol",{parentName:"li"},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[O+V]")," Create ",(0,r.kt)("strong",{parentName:"li"},"new voting process")," (newProcessTx) & define the ",(0,r.kt)("inlineCode",{parentName:"li"},"CensusOrigin=OFF_CHAIN_TREE"))),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"CensusOrigin")," determines the checks:",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"the given ",(0,r.kt)("em",{parentName:"li"},"MerkleProof")," matches with the defined ",(0,r.kt)("em",{parentName:"li"},"Census Root")))))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("ol",{parentName:"li",start:2},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," Generate ",(0,r.kt)("strong",{parentName:"li"},"CensusRegisterProof"))),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"which is the MerkleProof that the user 'login key' is in the tree "))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("ol",{parentName:"li",start:3},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," Generate ",(0,r.kt)("strong",{parentName:"li"},"zkCensusKey")," (used as leaf key)")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"User's ",(0,r.kt)("em",{parentName:"li"},"zkCensusKey"),": ",(0,r.kt)("inlineCode",{parentName:"li"},"zkCensusKey = Hash(userSecret)"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Here ",(0,r.kt)("inlineCode",{parentName:"li"},"userSecret")," can be ",(0,r.kt)("inlineCode",{parentName:"li"},"csv user's data + secret from user")),(0,r.kt)("li",{parentName:"ul"},"This is the key that will be added into the ",(0,r.kt)("em",{parentName:"li"},"CensusTree")))))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("ol",{parentName:"li",start:4},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U+V]")," ",(0,r.kt)("strong",{parentName:"li"},"Register zkCensusKey")," using ",(0,r.kt)("strong",{parentName:"li"},"CensusRegisterProof")," (registerKeyTx)")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Vochain checks that the ",(0,r.kt)("strong",{parentName:"li"},"CensusRegistryProof")," can be validated for the ",(0,r.kt)("strong",{parentName:"li"},"CensusOrigin"))))),(0,r.kt)("p",null,"::: tip\nThe organization could also directly register ",(0,r.kt)("em",{parentName:"p"},"Users'")," secret keys to the Vochain, avoiding the need for a registration phase. This option would use the ",(0,r.kt)("inlineCode",{parentName:"p"},"ProcessMode")," flags "),(0,r.kt)("p",null,"This use case would set the flag ",(0,r.kt)("inlineCode",{parentName:"p"},"preRegister=false")," and the ",(0,r.kt)("inlineCode",{parentName:"p"},"CensusOrigin")," would be ",(0,r.kt)("inlineCode",{parentName:"p"},"OFF_CHAIN_TREE")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"OFF_CHAIN_TREE_WEIGHTED")," with the ",(0,r.kt)("inlineCode",{parentName:"p"},"CensusRoot")," determined by the Organization.\n:::"),(0,r.kt)("h4",{id:"flow-for-ethereum-storage-proof-voting"},"Flow for Ethereum Storage Proof voting"),(0,r.kt)("mermaid",{value:"%%{init: {'theme':'forest'}}%%\n\nsequenceDiagram\nopt Steps 1-2 for the Ethereum Storage Proofs processes\n Organizer->>Vochain: 1.0. create new voting process (newProcessTx) & define the CensusOrigin=ERC20\n User->>User: 2. generate CensusRegisterProof of type EthStorageProof\nend\nUser->>User: 3. generate zkCensusKey\nUser->>Vochain: 4. register zkCensusKey using CensusRegisterProof (registerKeyTx)\nNote over Organizer,User: From here continues with the normal flow"}),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("ol",{parentName:"li"},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[O+V]")," Create ",(0,r.kt)("strong",{parentName:"li"},"new voting process")," (newProcessTx) & define the ",(0,r.kt)("inlineCode",{parentName:"li"},"CensusOrigin=ERC20")," (or one of the others available such as ",(0,r.kt)("inlineCode",{parentName:"li"},"ERC777"),", ",(0,r.kt)("inlineCode",{parentName:"li"},"MINI_ME"),", etc)")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"CensusOrigin: determines to check that:",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"the given ",(0,r.kt)("em",{parentName:"li"},"MerkleProof")," matches with the defined ",(0,r.kt)("em",{parentName:"li"},"Ethereum Root")),(0,r.kt)("li",{parentName:"ul"},"the sender of the ",(0,r.kt)("em",{parentName:"li"},"MerkleProof")," is the owner of that address (check eth-signature)"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"[O]")," Define the ",(0,r.kt)("em",{parentName:"li"},"EthTreeRoot")," for the ",(0,r.kt)("strong",{parentName:"li"},"CensusOrigin")))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("ol",{parentName:"li",start:2},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," Generate ",(0,r.kt)("strong",{parentName:"li"},"CensusRegisterProof"))),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"which is the EthereumStorageProof + an ethereum signature by the address of the EthereumStorageProof (to prove ownership of the proof)"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("ol",{parentName:"li",start:3},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U]")," Generate ",(0,r.kt)("strong",{parentName:"li"},"zkCensusKey")," (used as leaf key)")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"User's ",(0,r.kt)("em",{parentName:"li"},"zkCensusKey"),": ",(0,r.kt)("inlineCode",{parentName:"li"},"zkCensusKey = Hash(userSecret)")),(0,r.kt)("li",{parentName:"ul"},"Here ",(0,r.kt)("inlineCode",{parentName:"li"},"userSecret")," can be the value of the signature of a public known constant made by the user's EthereumKey (where the output is only known by the user, as it is used as a 'secret key'). This is the approach that Hermez zkRollup uses to derive 'snark friendly' keys from Metamask's Ethereum Keys",(0,r.kt)("pre",{parentName:"li"},(0,r.kt)("code",{parentName:"pre"},"- This is the key that will be added into the *CensusTree*\n"))))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("ol",{parentName:"li",start:4},(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("em",{parentName:"li"},"[U+V]")," ",(0,r.kt)("strong",{parentName:"li"},"Register zkCensusKey")," using ",(0,r.kt)("strong",{parentName:"li"},"CensusRegisterProof")," (registerKeyTx)")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Vochain checks that the ",(0,r.kt)("strong",{parentName:"li"},"CensusRegistryProof")," can be validated for the ",(0,r.kt)("strong",{parentName:"li"},"CensusOrigin"))))),(0,r.kt)("h3",{id:"merkle-tree"},"Merkle Tree"),(0,r.kt)("p",null,"The MerkleTree used for building the ",(0,r.kt)("em",{parentName:"p"},"anonymous census")," needs to be a zkSNARK-friendly implementation. As currently we are using ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/iden3/circom"},"Circom")," for the zkSNARK circuits, we need to be compatible with the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/iden3/circomlib/tree/master/circuits/smt"},"circomlib")," MerkleTree implementation. A specification of the MerkleTree ",(0,r.kt)("a",{parentName:"p",href:"https://docs.iden3.io/publications/pdfs/Merkle-Tree.pdf"},"can be found here"),"."),(0,r.kt)("p",null,"In the Vochain, we're using the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/arbo"},"arbo")," MerkleTree, which is a Go implementation compatible with the Circom spec."),(0,r.kt)("p",null,"The MerkleTree uses the ",(0,r.kt)("a",{parentName:"p",href:"https://eprint.iacr.org/2019/458.pdf"},"Poseidon")," hash, which is a 'snark-friendly' hash function that later on can be proved inside a circuit without requiring too many constraints."),(0,r.kt)("p",null,"The following diagram contains a visual representation of the data structure of the Leaves of the MerkleTree being used in the scheme of the zk-census-proof."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Poseidon merkle tree with zk census proof",src:n(64723).Z,width:"418",height:"326"})),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"index")," value is determined by the ",(0,r.kt)("em",{parentName:"p"},"CensusTree")," builder, which has an ",(0,r.kt)("inlineCode",{parentName:"p"},"index")," value for each ",(0,r.kt)("em",{parentName:"p"},"CensusTree"),". This value increments with the addition of each new leaf."),(0,r.kt)("p",null,"The ",(0,r.kt)("em",{parentName:"p"},"Leaves")," are structured in this way in order to use the MerkleTrees more efficiently, allowing more user keys to fit inside a smaller tree and therefore reducing the zk circuit size. This is because the value of any given leaf's ",(0,r.kt)("em",{parentName:"p"},"key")," determines that leaf's ",(0,r.kt)("em",{parentName:"p"},"position")," on the tree. If the leaf key were determined by the ",(0,r.kt)("inlineCode",{parentName:"p"},"zkCensusKey"),", rather than an incremental ",(0,r.kt)("inlineCode",{parentName:"p"},"index"),", each new leaf would have a significant chance of collision before filling all the available leaf spots for a given height. Trees would therefore be less balanced and require larger circuits for the same census size due to inefficient use of tree space. With the incremental index approach, on the other hand, all the leaf spots can be filled without a single collision. This produces much smaller circuits for the same number of users."),(0,r.kt)("h3",{id:"zkinputs-generation"},"zkInputs generation"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-json"},'// Example of zkInputs\n{\n "censusRoot": "51642541620950251760298704744678482162425252475654827255045491135352807540162",\n "censusSiblings": ["0","0","0","0"],\n "index": "30",\n "secretKey": "6190793965647866647574058687473278714480561351424348391693421151024369116465",\n "voteHash": ["100964581237483263846637432502620436451", "278307331411790712608582894981321409946"],\n "processId": ["115971795979716226347584900263213958763", "100167351390541057173626244722405453127"],\n "nullifier": "1938187656076799017313903315498318464349291455761501098436114043715056719301",\n}\n')),(0,r.kt)("p",null,"Origin of each zkInput parameter:\n::: tip\n",(0,r.kt)("em",{parentName:"p"},"all the parameters are ",(0,r.kt)("inlineCode",{parentName:"em"},"string")," or ",(0,r.kt)("inlineCode",{parentName:"em"},"[]string")," that represent ",(0,r.kt)("inlineCode",{parentName:"em"},"bigInt")," or ",(0,r.kt)("inlineCode",{parentName:"em"},"[]bigInt")),"\n:::"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"censusRoot"),": computed by the ",(0,r.kt)("em",{parentName:"li"},"CensusAuthority")," from the ",(0,r.kt)("em",{parentName:"li"},"Census Tree")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"censusSiblings"),": computed by the ",(0,r.kt)("em",{parentName:"li"},"CensusAuthority"),", is the ",(0,r.kt)("em",{parentName:"li"},"Merkle Proof"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"the ",(0,r.kt)("em",{parentName:"li"},"User")," retrieves the ",(0,r.kt)("em",{parentName:"li"},"siblings")," from the ",(0,r.kt)("em",{parentName:"li"},"Vochain")," through the ",(0,r.kt)("em",{parentName:"li"},"Gateway")),(0,r.kt)("li",{parentName:"ul"},"the length of ",(0,r.kt)("em",{parentName:"li"},"censusSiblings")," will depend on the ",(0,r.kt)("em",{parentName:"li"},"zkCircuit"),":",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"The design of the ",(0,r.kt)("em",{parentName:"li"},"MerkleTree")," used in circomlib provokes different lengths in the siblings returned when generating a ",(0,r.kt)("em",{parentName:"li"},"MerkleProof")))),(0,r.kt)("li",{parentName:"ul"},"This is due the design of the ",(0,r.kt)("em",{parentName:"li"},"MerkleTree")," defines a tree in which the deep of the tree (from the root to the leafs) will depend on each leaf and its neighbors. More details can be found in the ",(0,r.kt)("a",{parentName:"li",href:"https://docs.iden3.io/publications/pdfs/Merkle-Tree.pdf"},(0,r.kt)("em",{parentName:"a"},"MerkleTree")," spec"),".",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"In order to input those siblings into the circuit, the ",(0,r.kt)("inlineCode",{parentName:"li"},"nLevels")," of the circuit is fixed, so the length of ",(0,r.kt)("em",{parentName:"li"},"siblings")," needs to be fixed also."),(0,r.kt)("li",{parentName:"ul"},"So, the len(siblings) will depend on the ",(0,r.kt)("em",{parentName:"li"},"zkCircuit")," being used, specifically from the ",(0,r.kt)("inlineCode",{parentName:"li"},"nLevels")," parameter of the circuit"))))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"index"),": determined by the Vochain when adding the ",(0,r.kt)("em",{parentName:"li"},"User"),"'s ",(0,r.kt)("em",{parentName:"li"},"zkCensusKey")," into the ",(0,r.kt)("em",{parentName:"li"},"CensusTree")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"secretKey"),": generated by the ",(0,r.kt)("em",{parentName:"li"},"User")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"voteHash"),": hashed value of the ",(0,r.kt)("em",{parentName:"li"},"User")," vote, composed by two big integers.",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"The raw user vote is a variable-length array of values and its values do not need to be checked in the circuit. Furthermore, the values can be encrypted."),(0,r.kt)("li",{parentName:"ul"},"Since the encoded vote values may not fit into a constant number of circuit inputs, we calculate a summary of the raw user vote using an EVM-friendly hash function: ",(0,r.kt)("inlineCode",{parentName:"li"},"sha256(vote_bytes)"),". The output of the sha256 hash is slightly larger than the field used in SNARKS, so we split the hash output (32-bytes) into 2 16-byte arrays, take them as integers (in little-endian), and use them as circuit inputs.",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"sha256")," hash is used, as if necessary in the future it can be ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/iden3/circomlib/blob/master/circuits/sha256/sha256.circom"},"verified inside")," the circuit. This usage has two characteristics to keep in mind:",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"sha256")," is twice as expensive as ",(0,r.kt)("inlineCode",{parentName:"li"},"keccak256")," in terms of gas in EVM, but it is implemented in ",(0,r.kt)("inlineCode",{parentName:"li"},"circom"),", so it can be checked inside a circuit (keccak256 is also ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/keccak256-circom"},"implemented inside a circuit"),", but it takes too many constraints for the current use case)"),(0,r.kt)("li",{parentName:"ul"},"checking the ",(0,r.kt)("inlineCode",{parentName:"li"},"sha256")," inside a circom circuit is expensive in terms of number of constraints (in the current version of this spec, this is not checked inside the circuit)"))))),(0,r.kt)("li",{parentName:"ul"},"example:",(0,r.kt)("pre",{parentName:"li"},(0,r.kt)("code",{parentName:"pre",className:"language-go"},"h := sha256.Sum256(voteBytes) // voteBytes can be the votes array converted to bytes, or the encrypted votes\nb1 := new(big.Int).SetBytes(swapEndianness(h[:16])) // swap endianness, as golang big int package works in big-endian, and we use little-endian\nb2 := new(big.Int).SetBytes(swapEndianness(h[16:]))\n")),"And the json input of the ",(0,r.kt)("inlineCode",{parentName:"li"},"voteHash")," for the circuit would be: ",(0,r.kt)("inlineCode",{parentName:"li"},'"voteHash": [b1, b2]')))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"processId"),": the process ID in which the ",(0,r.kt)("em",{parentName:"li"},"User")," is participating. As the process ID is a 32 byte array, we use the same method used for the ",(0,r.kt)("inlineCode",{parentName:"li"},"voteHash"),": the 32 bytes of process ID are splitted by the half, and each one is represented as a big integer (little-endian).",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"example:")),(0,r.kt)("pre",{parentName:"li"},(0,r.kt)("code",{parentName:"pre",className:"language-go"}," processID0 := new(big.Int).SetBytes(swapEndianness(processIDBytes[:16])) // swap endianness, as golang big int package works in big-endian, and we use little-endian\n processID1 := new(big.Int).SetBytes(swapEndianness(processIDBytes[16:]))\n"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"nullifier"),": computed by ",(0,r.kt)("em",{parentName:"li"},"User"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"nullifier = poseidon.Hash(sk, processID[0], processID[1])"))))),(0,r.kt)("h3",{id:"circuit-identification"},"Circuit identification"),(0,r.kt)("p",null,"There will be different circuits of the ",(0,r.kt)("inlineCode",{parentName:"p"},"zk-census-proof")," depending on the census size, also there could be more use cases with different circuit designs.\nBoth the client and the Vochain need a way to univocally identify those circuits, in order to user the proper ",(0,r.kt)("inlineCode",{parentName:"p"},"Proving key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Witness calculator")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"Verification key")," for each circuit."),(0,r.kt)("p",null,"Circuits are identified across the stack by using a Protobuf enum type. Each ",(0,r.kt)("inlineCode",{parentName:"p"},"ProofZkSNARK")," protobuf package will have a ",(0,r.kt)("inlineCode",{parentName:"p"},"Type")," identifier indicating which circuit the proof belongs to, so the Vochain knows which ",(0,r.kt)("inlineCode",{parentName:"p"},"Verification Key")," to use for verifying the proof."),(0,r.kt)("p",null,"Format: ",(0,r.kt)("inlineCode",{parentName:"p"},"CIRCUITNAME_PARAMETER1_PARAMETER2")),(0,r.kt)("p",null,"List of current types:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"ZKCENSUSPROOF_NLEVELS"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Circuit name: ",(0,r.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/zk-franchise-proof-circuit/blob/master/circuit/census.circom"},(0,r.kt)("inlineCode",{parentName:"a"},"ZKCENSUSPROOF"))),(0,r.kt)("li",{parentName:"ul"},"Parameters: ",(0,r.kt)("inlineCode",{parentName:"li"},"nLevels")),(0,r.kt)("li",{parentName:"ul"},"Example:",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"ZKCENSUSPROOF_100")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"ZKCENSUSPROOF_1000"))))))),(0,r.kt)("h1",{id:"annex"},"Annex"),(0,r.kt)("h4",{id:"examples-of-flags-combinations"},"Examples of flags combinations"),(0,r.kt)("p",null,"Below there are listed some common combinations of flags used when created a new process:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Census MerkleTree (from CSV file or private database) with pre-register: ",(0,r.kt)("inlineCode",{parentName:"li"},"preRegister=true"),", ",(0,r.kt)("inlineCode",{parentName:"li"},"CensusOrigin=OFF_CHAIN_TREE")),(0,r.kt)("li",{parentName:"ul"},"Census MerkleTree (from CSV file or private database) with the Organization defining the ",(0,r.kt)("inlineCode",{parentName:"li"},"CensusRoot")," (creating the user's keys, without pre-register phase): ",(0,r.kt)("inlineCode",{parentName:"li"},"preRegister=false"),", ",(0,r.kt)("inlineCode",{parentName:"li"},"CensusOrigin=OFF_CHAIN_TREE")),(0,r.kt)("li",{parentName:"ul"},"Ethereum Storage Proofs with an ERC20 token: ",(0,r.kt)("inlineCode",{parentName:"li"},"preRegister=false"),", ",(0,r.kt)("inlineCode",{parentName:"li"},"CensusOrigin=ERC20"))),(0,r.kt)("h4",{id:"keykeepers-reveal-and-commit-keys"},"KeyKeepers reveal and commit keys"),(0,r.kt)("p",null,"A set of commitment keys are generated for each election process by a set of trusted identities named ",(0,r.kt)("inlineCode",{parentName:"p"},"keykeepers"),". Only if all ",(0,r.kt)("inlineCode",{parentName:"p"},"keykeepers")," are malicious could they tamper with the process, so it is crucial to distribute these special identities well. Once all these keys are revealed, anyone can generate a valid proof. This mechanism is added to the circuit in order to avoid vote buying when the process is over. Since anyone can now generate a valid proof, a voter will no longer be able to prove that they are the owner of a specific vote nullifier."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Circuit with keykeepers diagram",src:n(5932).Z,width:"1273",height:"665"})),(0,r.kt)("p",null,"zkInputs of this alternative scheme:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-json"},'// Example of zkInputs\n{\n "censusRoot": "51642541620950251760298704744678482162425252475654827255045491135352807540162",\n "censusSiblings": ["0","0","0","0"],\n "secretKey": "6190793965647866647574058687473278714480561351424348391693421151024369116465",\n "voteHash": ["100964581237483263846637432502620436451", "278307331411790712608582894981321409946"],\n "processId": ["242108076058607163538102198631955675649", "142667662805314151155817304537028292174"],\n "nullifier": "1938187656076799017313903315498318464349291455761501098436114043715056719301",\n "relayerPublicKey": "100",\n "relayerProof": "21349690342514405503176665977362532634490340702670001813783738965751319356478",\n "revealKey": ["0"],\n "commitKey": ["19014214495641488759237505126948346942972912379615652741039992445865937985820"]\n}\n')),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"relayerPublicKey"),": given by the ",(0,r.kt)("em",{parentName:"li"},"KeyKeeper")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"relayerProof"),": computed by the ",(0,r.kt)("em",{parentName:"li"},"User"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"relayerProof = poseidon.Hash(nullifier, relayerPublicKey)")))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"revealKey"),": not known by the user at the proof generation moment",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"the length of this array is determined by the ",(0,r.kt)("inlineCode",{parentName:"li"},"nMiners")," parameter of the circuit"))),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("em",{parentName:"li"},"commitKey"),": given by the ",(0,r.kt)("em",{parentName:"li"},"KeyKeeper"),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"the length of this array is determined by the ",(0,r.kt)("inlineCode",{parentName:"li"},"nMiners")," parameter of the circuit"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"poseidon.Hash(relayerPublicKey)"))))))}k.isMDXComponent=!0},13942:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/zk-census-proof-circuit-diagram-bc673914a32b2a293fca6746bb2a0e4e.png"},5932:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/zk-census-proof-circuit-with-keykeepers-keys-diagram-be6db3f298d3ab0e15046cb8233aff66.png"},64723:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/zk-census-proof-poseidon-merkletree-diagram-322663a58bc45d4bd2f43e7bf9016dd7.png"}}]); \ No newline at end of file diff --git a/assets/js/d250e750.adc2f8a1.js b/assets/js/d250e750.365d60d7.js similarity index 57% rename from assets/js/d250e750.adc2f8a1.js rename to assets/js/d250e750.365d60d7.js index 28a8d7fd3..7b732a368 100644 --- a/assets/js/d250e750.adc2f8a1.js +++ b/assets/js/d250e750.365d60d7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5677],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),c=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),u=c(n),f=i,m=u["".concat(s,".").concat(f)]||u[f]||d[f]||a;return n?r.createElement(m,o(o({ref:t},p),{},{components:n})):r.createElement(m,o({ref:t},p))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:i,o[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var r=n(87462),i=(n(67294),n(3905));const a={},o=void 0,l={unversionedId:"sdk/reference/interfaces/IQuestion",id:"sdk/reference/interfaces/IQuestion",title:"IQuestion",description:"@vocdoni/sdk / Exports / IQuestion",source:"@site/docs/sdk/reference/interfaces/IQuestion.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IQuestion",permalink:"/sdk/reference/interfaces/IQuestion",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IPublishedElectionParameters",permalink:"/sdk/reference/interfaces/IPublishedElectionParameters"},next:{title:"ITallyMode",permalink:"/sdk/reference/interfaces/ITallyMode"}},s={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"choices",id:"choices",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"numAbstains",id:"numabstains",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-3",level:4}],p={toc:c};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IQuestion"),(0,i.kt)("h1",{id:"interface-iquestion"},"Interface: IQuestion"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IQuestion#choices"},"choices")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IQuestion#description"},"description")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IQuestion#numabstains"},"numAbstains")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IQuestion#title"},"title"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"choices"},"choices"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"choices"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChoice"},(0,i.kt)("inlineCode",{parentName:"a"},"IChoice")),"[]"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L34"},"types/metadata/election.ts:34")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L32"},"types/metadata/election.ts:32")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"numabstains"},"numAbstains"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"numAbstains"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L33"},"types/metadata/election.ts:33")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/metadata/election.ts#L31"},"types/metadata/election.ts:31")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5677],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),c=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),u=c(n),f=i,m=u["".concat(s,".").concat(f)]||u[f]||d[f]||a;return n?r.createElement(m,o(o({ref:t},p),{},{components:n})):r.createElement(m,o({ref:t},p))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:i,o[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var r=n(87462),i=(n(67294),n(3905));const a={},o=void 0,l={unversionedId:"sdk/reference/interfaces/IQuestion",id:"sdk/reference/interfaces/IQuestion",title:"IQuestion",description:"@vocdoni/sdk / Exports / IQuestion",source:"@site/docs/sdk/reference/interfaces/IQuestion.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IQuestion",permalink:"/sdk/reference/interfaces/IQuestion",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IPublishedElectionParameters",permalink:"/sdk/reference/interfaces/IPublishedElectionParameters"},next:{title:"ITallyMode",permalink:"/sdk/reference/interfaces/ITallyMode"}},s={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"choices",id:"choices",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"numAbstains",id:"numabstains",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-3",level:4}],p={toc:c};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IQuestion"),(0,i.kt)("h1",{id:"interface-iquestion"},"Interface: IQuestion"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IQuestion#choices"},"choices")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IQuestion#description"},"description")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IQuestion#numabstains"},"numAbstains")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IQuestion#title"},"title"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"choices"},"choices"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"choices"),": ",(0,i.kt)("a",{parentName:"p",href:"IChoice"},(0,i.kt)("inlineCode",{parentName:"a"},"IChoice")),"[]"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L34"},"types/metadata/election.ts:34")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L32"},"types/metadata/election.ts:32")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"numabstains"},"numAbstains"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"numAbstains"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L33"},"types/metadata/election.ts:33")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/metadata/election.ts#L31"},"types/metadata/election.ts:31")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d28adde9.3bb8fb78.js b/assets/js/d28adde9.3bb8fb78.js deleted file mode 100644 index c51080482..000000000 --- a/assets/js/d28adde9.3bb8fb78.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4201],{3905:(e,n,t)=>{t.d(n,{Zo:()=>u,kt:()=>f});var r=t(67294);function s(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(s[t]=e[t]);return s}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(s[t]=e[t])}return s}var l=r.createContext({}),c=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},u=function(e){var n=c(e.components);return r.createElement(l.Provider,{value:n},e.children)},p={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,s=e.mdxType,i=e.originalType,l=e.parentName,u=a(e,["components","mdxType","originalType","parentName"]),d=c(t),f=s,k=d["".concat(l,".").concat(f)]||d[f]||p[f]||i;return t?r.createElement(k,o(o({ref:n},u),{},{components:t})):r.createElement(k,o({ref:n},u))}));function f(e,n){var t=arguments,s=n&&n.mdxType;if("string"==typeof e||s){var i=t.length,o=new Array(i);o[0]=d;var a={};for(var l in n)hasOwnProperty.call(n,l)&&(a[l]=n[l]);a.originalType=e,a.mdxType="string"==typeof e?e:s,o[1]=a;for(var c=2;c{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var r=t(87462),s=(t(67294),t(3905));const i={},o=void 0,a={unversionedId:"sdk/reference/interfaces/ICensus",id:"sdk/reference/interfaces/ICensus",title:"ICensus",description:"@vocdoni/sdk / Exports / ICensus",source:"@site/docs/sdk/reference/interfaces/ICensus.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus",permalink:"/sdk/reference/interfaces/ICensus",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IBudgetElectionParametersWithCensusWeight",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight"},next:{title:"ICensus3CensusListResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusListResponse"}},l={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"censusOrigin",id:"censusorigin",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"censusRoot",id:"censusroot",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"censusURL",id:"censusurl",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"postRegisterCensusRoot",id:"postregistercensusroot",level:3},{value:"Defined in",id:"defined-in-4",level:4}],u={toc:c};function p(e){let{components:n,...t}=e;return(0,s.kt)("wrapper",(0,r.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus"),(0,s.kt)("h1",{id:"interface-icensus"},"Interface: ICensus"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus#censusorigin"},"censusOrigin")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus#censusroot"},"censusRoot")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus#censusurl"},"censusURL")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus#maxcensussize"},"maxCensusSize")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus#postregistercensusroot"},"postRegisterCensusRoot"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"censusorigin"},"censusOrigin"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"censusOrigin"),": ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusTypeEnum"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusTypeEnum"))),(0,s.kt)("p",null,"The type of the census"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L21"},"api/election.ts:21")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"censusroot"},"censusRoot"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"censusRoot"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The root of the census"),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L26"},"api/election.ts:26")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"censusurl"},"censusURL"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"censusURL"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The URL of the census"),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L36"},"api/election.ts:36")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("p",null,"Max size of the census. How many voters the census can have."),(0,s.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L41"},"api/election.ts:41")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"postregistercensusroot"},"postRegisterCensusRoot"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"postRegisterCensusRoot"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The post register root of the census"),(0,s.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L31"},"api/election.ts:31")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d28adde9.7c818091.js b/assets/js/d28adde9.7c818091.js new file mode 100644 index 000000000..045f9fdb3 --- /dev/null +++ b/assets/js/d28adde9.7c818091.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4201],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var r=n(67294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var l=r.createContext({}),u=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=u(e.components);return r.createElement(l.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,s=e.mdxType,i=e.originalType,l=e.parentName,c=a(e,["components","mdxType","originalType","parentName"]),d=u(n),f=s,k=d["".concat(l,".").concat(f)]||d[f]||p[f]||i;return n?r.createElement(k,o(o({ref:t},c),{},{components:n})):r.createElement(k,o({ref:t},c))}));function f(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var i=n.length,o=new Array(i);o[0]=d;var a={};for(var l in t)hasOwnProperty.call(t,l)&&(a[l]=t[l]);a.originalType=e,a.mdxType="string"==typeof e?e:s,o[1]=a;for(var u=2;u{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>u});var r=n(87462),s=(n(67294),n(3905));const i={},o=void 0,a={unversionedId:"sdk/reference/interfaces/ICensus",id:"sdk/reference/interfaces/ICensus",title:"ICensus",description:"@vocdoni/sdk / Exports / ICensus",source:"@site/docs/sdk/reference/interfaces/ICensus.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus",permalink:"/sdk/reference/interfaces/ICensus",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IBudgetElectionParametersWithCensusWeight",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight"},next:{title:"ICensus3CensusListResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusListResponse"}},l={},u=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"censusOrigin",id:"censusorigin",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"censusRoot",id:"censusroot",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"censusURL",id:"censusurl",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"postRegisterCensusRoot",id:"postregistercensusroot",level:3},{value:"Defined in",id:"defined-in-4",level:4}],c={toc:u};function p(e){let{components:t,...n}=e;return(0,s.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus"),(0,s.kt)("h1",{id:"interface-icensus"},"Interface: ICensus"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus#censusorigin"},"censusOrigin")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus#censusroot"},"censusRoot")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus#censusurl"},"censusURL")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus#maxcensussize"},"maxCensusSize")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus#postregistercensusroot"},"postRegisterCensusRoot"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"censusorigin"},"censusOrigin"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"censusOrigin"),": ",(0,s.kt)("a",{parentName:"p",href:"../enums/CensusTypeEnum"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusTypeEnum"))),(0,s.kt)("p",null,"The type of the census"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L21"},"api/election.ts:21")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"censusroot"},"censusRoot"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"censusRoot"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The root of the census"),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L26"},"api/election.ts:26")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"censusurl"},"censusURL"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"censusURL"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The URL of the census"),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L36"},"api/election.ts:36")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("p",null,"Max size of the census. How many voters the census can have."),(0,s.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L41"},"api/election.ts:41")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"postregistercensusroot"},"postRegisterCensusRoot"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"postRegisterCensusRoot"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The post register root of the census"),(0,s.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L31"},"api/election.ts:31")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d2ab4b32.4c2af76a.js b/assets/js/d2ab4b32.4c2af76a.js new file mode 100644 index 000000000..e7bd9c82b --- /dev/null +++ b/assets/js/d2ab4b32.4c2af76a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1935],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),c=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),u=c(n),m=i,k=u["".concat(s,".").concat(m)]||u[m]||p[m]||a;return n?r.createElement(k,l(l({ref:t},d),{},{components:n})):r.createElement(k,l({ref:t},d))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>c});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/enums/ElectionCreationSteps",id:"sdk/reference/enums/ElectionCreationSteps",title:"ElectionCreationSteps",description:"@vocdoni/sdk / Exports / ElectionCreationSteps",source:"@site/docs/sdk/reference/enums/ElectionCreationSteps.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/ElectionCreationSteps",permalink:"/sdk/reference/enums/ElectionCreationSteps",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CspProofType",permalink:"/sdk/reference/enums/CspProofType"},next:{title:"ElectionResultsTypeNames",permalink:"/sdk/reference/enums/ElectionResultsTypeNames"}},s={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"CENSUS_CREATED",id:"census_created",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"CREATING",id:"creating",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"DONE",id:"done",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"GENERATE_TX",id:"generate_tx",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"GET_ACCOUNT_DATA",id:"get_account_data",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"GET_CHAIN_DATA",id:"get_chain_data",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"GET_DATA_PIN",id:"get_data_pin",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"SIGN_TX",id:"sign_tx",level:3},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function p(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ElectionCreationSteps"),(0,i.kt)("h1",{id:"enumeration-electioncreationsteps"},"Enumeration: ElectionCreationSteps"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionCreationSteps#census_created"},"CENSUS","_","CREATED")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionCreationSteps#creating"},"CREATING")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"ElectionCreationSteps#done"},"DONE")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionCreationSteps#generate_tx"},"GENERATE","_","TX")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionCreationSteps#get_account_data"},"GET","_","ACCOUNT","_","DATA")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionCreationSteps#get_chain_data"},"GET","_","CHAIN","_","DATA")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionCreationSteps#get_data_pin"},"GET","_","DATA","_","PIN")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionCreationSteps#sign_tx"},"SIGN","_","TX"))),(0,i.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,i.kt)("h3",{id:"census_created"},"CENSUS","_","CREATED"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"CENSUS","_","CREATED")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"census-created"')),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L41"},"services/election.ts:41")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"creating"},"CREATING"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"CREATING")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"creating"')),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L46"},"services/election.ts:46")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"done"},"DONE"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"DONE")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"done"')),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L47"},"services/election.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generate_tx"},"GENERATE","_","TX"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"GENERATE","_","TX")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"generate-tx"')),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L44"},"services/election.ts:44")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"get_account_data"},"GET","_","ACCOUNT","_","DATA"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"GET","_","ACCOUNT","_","DATA")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"get-account-data"')),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L42"},"services/election.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"get_chain_data"},"GET","_","CHAIN","_","DATA"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"GET","_","CHAIN","_","DATA")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"get-chain-data"')),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L40"},"services/election.ts:40")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"get_data_pin"},"GET","_","DATA","_","PIN"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"GET","_","DATA","_","PIN")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"get-data-pin"')),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L43"},"services/election.ts:43")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sign_tx"},"SIGN","_","TX"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SIGN","_","TX")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"sign-tx"')),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/election.ts#L45"},"services/election.ts:45")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d2ab4b32.79364c5e.js b/assets/js/d2ab4b32.79364c5e.js deleted file mode 100644 index f45b85975..000000000 --- a/assets/js/d2ab4b32.79364c5e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1935],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=r.createContext({}),s=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=s(e.components);return r.createElement(c.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,c=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),u=s(n),m=i,k=u["".concat(c,".").concat(m)]||u[m]||p[m]||a;return n?r.createElement(k,l(l({ref:t},d),{},{components:n})):r.createElement(k,l({ref:t},d))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=u;var o={};for(var c in t)hasOwnProperty.call(t,c)&&(o[c]=t[c]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>s});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/enums/ElectionCreationSteps",id:"sdk/reference/enums/ElectionCreationSteps",title:"ElectionCreationSteps",description:"@vocdoni/sdk / Exports / ElectionCreationSteps",source:"@site/docs/sdk/reference/enums/ElectionCreationSteps.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/ElectionCreationSteps",permalink:"/sdk/reference/enums/ElectionCreationSteps",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CspProofType",permalink:"/sdk/reference/enums/CspProofType"},next:{title:"ElectionResultsTypeNames",permalink:"/sdk/reference/enums/ElectionResultsTypeNames"}},c={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"CENSUS_CREATED",id:"census_created",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"CREATING",id:"creating",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"DONE",id:"done",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"GENERATE_TX",id:"generate_tx",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"GET_ACCOUNT_DATA",id:"get_account_data",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"GET_CHAIN_DATA",id:"get_chain_data",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"GET_DATA_PIN",id:"get_data_pin",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"SIGN_TX",id:"sign_tx",level:3},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:s};function p(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ElectionCreationSteps"),(0,i.kt)("h1",{id:"enumeration-electioncreationsteps"},"Enumeration: ElectionCreationSteps"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionCreationSteps#census_created"},"CENSUS","_","CREATED")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionCreationSteps#creating"},"CREATING")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionCreationSteps#done"},"DONE")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionCreationSteps#generate_tx"},"GENERATE","_","TX")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionCreationSteps#get_account_data"},"GET","_","ACCOUNT","_","DATA")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionCreationSteps#get_chain_data"},"GET","_","CHAIN","_","DATA")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionCreationSteps#get_data_pin"},"GET","_","DATA","_","PIN")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionCreationSteps#sign_tx"},"SIGN","_","TX"))),(0,i.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,i.kt)("h3",{id:"census_created"},"CENSUS","_","CREATED"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"CENSUS","_","CREATED")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"census-created"')),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L41"},"services/election.ts:41")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"creating"},"CREATING"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"CREATING")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"creating"')),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L46"},"services/election.ts:46")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"done"},"DONE"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"DONE")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"done"')),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L47"},"services/election.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generate_tx"},"GENERATE","_","TX"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"GENERATE","_","TX")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"generate-tx"')),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L44"},"services/election.ts:44")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"get_account_data"},"GET","_","ACCOUNT","_","DATA"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"GET","_","ACCOUNT","_","DATA")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"get-account-data"')),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L42"},"services/election.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"get_chain_data"},"GET","_","CHAIN","_","DATA"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"GET","_","CHAIN","_","DATA")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"get-chain-data"')),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L40"},"services/election.ts:40")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"get_data_pin"},"GET","_","DATA","_","PIN"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"GET","_","DATA","_","PIN")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"get-data-pin"')),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L43"},"services/election.ts:43")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sign_tx"},"SIGN","_","TX"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SIGN","_","TX")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"sign-tx"')),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/election.ts#L45"},"services/election.ts:45")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d46fdf20.3f5270fc.js b/assets/js/d46fdf20.3f5270fc.js new file mode 100644 index 000000000..709417a4b --- /dev/null +++ b/assets/js/d46fdf20.3f5270fc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3044],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var d=r.createContext({}),p=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=p(e.components);return r.createElement(d.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),m=p(n),f=i,u=m["".concat(d,".").concat(f)]||m[f]||c[f]||a;return n?r.createElement(u,l(l({ref:t},s),{},{components:n})):r.createElement(u,l({ref:t},s))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=m;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>a,metadata:()=>o,toc:()=>p});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IBudgetElectionParametersInfo",id:"sdk/reference/interfaces/IBudgetElectionParametersInfo",title:"IBudgetElectionParametersInfo",description:"@vocdoni/sdk / Exports / IBudgetElectionParametersInfo",source:"@site/docs/sdk/reference/interfaces/IBudgetElectionParametersInfo.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IBudgetElectionParametersInfo",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersInfo",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IBlockTransactionsResponse",permalink:"/sdk/reference/interfaces/IBlockTransactionsResponse"},next:{title:"IBudgetElectionParametersWithBudget",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"census",id:"census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"endDate",id:"enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"forceFullBudget",id:"forcefullbudget",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"header",id:"header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"meta",id:"meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"minStep",id:"minstep",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"questions",id:"questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"startDate",id:"startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"voteType",id:"votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-15",level:4}],s={toc:p};function c(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IBudgetElectionParametersInfo"),(0,i.kt)("h1",{id:"interface-ibudgetelectionparametersinfo"},"Interface: IBudgetElectionParametersInfo"),(0,i.kt)("p",null,"Define election parameters."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"IElectionParameters"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"IBudgetElectionParametersInfo"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"IBudgetElectionParametersWithCensusWeight"},(0,i.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParametersWithCensusWeight"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"IBudgetElectionParametersWithBudget"},(0,i.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParametersWithBudget"))))),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IBudgetElectionParametersInfo#addsdkversion"},"addSDKVersion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IBudgetElectionParametersInfo#census"},"census")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IBudgetElectionParametersInfo#description"},"description")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IBudgetElectionParametersInfo#electiontype"},"electionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IBudgetElectionParametersInfo#enddate"},"endDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IBudgetElectionParametersInfo#forcefullbudget"},"forceFullBudget")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IBudgetElectionParametersInfo#header"},"header")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IBudgetElectionParametersInfo#maxcensussize"},"maxCensusSize")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IBudgetElectionParametersInfo#meta"},"meta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IBudgetElectionParametersInfo#minstep"},"minStep")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IBudgetElectionParametersInfo#questions"},"questions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IBudgetElectionParametersInfo#startdate"},"startDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IBudgetElectionParametersInfo#streamuri"},"streamUri")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IBudgetElectionParametersInfo#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IBudgetElectionParametersInfo#title"},"title")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IBudgetElectionParametersInfo#votetype"},"voteType"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"addSDKVersion"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Used to add the SDK version to the election metadata"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#addsdkversion"},"addSDKVersion")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L155"},"types/election/election.ts:155")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"census"},"census"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"census"),": ",(0,i.kt)("a",{parentName:"p",href:"../classes/Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census"))),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#census"},"census")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L129"},"types/election/election.ts:129")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Election description"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#description"},"description")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L114"},"types/election/election.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electiontype"},"electionType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"electionType"),": ",(0,i.kt)("a",{parentName:"p",href:"IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#electiontype"},"electionType")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L131"},"types/election/election.ts:131")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enddate"},"endDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"endDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#enddate"},"endDate")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L128"},"types/election/election.ts:128")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"forcefullbudget"},"forceFullBudget"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"forceFullBudget"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L9"},"types/election/budget.ts:9")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"header"},"header"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"header"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Election header image url."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#header"},"header")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L118"},"types/election/election.ts:118")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Is used to limit the number of votes that can be registered for an election. This feature helps to prevent any\npotential overflow of the blockchain when the number of votes goes beyond the maximum limit."),(0,i.kt)("p",null,"In order to create an election, the creator is required to set the MaxCensusSize parameter to a proper value.\nTypically, this value should be equal to the size of the census. If the MaxCensusSize parameter is set to 0, an\nerror will occur and the election cannot be created."),(0,i.kt)("p",null,"If the number of votes exceeds this limit, will throw ",(0,i.kt)("inlineCode",{parentName:"p"},"Max census size for the election is greater than allowed\nsize")," error."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#maxcensussize"},"maxCensusSize")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L145"},"types/election/election.ts:145")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("p",null,"Metadata (anything added by the election creator)"),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#meta"},"meta")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L126"},"types/election/election.ts:126")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"minstep"},"minStep"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"minStep"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L8"},"types/election/budget.ts:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"questions"},"questions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"questions"),": ",(0,i.kt)("a",{parentName:"p",href:"IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#questions"},"questions")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L132"},"types/election/election.ts:132")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"startdate"},"startDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"startDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#startdate"},"startDate")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L127"},"types/election/election.ts:127")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"streamuri"},"streamUri"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"streamUri"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Election stream Uri (ex: a video url)"),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#streamuri"},"streamUri")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L122"},"types/election/election.ts:122")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Is used to remove the secret identities of the voters once the process is done."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L150"},"types/election/election.ts:150")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Election title"),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#title"},"title")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L110"},"types/election/election.ts:110")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votetype"},"voteType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"voteType"),": ",(0,i.kt)("a",{parentName:"p",href:"IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#votetype"},"voteType")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L130"},"types/election/election.ts:130")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d46fdf20.84b8dcab.js b/assets/js/d46fdf20.84b8dcab.js deleted file mode 100644 index c92a5ad72..000000000 --- a/assets/js/d46fdf20.84b8dcab.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3044],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var d=r.createContext({}),s=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=s(e.components);return r.createElement(d.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,d=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),f=s(n),m=i,k=f["".concat(d,".").concat(m)]||f[m]||p[m]||a;return n?r.createElement(k,l(l({ref:t},c),{},{components:n})):r.createElement(k,l({ref:t},c))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=f;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>s});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IBudgetElectionParametersInfo",id:"sdk/reference/interfaces/IBudgetElectionParametersInfo",title:"IBudgetElectionParametersInfo",description:"@vocdoni/sdk / Exports / IBudgetElectionParametersInfo",source:"@site/docs/sdk/reference/interfaces/IBudgetElectionParametersInfo.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IBudgetElectionParametersInfo",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersInfo",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IBlockTransactionsResponse",permalink:"/sdk/reference/interfaces/IBlockTransactionsResponse"},next:{title:"IBudgetElectionParametersWithBudget",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget"}},d={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"census",id:"census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"endDate",id:"enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"forceFullBudget",id:"forcefullbudget",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"header",id:"header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"meta",id:"meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"minStep",id:"minstep",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"questions",id:"questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"startDate",id:"startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"voteType",id:"votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-15",level:4}],c={toc:s};function p(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IBudgetElectionParametersInfo"),(0,i.kt)("h1",{id:"interface-ibudgetelectionparametersinfo"},"Interface: IBudgetElectionParametersInfo"),(0,i.kt)("p",null,"Define election parameters."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"IBudgetElectionParametersInfo"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight"},(0,i.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParametersWithCensusWeight"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget"},(0,i.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParametersWithBudget"))))),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#addsdkversion"},"addSDKVersion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#census"},"census")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#description"},"description")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#electiontype"},"electionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#enddate"},"endDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#forcefullbudget"},"forceFullBudget")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#header"},"header")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#maxcensussize"},"maxCensusSize")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#meta"},"meta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#minstep"},"minStep")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#questions"},"questions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#startdate"},"startDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#streamuri"},"streamUri")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#title"},"title")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#votetype"},"voteType"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"addSDKVersion"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Used to add the SDK version to the election metadata"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#addsdkversion"},"addSDKVersion")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L155"},"types/election/election.ts:155")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"census"},"census"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"census"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census"))),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#census"},"census")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L129"},"types/election/election.ts:129")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Election description"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#description"},"description")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L114"},"types/election/election.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electiontype"},"electionType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"electionType"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#electiontype"},"electionType")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L131"},"types/election/election.ts:131")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enddate"},"endDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"endDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#enddate"},"endDate")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L128"},"types/election/election.ts:128")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"forcefullbudget"},"forceFullBudget"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"forceFullBudget"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L9"},"types/election/budget.ts:9")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"header"},"header"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"header"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Election header image url."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#header"},"header")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L118"},"types/election/election.ts:118")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Is used to limit the number of votes that can be registered for an election. This feature helps to prevent any\npotential overflow of the blockchain when the number of votes goes beyond the maximum limit."),(0,i.kt)("p",null,"In order to create an election, the creator is required to set the MaxCensusSize parameter to a proper value.\nTypically, this value should be equal to the size of the census. If the MaxCensusSize parameter is set to 0, an\nerror will occur and the election cannot be created."),(0,i.kt)("p",null,"If the number of votes exceeds this limit, will throw ",(0,i.kt)("inlineCode",{parentName:"p"},"Max census size for the election is greater than allowed\nsize")," error."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#maxcensussize"},"maxCensusSize")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L145"},"types/election/election.ts:145")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("p",null,"Metadata (anything added by the election creator)"),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#meta"},"meta")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L126"},"types/election/election.ts:126")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"minstep"},"minStep"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"minStep"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L8"},"types/election/budget.ts:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"questions"},"questions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"questions"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#questions"},"questions")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L132"},"types/election/election.ts:132")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"startdate"},"startDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"startDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#startdate"},"startDate")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L127"},"types/election/election.ts:127")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"streamuri"},"streamUri"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"streamUri"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Election stream Uri (ex: a video url)"),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#streamuri"},"streamUri")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L122"},"types/election/election.ts:122")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Is used to remove the secret identities of the voters once the process is done."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L150"},"types/election/election.ts:150")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Election title"),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#title"},"title")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L110"},"types/election/election.ts:110")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votetype"},"voteType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"voteType"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#votetype"},"voteType")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L130"},"types/election/election.ts:130")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d4ce7faf.1263d19a.js b/assets/js/d4ce7faf.1263d19a.js new file mode 100644 index 000000000..dbfcbcbe0 --- /dev/null +++ b/assets/js/d4ce7faf.1263d19a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3754],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>c});var i=n(67294);function l(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function r(e){for(var t=1;t=0||(l[n]=e[n]);return l}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(l[n]=e[n])}return l}var s=i.createContext({}),p=function(e){var t=i.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},o=function(e){var t=p(e.components);return i.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,l=e.mdxType,a=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),k=p(n),c=l,m=k["".concat(s,".").concat(c)]||k[c]||u[c]||a;return n?i.createElement(m,r(r({ref:t},o),{},{components:n})):i.createElement(m,r({ref:t},o))}));function c(e,t){var n=arguments,l=t&&t.mdxType;if("string"==typeof e||l){var a=n.length,r=new Array(a);r[0]=k;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d.mdxType="string"==typeof e?e:l,r[1]=d;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>r,default:()=>u,frontMatter:()=>a,metadata:()=>d,toc:()=>p});var i=n(87462),l=(n(67294),n(3905));const a={},r=void 0,d={unversionedId:"sdk/reference/classes/PublishedElection",id:"sdk/reference/classes/PublishedElection",title:"PublishedElection",description:"@vocdoni/sdk / Exports / PublishedElection",source:"@site/docs/sdk/reference/classes/PublishedElection.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/PublishedElection",permalink:"/sdk/reference/classes/PublishedElection",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"PublishedCensus",permalink:"/sdk/reference/classes/PublishedCensus"},next:{title:"Service",permalink:"/sdk/reference/classes/Service"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_addSDKVersion",id:"_addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_census",id:"_census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_chainId",id:"_chainid",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"_creationTime",id:"_creationtime",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"_description",id:"_description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"_electionType",id:"_electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"_endDate",id:"_enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"_finalResults",id:"_finalresults",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"_fromArchive",id:"_fromarchive",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"_header",id:"_header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"_id",id:"_id",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"_manuallyEnded",id:"_manuallyended",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"_maxCensusSize",id:"_maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"_meta",id:"_meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"_metadataURL",id:"_metadataurl",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"_organizationId",id:"_organizationid",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"_questions",id:"_questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"_raw",id:"_raw",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"_results",id:"_results",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"_resultsType",id:"_resultstype",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"_startDate",id:"_startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"_status",id:"_status",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"_streamUri",id:"_streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"_temporarySecretIdentity",id:"_temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"_title",id:"_title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"_voteCount",id:"_votecount",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"_voteType",id:"_votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"census",id:"census",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"chainId",id:"chainid",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"creationTime",id:"creationtime",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"description",id:"description",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"endDate",id:"enddate",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"finalResults",id:"finalresults",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"fromArchive",id:"fromarchive",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"header",id:"header",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"id",id:"id",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"isValid",id:"isvalid",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"manuallyEnded",id:"manuallyended",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Overrides",id:"overrides-6",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"meta",id:"meta",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"metadataURL",id:"metadataurl",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"organizationId",id:"organizationid",level:3},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"questions",id:"questions",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Overrides",id:"overrides-7",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"raw",id:"raw",level:3},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"results",id:"results",level:3},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"resultsType",id:"resultstype",level:3},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"startDate",id:"startdate",level:3},{value:"Returns",id:"returns-22",level:4},{value:"Overrides",id:"overrides-8",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"status",id:"status",level:3},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Returns",id:"returns-24",level:4},{value:"Overrides",id:"overrides-9",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Returns",id:"returns-25",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"title",id:"title",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Overrides",id:"overrides-10",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"voteCount",id:"votecount",level:3},{value:"Returns",id:"returns-27",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"voteType",id:"votetype",level:3},{value:"Returns",id:"returns-28",level:4},{value:"Overrides",id:"overrides-11",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"Methods",id:"methods-1",level:2},{value:"checkVote",id:"checkvote",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"build",id:"build",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"checkVote",id:"checkvote-1",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Defined in",id:"defined-in-59",level:4},{value:"from",id:"from",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-60",level:4},{value:"getStatus",id:"getstatus",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-34",level:4},{value:"Defined in",id:"defined-in-61",level:4}],o={toc:p};function u(e){let{components:t,...n}=e;return(0,l.kt)("wrapper",(0,i.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,l.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / PublishedElection"),(0,l.kt)("h1",{id:"class-publishedelection"},"Class: PublishedElection"),(0,l.kt)("p",null,"Represents a published election"),(0,l.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("a",{parentName:"p",href:"Election"},(0,l.kt)("inlineCode",{parentName:"a"},"Election"))),(0,l.kt)("p",{parentName:"li"},"\u21b3 ",(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"PublishedElection"))),(0,l.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,l.kt)("a",{parentName:"p",href:"ArchivedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"ArchivedElection"))))),(0,l.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,l.kt)("h3",{id:"constructors"},"Constructors"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#constructor"},"constructor"))),(0,l.kt)("h3",{id:"properties"},"Properties"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_addsdkversion"},"_","addSDKVersion")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_census"},"_","census")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_chainid"},"_","chainId")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_creationtime"},"_","creationTime")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_description"},"_","description")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_electiontype"},"_","electionType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_enddate"},"_","endDate")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_finalresults"},"_","finalResults")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_fromarchive"},"_","fromArchive")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_header"},"_","header")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_id"},"_","id")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_manuallyended"},"_","manuallyEnded")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_maxcensussize"},"_","maxCensusSize")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_meta"},"_","meta")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_metadataurl"},"_","metadataURL")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_organizationid"},"_","organizationId")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_questions"},"_","questions")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_raw"},"_","raw")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_results"},"_","results")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_resultstype"},"_","resultsType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_startdate"},"_","startDate")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_status"},"_","status")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_streamuri"},"_","streamUri")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_temporarysecretidentity"},"_","temporarySecretIdentity")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_title"},"_","title")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_votecount"},"_","voteCount")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_votetype"},"_","voteType"))),(0,l.kt)("h3",{id:"accessors"},"Accessors"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#addsdkversion"},"addSDKVersion")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#census"},"census")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#chainid"},"chainId")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#creationtime"},"creationTime")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#description"},"description")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#electiontype"},"electionType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#enddate"},"endDate")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#finalresults"},"finalResults")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#fromarchive"},"fromArchive")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#header"},"header")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#id"},"id")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#isvalid"},"isValid")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#manuallyended"},"manuallyEnded")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#maxcensussize"},"maxCensusSize")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#meta"},"meta")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#metadataurl"},"metadataURL")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#organizationid"},"organizationId")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#questions"},"questions")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#raw"},"raw")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#results"},"results")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#resultstype"},"resultsType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#startdate"},"startDate")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#status"},"status")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#streamuri"},"streamUri")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#temporarysecretidentity"},"temporarySecretIdentity")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#title"},"title")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#votecount"},"voteCount")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#votetype"},"voteType"))),(0,l.kt)("h3",{id:"methods"},"Methods"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#checkvote"},"checkVote")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#get"},"get")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#build"},"build")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#checkvote-1"},"checkVote")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#from"},"from")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"PublishedElection#getstatus"},"getStatus"))),(0,l.kt)("h2",{id:"constructors-1"},"Constructors"),(0,l.kt)("h3",{id:"constructor"},"constructor"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"new PublishedElection"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"PublishedElection"))),(0,l.kt)("p",null,"Constructs a published election"),(0,l.kt)("h4",{id:"parameters"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"params")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"../interfaces/IPublishedElectionParameters"},(0,l.kt)("inlineCode",{parentName:"a"},"IPublishedElectionParameters"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Election parameters")))),(0,l.kt)("h4",{id:"returns"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"PublishedElection"))),(0,l.kt)("h4",{id:"overrides"},"Overrides"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"Election#constructor"},"constructor")),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L65"},"types/election/published.ts:65")),(0,l.kt)("h2",{id:"properties-1"},"Properties"),(0,l.kt)("h3",{id:"_addsdkversion"},"_","addSDKVersion"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","addSDKVersion"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_addsdkversion"},"_addSDKVersion")),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L175"},"types/election/election.ts:175")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_census"},"_","census"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","census"),": ",(0,l.kt)("a",{parentName:"p",href:"Census"},(0,l.kt)("inlineCode",{parentName:"a"},"Census"))),(0,l.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_census"},"_census")),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L172"},"types/election/election.ts:172")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_chainid"},"_","chainId"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","chainId"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L53"},"types/election/published.ts:53")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_creationtime"},"_","creationTime"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","creationTime"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L55"},"types/election/published.ts:55")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_description"},"_","description"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","description"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_description"},"_description")),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L163"},"types/election/election.ts:163")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_electiontype"},"_","electionType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","electionType"),": ",(0,l.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,l.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,l.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_electiontype"},"_electionType")),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L169"},"types/election/election.ts:169")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_enddate"},"_","endDate"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","endDate"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_enddate"},"_endDate")),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L168"},"types/election/election.ts:168")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_finalresults"},"_","finalResults"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","finalResults"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L50"},"types/election/published.ts:50")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_fromarchive"},"_","fromArchive"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","fromArchive"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L52"},"types/election/published.ts:52")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_header"},"_","header"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","header"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_header"},"_header")),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L164"},"types/election/election.ts:164")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_id"},"_","id"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","id"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L46"},"types/election/published.ts:46")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_manuallyended"},"_","manuallyEnded"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","manuallyEnded"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L51"},"types/election/published.ts:51")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_maxcensussize"},"_","maxCensusSize"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","maxCensusSize"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_maxcensussize"},"_maxCensusSize")),(0,l.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L173"},"types/election/election.ts:173")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_meta"},"_","meta"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","meta"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_meta"},"_meta")),(0,l.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L166"},"types/election/election.ts:166")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_metadataurl"},"_","metadataURL"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","metadataURL"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L56"},"types/election/published.ts:56")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_organizationid"},"_","organizationId"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","organizationId"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L47"},"types/election/published.ts:47")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_questions"},"_","questions"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","questions"),": ",(0,l.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,l.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,l.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_questions"},"_questions")),(0,l.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L171"},"types/election/election.ts:171")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_raw"},"_","raw"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","raw"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"object")),(0,l.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L58"},"types/election/published.ts:58")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_results"},"_","results"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","results"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string"),"[][]"),(0,l.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L54"},"types/election/published.ts:54")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_resultstype"},"_","resultsType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","resultsType"),": ",(0,l.kt)("a",{parentName:"p",href:"../modules#electionresultstype"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionResultsType"))),(0,l.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L57"},"types/election/published.ts:57")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_startdate"},"_","startDate"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","startDate"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_startdate"},"_startDate")),(0,l.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L167"},"types/election/election.ts:167")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_status"},"_","status"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","status"),": ",(0,l.kt)("a",{parentName:"p",href:"../enums/ElectionStatus"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,l.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L48"},"types/election/published.ts:48")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_streamuri"},"_","streamUri"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","streamUri"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_streamuri"},"_streamUri")),(0,l.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L165"},"types/election/election.ts:165")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_temporarysecretidentity"},"_","temporarySecretIdentity"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","temporarySecretIdentity"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_temporarysecretidentity"},"_temporarySecretIdentity")),(0,l.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L174"},"types/election/election.ts:174")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_title"},"_","title"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","title"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_title"},"_title")),(0,l.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L162"},"types/election/election.ts:162")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_votecount"},"_","voteCount"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","voteCount"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L49"},"types/election/published.ts:49")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_votetype"},"_","voteType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","voteType"),": ",(0,l.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,l.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,l.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_votetype"},"_voteType")),(0,l.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L170"},"types/election/election.ts:170")),(0,l.kt)("h2",{id:"accessors-1"},"Accessors"),(0,l.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"addSDKVersion"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-1"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,l.kt)("p",null,"Election.addSDKVersion"),(0,l.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L262"},"types/election/election.ts:262")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"census"},"census"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"census"),"(): ",(0,l.kt)("a",{parentName:"p",href:"PublishedCensus"},(0,l.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))),(0,l.kt)("h4",{id:"returns-2"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedCensus"},(0,l.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))),(0,l.kt)("h4",{id:"overrides-1"},"Overrides"),(0,l.kt)("p",null,"Election.census"),(0,l.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L179"},"types/election/published.ts:179")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"chainid"},"chainId"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"chainId"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-3"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L219"},"types/election/published.ts:219")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"creationtime"},"creationTime"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"creationTime"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"returns-4"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L223"},"types/election/published.ts:223")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"description"},"description"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"description"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"returns-5"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"overrides-2"},"Overrides"),(0,l.kt)("p",null,"Election.description"),(0,l.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L147"},"types/election/published.ts:147")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"electiontype"},"electionType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"electionType"),"(): ",(0,l.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,l.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,l.kt)("h4",{id:"returns-6"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,l.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,l.kt)("h4",{id:"overrides-3"},"Overrides"),(0,l.kt)("p",null,"Election.electionType"),(0,l.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L167"},"types/election/published.ts:167")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"enddate"},"endDate"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"endDate"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"returns-7"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"overrides-4"},"Overrides"),(0,l.kt)("p",null,"Election.endDate"),(0,l.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L163"},"types/election/published.ts:163")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"finalresults"},"finalResults"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"finalResults"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-8"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L203"},"types/election/published.ts:203")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"fromarchive"},"fromArchive"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"fromArchive"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-9"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L215"},"types/election/published.ts:215")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"header"},"header"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"header"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-10"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"overrides-5"},"Overrides"),(0,l.kt)("p",null,"Election.header"),(0,l.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L151"},"types/election/published.ts:151")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"id"},"id"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"id"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-11"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L187"},"types/election/published.ts:187")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isvalid"},"isValid"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"isValid"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-12"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L239"},"types/election/published.ts:239")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"manuallyended"},"manuallyEnded"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"manuallyEnded"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-13"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L211"},"types/election/published.ts:211")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"maxCensusSize"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"returns-14"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"overrides-6"},"Overrides"),(0,l.kt)("p",null,"Election.maxCensusSize"),(0,l.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L183"},"types/election/published.ts:183")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"meta"},"meta"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"meta"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("h4",{id:"returns-15"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,l.kt)("p",null,"Election.meta"),(0,l.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L226"},"types/election/election.ts:226")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"metadataurl"},"metadataURL"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"metadataURL"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-16"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L227"},"types/election/published.ts:227")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"organizationid"},"organizationId"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"organizationId"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-17"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L191"},"types/election/published.ts:191")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"questions"},"questions"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"questions"),"(): ",(0,l.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,l.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,l.kt)("h4",{id:"returns-18"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,l.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,l.kt)("h4",{id:"overrides-7"},"Overrides"),(0,l.kt)("p",null,"Election.questions"),(0,l.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L175"},"types/election/published.ts:175")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"raw"},"raw"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"raw"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"object")),(0,l.kt)("h4",{id:"returns-19"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"object")),(0,l.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L235"},"types/election/published.ts:235")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"results"},"results"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"results"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string"),"[][]"),(0,l.kt)("h4",{id:"returns-20"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string"),"[][]"),(0,l.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L207"},"types/election/published.ts:207")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"resultstype"},"resultsType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"resultsType"),"(): ",(0,l.kt)("a",{parentName:"p",href:"../modules#electionresultstype"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionResultsType"))),(0,l.kt)("h4",{id:"returns-21"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"../modules#electionresultstype"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionResultsType"))),(0,l.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L231"},"types/election/published.ts:231")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"startdate"},"startDate"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"startDate"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"returns-22"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"overrides-8"},"Overrides"),(0,l.kt)("p",null,"Election.startDate"),(0,l.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L159"},"types/election/published.ts:159")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"status"},"status"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"status"),"(): ",(0,l.kt)("a",{parentName:"p",href:"../enums/ElectionStatus"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,l.kt)("h4",{id:"returns-23"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"../enums/ElectionStatus"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,l.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L195"},"types/election/published.ts:195")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"streamuri"},"streamUri"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"streamUri"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-24"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"overrides-9"},"Overrides"),(0,l.kt)("p",null,"Election.streamUri"),(0,l.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L155"},"types/election/published.ts:155")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-25"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,l.kt)("p",null,"Election.temporarySecretIdentity"),(0,l.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L258"},"types/election/election.ts:258")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"title"},"title"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"title"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"returns-26"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"overrides-10"},"Overrides"),(0,l.kt)("p",null,"Election.title"),(0,l.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L143"},"types/election/published.ts:143")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"votecount"},"voteCount"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"voteCount"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"returns-27"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L199"},"types/election/published.ts:199")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"votetype"},"voteType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"voteType"),"(): ",(0,l.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,l.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,l.kt)("h4",{id:"returns-28"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,l.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,l.kt)("h4",{id:"overrides-11"},"Overrides"),(0,l.kt)("p",null,"Election.voteType"),(0,l.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L171"},"types/election/published.ts:171")),(0,l.kt)("h2",{id:"methods-1"},"Methods"),(0,l.kt)("h3",{id:"checkvote"},"checkVote"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"checkVote"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"vote"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"parameters-1"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"vote")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"Vote"},(0,l.kt)("inlineCode",{parentName:"a"},"Vote")))))),(0,l.kt)("h4",{id:"returns-29"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L113"},"types/election/published.ts:113")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"get"},"get"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"get"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"dot"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("h4",{id:"parameters-2"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"dot")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))))),(0,l.kt)("h4",{id:"returns-30"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"Election#get"},"get")),(0,l.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L266"},"types/election/election.ts:266")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"build"},"build"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"build"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"PublishedElection"))),(0,l.kt)("p",null,"Returns a published election object"),(0,l.kt)("h4",{id:"parameters-3"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"params")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"../interfaces/IPublishedElectionParameters"},(0,l.kt)("inlineCode",{parentName:"a"},"IPublishedElectionParameters"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Published election parameters")))),(0,l.kt)("h4",{id:"returns-31"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"PublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"PublishedElection"))),(0,l.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L100"},"types/election/published.ts:100")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"checkvote-1"},"checkVote"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"checkVote"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"vote"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"voteType"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"parameters-4"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"vote")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"Vote"},(0,l.kt)("inlineCode",{parentName:"a"},"Vote")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"voteType")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"../interfaces/IVoteType"},(0,l.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,l.kt)("h4",{id:"returns-32"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L127"},"types/election/published.ts:127")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"from"},"from"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"from"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,l.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,l.kt)("p",null,"Returns an unpublished election object"),(0,l.kt)("h4",{id:"parameters-5"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"params")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"../interfaces/IElectionParameters"},(0,l.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Unpublished Election parameters")))),(0,l.kt)("h4",{id:"returns-33"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,l.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"Election#from"},"from")),(0,l.kt)("h4",{id:"defined-in-60"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L206"},"types/election/election.ts:206")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getstatus"},"getStatus"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"getStatus"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"status"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"startDate"),"): ",(0,l.kt)("a",{parentName:"p",href:"../enums/ElectionStatus"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,l.kt)("h4",{id:"parameters-6"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"status")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"../modules#allelectionstatus"},(0,l.kt)("inlineCode",{parentName:"a"},"AllElectionStatus")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"startDate")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,l.kt)("h4",{id:"returns-34"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"../enums/ElectionStatus"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,l.kt)("h4",{id:"defined-in-61"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L104"},"types/election/published.ts:104")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d4ce7faf.2a7ffec3.js b/assets/js/d4ce7faf.2a7ffec3.js deleted file mode 100644 index 6c170ea38..000000000 --- a/assets/js/d4ce7faf.2a7ffec3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3754],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>u});var i=n(67294);function l(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function r(e){for(var t=1;t=0||(l[n]=e[n]);return l}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(l[n]=e[n])}return l}var s=i.createContext({}),p=function(e){var t=i.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},o=function(e){var t=p(e.components);return i.createElement(s.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},c=i.forwardRef((function(e,t){var n=e.components,l=e.mdxType,a=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),c=p(n),u=l,m=c["".concat(s,".").concat(u)]||c[u]||k[u]||a;return n?i.createElement(m,r(r({ref:t},o),{},{components:n})):i.createElement(m,r({ref:t},o))}));function u(e,t){var n=arguments,l=t&&t.mdxType;if("string"==typeof e||l){var a=n.length,r=new Array(a);r[0]=c;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d.mdxType="string"==typeof e?e:l,r[1]=d;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>r,default:()=>k,frontMatter:()=>a,metadata:()=>d,toc:()=>p});var i=n(87462),l=(n(67294),n(3905));const a={},r=void 0,d={unversionedId:"sdk/reference/classes/PublishedElection",id:"sdk/reference/classes/PublishedElection",title:"PublishedElection",description:"@vocdoni/sdk / Exports / PublishedElection",source:"@site/docs/sdk/reference/classes/PublishedElection.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/PublishedElection",permalink:"/sdk/reference/classes/PublishedElection",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"PublishedCensus",permalink:"/sdk/reference/classes/PublishedCensus"},next:{title:"Service",permalink:"/sdk/reference/classes/Service"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_addSDKVersion",id:"_addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_census",id:"_census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_chainId",id:"_chainid",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"_creationTime",id:"_creationtime",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"_description",id:"_description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"_electionType",id:"_electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"_endDate",id:"_enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"_finalResults",id:"_finalresults",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"_fromArchive",id:"_fromarchive",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"_header",id:"_header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"_id",id:"_id",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"_manuallyEnded",id:"_manuallyended",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"_maxCensusSize",id:"_maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"_meta",id:"_meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"_metadataURL",id:"_metadataurl",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"_organizationId",id:"_organizationid",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"_questions",id:"_questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"_raw",id:"_raw",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"_results",id:"_results",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"_resultsType",id:"_resultstype",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"_startDate",id:"_startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"_status",id:"_status",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"_streamUri",id:"_streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"_temporarySecretIdentity",id:"_temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"_title",id:"_title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"_voteCount",id:"_votecount",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"_voteType",id:"_votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"census",id:"census",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"chainId",id:"chainid",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"creationTime",id:"creationtime",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"description",id:"description",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"endDate",id:"enddate",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"finalResults",id:"finalresults",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"fromArchive",id:"fromarchive",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"header",id:"header",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"id",id:"id",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"isValid",id:"isvalid",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"manuallyEnded",id:"manuallyended",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Overrides",id:"overrides-6",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"meta",id:"meta",level:3},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"metadataURL",id:"metadataurl",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"organizationId",id:"organizationid",level:3},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"questions",id:"questions",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Overrides",id:"overrides-7",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"raw",id:"raw",level:3},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"results",id:"results",level:3},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"resultsType",id:"resultstype",level:3},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"startDate",id:"startdate",level:3},{value:"Returns",id:"returns-22",level:4},{value:"Overrides",id:"overrides-8",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"status",id:"status",level:3},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Returns",id:"returns-24",level:4},{value:"Overrides",id:"overrides-9",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Returns",id:"returns-25",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"title",id:"title",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Overrides",id:"overrides-10",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"voteCount",id:"votecount",level:3},{value:"Returns",id:"returns-27",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"voteType",id:"votetype",level:3},{value:"Returns",id:"returns-28",level:4},{value:"Overrides",id:"overrides-11",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"Methods",id:"methods-1",level:2},{value:"checkVote",id:"checkvote",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"build",id:"build",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"checkVote",id:"checkvote-1",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Defined in",id:"defined-in-59",level:4},{value:"from",id:"from",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-60",level:4},{value:"getStatus",id:"getstatus",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-34",level:4},{value:"Defined in",id:"defined-in-61",level:4}],o={toc:p};function k(e){let{components:t,...n}=e;return(0,l.kt)("wrapper",(0,i.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / PublishedElection"),(0,l.kt)("h1",{id:"class-publishedelection"},"Class: PublishedElection"),(0,l.kt)("p",null,"Represents a published election"),(0,l.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},(0,l.kt)("inlineCode",{parentName:"a"},"Election"))),(0,l.kt)("p",{parentName:"li"},"\u21b3 ",(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"PublishedElection"))),(0,l.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ArchivedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"ArchivedElection"))))),(0,l.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,l.kt)("h3",{id:"constructors"},"Constructors"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#constructor"},"constructor"))),(0,l.kt)("h3",{id:"properties"},"Properties"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_addsdkversion"},"_","addSDKVersion")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_census"},"_","census")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_chainid"},"_","chainId")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_creationtime"},"_","creationTime")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_description"},"_","description")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_electiontype"},"_","electionType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_enddate"},"_","endDate")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_finalresults"},"_","finalResults")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_fromarchive"},"_","fromArchive")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_header"},"_","header")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_id"},"_","id")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_manuallyended"},"_","manuallyEnded")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_maxcensussize"},"_","maxCensusSize")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_meta"},"_","meta")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_metadataurl"},"_","metadataURL")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_organizationid"},"_","organizationId")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_questions"},"_","questions")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_raw"},"_","raw")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_results"},"_","results")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_resultstype"},"_","resultsType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_startdate"},"_","startDate")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_status"},"_","status")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_streamuri"},"_","streamUri")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_temporarysecretidentity"},"_","temporarySecretIdentity")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_title"},"_","title")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_votecount"},"_","voteCount")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#_votetype"},"_","voteType"))),(0,l.kt)("h3",{id:"accessors"},"Accessors"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#addsdkversion"},"addSDKVersion")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#census"},"census")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#chainid"},"chainId")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#creationtime"},"creationTime")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#description"},"description")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#electiontype"},"electionType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#enddate"},"endDate")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#finalresults"},"finalResults")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#fromarchive"},"fromArchive")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#header"},"header")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#id"},"id")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#isvalid"},"isValid")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#manuallyended"},"manuallyEnded")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#maxcensussize"},"maxCensusSize")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#meta"},"meta")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#metadataurl"},"metadataURL")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#organizationid"},"organizationId")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#questions"},"questions")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#raw"},"raw")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#results"},"results")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#resultstype"},"resultsType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#startdate"},"startDate")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#status"},"status")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#streamuri"},"streamUri")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#temporarysecretidentity"},"temporarySecretIdentity")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#title"},"title")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#votecount"},"voteCount")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#votetype"},"voteType"))),(0,l.kt)("h3",{id:"methods"},"Methods"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#checkvote"},"checkVote")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#get"},"get")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#build"},"build")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#checkvote-1"},"checkVote")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#from"},"from")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/sdk/reference/classes/PublishedElection#getstatus"},"getStatus"))),(0,l.kt)("h2",{id:"constructors-1"},"Constructors"),(0,l.kt)("h3",{id:"constructor"},"constructor"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"new PublishedElection"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"PublishedElection"))),(0,l.kt)("p",null,"Constructs a published election"),(0,l.kt)("h4",{id:"parameters"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"params")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IPublishedElectionParameters"},(0,l.kt)("inlineCode",{parentName:"a"},"IPublishedElectionParameters"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Election parameters")))),(0,l.kt)("h4",{id:"returns"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"PublishedElection"))),(0,l.kt)("h4",{id:"overrides"},"Overrides"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#constructor"},"constructor")),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L65"},"types/election/published.ts:65")),(0,l.kt)("h2",{id:"properties-1"},"Properties"),(0,l.kt)("h3",{id:"_addsdkversion"},"_","addSDKVersion"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","addSDKVersion"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_addsdkversion"},"_addSDKVersion")),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L175"},"types/election/election.ts:175")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_census"},"_","census"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","census"),": ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,l.kt)("inlineCode",{parentName:"a"},"Census"))),(0,l.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_census"},"_census")),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L172"},"types/election/election.ts:172")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_chainid"},"_","chainId"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","chainId"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L53"},"types/election/published.ts:53")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_creationtime"},"_","creationTime"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","creationTime"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L55"},"types/election/published.ts:55")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_description"},"_","description"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","description"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_description"},"_description")),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L163"},"types/election/election.ts:163")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_electiontype"},"_","electionType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","electionType"),": ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,l.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,l.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_electiontype"},"_electionType")),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L169"},"types/election/election.ts:169")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_enddate"},"_","endDate"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","endDate"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_enddate"},"_endDate")),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L168"},"types/election/election.ts:168")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_finalresults"},"_","finalResults"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","finalResults"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L50"},"types/election/published.ts:50")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_fromarchive"},"_","fromArchive"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","fromArchive"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L52"},"types/election/published.ts:52")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_header"},"_","header"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","header"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_header"},"_header")),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L164"},"types/election/election.ts:164")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_id"},"_","id"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","id"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L46"},"types/election/published.ts:46")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_manuallyended"},"_","manuallyEnded"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","manuallyEnded"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L51"},"types/election/published.ts:51")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_maxcensussize"},"_","maxCensusSize"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","maxCensusSize"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_maxcensussize"},"_maxCensusSize")),(0,l.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L173"},"types/election/election.ts:173")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_meta"},"_","meta"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","meta"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_meta"},"_meta")),(0,l.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L166"},"types/election/election.ts:166")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_metadataurl"},"_","metadataURL"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","metadataURL"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L56"},"types/election/published.ts:56")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_organizationid"},"_","organizationId"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","organizationId"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L47"},"types/election/published.ts:47")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_questions"},"_","questions"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","questions"),": ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,l.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,l.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_questions"},"_questions")),(0,l.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L171"},"types/election/election.ts:171")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_raw"},"_","raw"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","raw"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"object")),(0,l.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L58"},"types/election/published.ts:58")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_results"},"_","results"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","results"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string"),"[][]"),(0,l.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L54"},"types/election/published.ts:54")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_resultstype"},"_","resultsType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","resultsType"),": ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/modules#electionresultstype"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionResultsType"))),(0,l.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L57"},"types/election/published.ts:57")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_startdate"},"_","startDate"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","startDate"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_startdate"},"_startDate")),(0,l.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L167"},"types/election/election.ts:167")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_status"},"_","status"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","status"),": ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,l.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L48"},"types/election/published.ts:48")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_streamuri"},"_","streamUri"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","streamUri"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_streamuri"},"_streamUri")),(0,l.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L165"},"types/election/election.ts:165")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_temporarysecretidentity"},"_","temporarySecretIdentity"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","temporarySecretIdentity"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_temporarysecretidentity"},"_temporarySecretIdentity")),(0,l.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L174"},"types/election/election.ts:174")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_title"},"_","title"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","title"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_title"},"_title")),(0,l.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L162"},"types/election/election.ts:162")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_votecount"},"_","voteCount"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,l.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,l.kt)("strong",{parentName:"p"},"_","voteCount"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L49"},"types/election/published.ts:49")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"_votetype"},"_","voteType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,l.kt)("strong",{parentName:"p"},"_","voteType"),": ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,l.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,l.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_votetype"},"_voteType")),(0,l.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L170"},"types/election/election.ts:170")),(0,l.kt)("h2",{id:"accessors-1"},"Accessors"),(0,l.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"addSDKVersion"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-1"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,l.kt)("p",null,"Election.addSDKVersion"),(0,l.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L262"},"types/election/election.ts:262")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"census"},"census"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"census"),"(): ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},(0,l.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))),(0,l.kt)("h4",{id:"returns-2"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedCensus"},(0,l.kt)("inlineCode",{parentName:"a"},"PublishedCensus"))),(0,l.kt)("h4",{id:"overrides-1"},"Overrides"),(0,l.kt)("p",null,"Election.census"),(0,l.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L179"},"types/election/published.ts:179")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"chainid"},"chainId"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"chainId"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-3"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L219"},"types/election/published.ts:219")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"creationtime"},"creationTime"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"creationTime"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"returns-4"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L223"},"types/election/published.ts:223")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"description"},"description"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"description"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"returns-5"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"overrides-2"},"Overrides"),(0,l.kt)("p",null,"Election.description"),(0,l.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L147"},"types/election/published.ts:147")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"electiontype"},"electionType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"electionType"),"(): ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,l.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,l.kt)("h4",{id:"returns-6"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,l.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,l.kt)("h4",{id:"overrides-3"},"Overrides"),(0,l.kt)("p",null,"Election.electionType"),(0,l.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L167"},"types/election/published.ts:167")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"enddate"},"endDate"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"endDate"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"returns-7"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"overrides-4"},"Overrides"),(0,l.kt)("p",null,"Election.endDate"),(0,l.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L163"},"types/election/published.ts:163")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"finalresults"},"finalResults"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"finalResults"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-8"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L203"},"types/election/published.ts:203")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"fromarchive"},"fromArchive"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"fromArchive"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-9"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L215"},"types/election/published.ts:215")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"header"},"header"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"header"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-10"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"overrides-5"},"Overrides"),(0,l.kt)("p",null,"Election.header"),(0,l.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L151"},"types/election/published.ts:151")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"id"},"id"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"id"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-11"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L187"},"types/election/published.ts:187")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isvalid"},"isValid"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"isValid"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-12"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L239"},"types/election/published.ts:239")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"manuallyended"},"manuallyEnded"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"manuallyEnded"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-13"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L211"},"types/election/published.ts:211")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"maxCensusSize"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"returns-14"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"overrides-6"},"Overrides"),(0,l.kt)("p",null,"Election.maxCensusSize"),(0,l.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L183"},"types/election/published.ts:183")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"meta"},"meta"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"meta"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("h4",{id:"returns-15"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,l.kt)("p",null,"Election.meta"),(0,l.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L226"},"types/election/election.ts:226")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"metadataurl"},"metadataURL"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"metadataURL"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-16"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L227"},"types/election/published.ts:227")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"organizationid"},"organizationId"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"organizationId"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-17"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L191"},"types/election/published.ts:191")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"questions"},"questions"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"questions"),"(): ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,l.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,l.kt)("h4",{id:"returns-18"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,l.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,l.kt)("h4",{id:"overrides-7"},"Overrides"),(0,l.kt)("p",null,"Election.questions"),(0,l.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L175"},"types/election/published.ts:175")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"raw"},"raw"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"raw"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"object")),(0,l.kt)("h4",{id:"returns-19"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"object")),(0,l.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L235"},"types/election/published.ts:235")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"results"},"results"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"results"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string"),"[][]"),(0,l.kt)("h4",{id:"returns-20"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string"),"[][]"),(0,l.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L207"},"types/election/published.ts:207")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"resultstype"},"resultsType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"resultsType"),"(): ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/modules#electionresultstype"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionResultsType"))),(0,l.kt)("h4",{id:"returns-21"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/modules#electionresultstype"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionResultsType"))),(0,l.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L231"},"types/election/published.ts:231")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"startdate"},"startDate"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"startDate"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"returns-22"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Date")),(0,l.kt)("h4",{id:"overrides-8"},"Overrides"),(0,l.kt)("p",null,"Election.startDate"),(0,l.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L159"},"types/election/published.ts:159")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"status"},"status"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"status"),"(): ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,l.kt)("h4",{id:"returns-23"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,l.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L195"},"types/election/published.ts:195")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"streamuri"},"streamUri"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"streamUri"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-24"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"overrides-9"},"Overrides"),(0,l.kt)("p",null,"Election.streamUri"),(0,l.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L155"},"types/election/published.ts:155")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-25"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,l.kt)("p",null,"Election.temporarySecretIdentity"),(0,l.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L258"},"types/election/election.ts:258")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"title"},"title"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"title"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"returns-26"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"overrides-10"},"Overrides"),(0,l.kt)("p",null,"Election.title"),(0,l.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L143"},"types/election/published.ts:143")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"votecount"},"voteCount"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"voteCount"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"returns-27"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"number")),(0,l.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L199"},"types/election/published.ts:199")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"votetype"},"voteType"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"get")," ",(0,l.kt)("strong",{parentName:"p"},"voteType"),"(): ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,l.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,l.kt)("h4",{id:"returns-28"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,l.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,l.kt)("h4",{id:"overrides-11"},"Overrides"),(0,l.kt)("p",null,"Election.voteType"),(0,l.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L171"},"types/election/published.ts:171")),(0,l.kt)("h2",{id:"methods-1"},"Methods"),(0,l.kt)("h3",{id:"checkvote"},"checkVote"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"checkVote"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"vote"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"parameters-1"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"vote")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Vote"},(0,l.kt)("inlineCode",{parentName:"a"},"Vote")))))),(0,l.kt)("h4",{id:"returns-29"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L113"},"types/election/published.ts:113")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"get"},"get"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"get"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"dot"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("h4",{id:"parameters-2"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"dot")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))))),(0,l.kt)("h4",{id:"returns-30"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#get"},"get")),(0,l.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L266"},"types/election/election.ts:266")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"build"},"build"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"build"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"PublishedElection"))),(0,l.kt)("p",null,"Returns a published election object"),(0,l.kt)("h4",{id:"parameters-3"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"params")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IPublishedElectionParameters"},(0,l.kt)("inlineCode",{parentName:"a"},"IPublishedElectionParameters"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Published election parameters")))),(0,l.kt)("h4",{id:"returns-31"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"PublishedElection"))),(0,l.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L100"},"types/election/published.ts:100")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"checkvote-1"},"checkVote"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"checkVote"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"vote"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"voteType"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"parameters-4"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"vote")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Vote"},(0,l.kt)("inlineCode",{parentName:"a"},"Vote")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"voteType")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IVoteType"},(0,l.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,l.kt)("h4",{id:"returns-32"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L127"},"types/election/published.ts:127")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"from"},"from"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"from"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,l.kt)("p",null,"Returns an unpublished election object"),(0,l.kt)("h4",{id:"parameters-5"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"params")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IElectionParameters"},(0,l.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Unpublished Election parameters")))),(0,l.kt)("h4",{id:"returns-33"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,l.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,l.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#from"},"from")),(0,l.kt)("h4",{id:"defined-in-60"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L206"},"types/election/election.ts:206")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getstatus"},"getStatus"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"getStatus"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"status"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"startDate"),"): ",(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,l.kt)("h4",{id:"parameters-6"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"status")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/sdk/reference/modules#allelectionstatus"},(0,l.kt)("inlineCode",{parentName:"a"},"AllElectionStatus")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"startDate")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,l.kt)("h4",{id:"returns-34"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/sdk/reference/enums/ElectionStatus"},(0,l.kt)("inlineCode",{parentName:"a"},"ElectionStatus"))),(0,l.kt)("h4",{id:"defined-in-61"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L104"},"types/election/published.ts:104")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d5851cb1.2eb4ac62.js b/assets/js/d5851cb1.2eb4ac62.js deleted file mode 100644 index b936de013..000000000 --- a/assets/js/d5851cb1.2eb4ac62.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3013],{3905:(e,n,t)=>{t.d(n,{Zo:()=>c,kt:()=>d});var r=t(67294);function s(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(s[t]=e[t]);return s}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(s[t]=e[t])}return s}var l=r.createContext({}),p=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},c=function(e){var n=p(e.components);return r.createElement(l.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},f=r.forwardRef((function(e,n){var t=e.components,s=e.mdxType,i=e.originalType,l=e.parentName,c=a(e,["components","mdxType","originalType","parentName"]),f=p(t),d=s,k=f["".concat(l,".").concat(d)]||f[d]||u[d]||i;return t?r.createElement(k,o(o({ref:n},c),{},{components:t})):r.createElement(k,o({ref:n},c))}));function d(e,n){var t=arguments,s=n&&n.mdxType;if("string"==typeof e||s){var i=t.length,o=new Array(i);o[0]=f;var a={};for(var l in n)hasOwnProperty.call(n,l)&&(a[l]=n[l]);a.originalType=e,a.mdxType="string"==typeof e?e:s,o[1]=a;for(var p=2;p{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>p});var r=t(87462),s=(t(67294),t(3905));const i={},o=void 0,a={unversionedId:"sdk/reference/interfaces/ICensusProofResponse",id:"sdk/reference/interfaces/ICensusProofResponse",title:"ICensusProofResponse",description:"@vocdoni/sdk / Exports / ICensusProofResponse",source:"@site/docs/sdk/reference/interfaces/ICensusProofResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensusProofResponse",permalink:"/sdk/reference/interfaces/ICensusProofResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensusParticipant",permalink:"/sdk/reference/interfaces/ICensusParticipant"},next:{title:"ICensusPublishResponse",permalink:"/sdk/reference/interfaces/ICensusPublishResponse"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"censusProof",id:"censusproof",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"censusRoot",id:"censusroot",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"censusSiblings",id:"censussiblings",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"value",id:"value",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"weight",id:"weight",level:3},{value:"Defined in",id:"defined-in-5",level:4}],c={toc:p};function u(e){let{components:n,...t}=e;return(0,s.kt)("wrapper",(0,r.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensusProofResponse"),(0,s.kt)("h1",{id:"interface-icensusproofresponse"},"Interface: ICensusProofResponse"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusProofResponse#censusproof"},"censusProof")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusProofResponse#censusroot"},"censusRoot")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusProofResponse#censussiblings"},"censusSiblings")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusProofResponse#type"},"type")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusProofResponse#value"},"value")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensusProofResponse#weight"},"weight"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"censusproof"},"censusProof"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"censusProof"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The proof for the given key"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L83"},"api/census.ts:83")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"censusroot"},"censusRoot"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"censusRoot"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The root (id) of the census"),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L78"},"api/census.ts:78")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"censussiblings"},"censusSiblings"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,s.kt)("strong",{parentName:"p"},"censusSiblings"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,s.kt)("p",null,"The census siblings"),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L93"},"api/census.ts:93")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"type"},"type"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"type"),": ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("p",null,"The type of the census"),(0,s.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L68"},"api/census.ts:68")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"value"},"value"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"value"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The value for the given key"),(0,s.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L88"},"api/census.ts:88")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"weight"},"weight"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"weight"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The weight as a string"),(0,s.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census.ts#L73"},"api/census.ts:73")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d5851cb1.fba56249.js b/assets/js/d5851cb1.fba56249.js new file mode 100644 index 000000000..cdd61009e --- /dev/null +++ b/assets/js/d5851cb1.fba56249.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3013],{3905:(e,n,t)=>{t.d(n,{Zo:()=>u,kt:()=>f});var r=t(67294);function s(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(s[t]=e[t]);return s}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(s[t]=e[t])}return s}var l=r.createContext({}),p=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},u=function(e){var n=p(e.components);return r.createElement(l.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,s=e.mdxType,i=e.originalType,l=e.parentName,u=a(e,["components","mdxType","originalType","parentName"]),d=p(t),f=s,k=d["".concat(l,".").concat(f)]||d[f]||c[f]||i;return t?r.createElement(k,o(o({ref:n},u),{},{components:t})):r.createElement(k,o({ref:n},u))}));function f(e,n){var t=arguments,s=n&&n.mdxType;if("string"==typeof e||s){var i=t.length,o=new Array(i);o[0]=d;var a={};for(var l in n)hasOwnProperty.call(n,l)&&(a[l]=n[l]);a.originalType=e,a.mdxType="string"==typeof e?e:s,o[1]=a;for(var p=2;p{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>a,toc:()=>p});var r=t(87462),s=(t(67294),t(3905));const i={},o=void 0,a={unversionedId:"sdk/reference/interfaces/ICensusProofResponse",id:"sdk/reference/interfaces/ICensusProofResponse",title:"ICensusProofResponse",description:"@vocdoni/sdk / Exports / ICensusProofResponse",source:"@site/docs/sdk/reference/interfaces/ICensusProofResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensusProofResponse",permalink:"/sdk/reference/interfaces/ICensusProofResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensusParticipant",permalink:"/sdk/reference/interfaces/ICensusParticipant"},next:{title:"ICensusPublishResponse",permalink:"/sdk/reference/interfaces/ICensusPublishResponse"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"censusProof",id:"censusproof",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"censusRoot",id:"censusroot",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"censusSiblings",id:"censussiblings",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"value",id:"value",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"weight",id:"weight",level:3},{value:"Defined in",id:"defined-in-5",level:4}],u={toc:p};function c(e){let{components:n,...t}=e;return(0,s.kt)("wrapper",(0,r.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensusProofResponse"),(0,s.kt)("h1",{id:"interface-icensusproofresponse"},"Interface: ICensusProofResponse"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensusProofResponse#censusproof"},"censusProof")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensusProofResponse#censusroot"},"censusRoot")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensusProofResponse#censussiblings"},"censusSiblings")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensusProofResponse#type"},"type")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensusProofResponse#value"},"value")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensusProofResponse#weight"},"weight"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"censusproof"},"censusProof"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"censusProof"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The proof for the given key"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L83"},"api/census.ts:83")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"censusroot"},"censusRoot"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"censusRoot"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The root (id) of the census"),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L78"},"api/census.ts:78")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"censussiblings"},"censusSiblings"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,s.kt)("strong",{parentName:"p"},"censusSiblings"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,s.kt)("p",null,"The census siblings"),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L93"},"api/census.ts:93")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"type"},"type"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"type"),": ",(0,s.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("p",null,"The type of the census"),(0,s.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L68"},"api/census.ts:68")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"value"},"value"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"value"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The value for the given key"),(0,s.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L88"},"api/census.ts:88")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"weight"},"weight"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"weight"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("p",null,"The weight as a string"),(0,s.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census.ts#L73"},"api/census.ts:73")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d6b477f2.14d51fbd.js b/assets/js/d6b477f2.14d51fbd.js deleted file mode 100644 index 30d05d67b..000000000 --- a/assets/js/d6b477f2.14d51fbd.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1378],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var i=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=i.createContext({}),p=function(e){var t=i.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=p(e.components);return i.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,s=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),k=p(n),m=r,u=k["".concat(s,".").concat(m)]||k[m]||d[m]||a;return n?i.createElement(u,l(l({ref:t},c),{},{components:n})):i.createElement(u,l({ref:t},c))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,l=new Array(a);l[0]=k;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:r,l[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>a,metadata:()=>o,toc:()=>p});var i=n(87462),r=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IElectionParameters",id:"sdk/reference/interfaces/IElectionParameters",title:"IElectionParameters",description:"@vocdoni/sdk / Exports / IElectionParameters",source:"@site/docs/sdk/reference/interfaces/IElectionParameters.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionParameters",permalink:"/sdk/reference/interfaces/IElectionParameters",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionNextIdResponse",permalink:"/sdk/reference/interfaces/IElectionNextIdResponse"},next:{title:"IElectionSummary",permalink:"/sdk/reference/interfaces/IElectionSummary"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"census",id:"census",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"endDate",id:"enddate",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"header",id:"header",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"questions",id:"questions",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"startDate",id:"startdate",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"voteType",id:"votetype",level:3},{value:"Defined in",id:"defined-in-13",level:4}],c={toc:p};function d(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,i.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IElectionParameters"),(0,r.kt)("h1",{id:"interface-ielectionparameters"},"Interface: IElectionParameters"),(0,r.kt)("p",null,"Define election parameters."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IElectionParameters"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IPublishedElectionParameters"},(0,r.kt)("inlineCode",{parentName:"a"},"IPublishedElectionParameters"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IMultiChoiceElectionParameters"},(0,r.kt)("inlineCode",{parentName:"a"},"IMultiChoiceElectionParameters"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},(0,r.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParametersInfo"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IApprovalElectionParameters"},(0,r.kt)("inlineCode",{parentName:"a"},"IApprovalElectionParameters"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionParameters#addsdkversion"},"addSDKVersion")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionParameters#census"},"census")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionParameters#description"},"description")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionParameters#electiontype"},"electionType")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionParameters#enddate"},"endDate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionParameters#header"},"header")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionParameters#maxcensussize"},"maxCensusSize")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionParameters#meta"},"meta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionParameters#questions"},"questions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionParameters#startdate"},"startDate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionParameters#streamuri"},"streamUri")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionParameters#temporarysecretidentity"},"temporarySecretIdentity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionParameters#title"},"title")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionParameters#votetype"},"voteType"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"addSDKVersion"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Used to add the SDK version to the election metadata"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L155"},"types/election/election.ts:155")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"census"},"census"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"census"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,r.kt)("inlineCode",{parentName:"a"},"Census"))),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L129"},"types/election/election.ts:129")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Election description"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L114"},"types/election/election.ts:114")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electiontype"},"electionType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"electionType"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L131"},"types/election/election.ts:131")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"enddate"},"endDate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"endDate"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L128"},"types/election/election.ts:128")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"header"},"header"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"header"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Election header image url."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L118"},"types/election/election.ts:118")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Is used to limit the number of votes that can be registered for an election. This feature helps to prevent any\npotential overflow of the blockchain when the number of votes goes beyond the maximum limit."),(0,r.kt)("p",null,"In order to create an election, the creator is required to set the MaxCensusSize parameter to a proper value.\nTypically, this value should be equal to the size of the census. If the MaxCensusSize parameter is set to 0, an\nerror will occur and the election cannot be created."),(0,r.kt)("p",null,"If the number of votes exceeds this limit, will throw ",(0,r.kt)("inlineCode",{parentName:"p"},"Max census size for the election is greater than allowed\nsize")," error."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L145"},"types/election/election.ts:145")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Metadata (anything added by the election creator)"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L126"},"types/election/election.ts:126")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"questions"},"questions"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"questions"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,r.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L132"},"types/election/election.ts:132")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"startdate"},"startDate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"startDate"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L127"},"types/election/election.ts:127")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"streamuri"},"streamUri"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"streamUri"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Election stream Uri (ex: a video url)"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L122"},"types/election/election.ts:122")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Is used to remove the secret identities of the voters once the process is done."),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L150"},"types/election/election.ts:150")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"title"},"title"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"title"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Election title"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L110"},"types/election/election.ts:110")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"votetype"},"voteType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"voteType"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,r.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L130"},"types/election/election.ts:130")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d6b477f2.7af2c24f.js b/assets/js/d6b477f2.7af2c24f.js new file mode 100644 index 000000000..854745bfd --- /dev/null +++ b/assets/js/d6b477f2.7af2c24f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1378],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var i=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=i.createContext({}),s=function(e){var t=i.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=s(e.components);return i.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},m=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),m=s(n),k=a,u=m["".concat(p,".").concat(k)]||m[k]||c[k]||r;return n?i.createElement(u,l(l({ref:t},d),{},{components:n})):i.createElement(u,l({ref:t},d))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,l=new Array(r);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>c,frontMatter:()=>r,metadata:()=>o,toc:()=>s});var i=n(87462),a=(n(67294),n(3905));const r={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IElectionParameters",id:"sdk/reference/interfaces/IElectionParameters",title:"IElectionParameters",description:"@vocdoni/sdk / Exports / IElectionParameters",source:"@site/docs/sdk/reference/interfaces/IElectionParameters.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionParameters",permalink:"/sdk/reference/interfaces/IElectionParameters",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionNextIdResponse",permalink:"/sdk/reference/interfaces/IElectionNextIdResponse"},next:{title:"IElectionSummary",permalink:"/sdk/reference/interfaces/IElectionSummary"}},p={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"census",id:"census",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"endDate",id:"enddate",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"header",id:"header",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"questions",id:"questions",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"startDate",id:"startdate",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"voteType",id:"votetype",level:3},{value:"Defined in",id:"defined-in-13",level:4}],d={toc:s};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IElectionParameters"),(0,a.kt)("h1",{id:"interface-ielectionparameters"},"Interface: IElectionParameters"),(0,a.kt)("p",null,"Define election parameters."),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"IElectionParameters"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"IPublishedElectionParameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IPublishedElectionParameters"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"IMultiChoiceElectionParameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IMultiChoiceElectionParameters"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo"},(0,a.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParametersInfo"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"IApprovalElectionParameters"},(0,a.kt)("inlineCode",{parentName:"a"},"IApprovalElectionParameters"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionParameters#addsdkversion"},"addSDKVersion")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionParameters#census"},"census")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionParameters#description"},"description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionParameters#electiontype"},"electionType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionParameters#enddate"},"endDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionParameters#header"},"header")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionParameters#maxcensussize"},"maxCensusSize")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionParameters#meta"},"meta")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionParameters#questions"},"questions")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionParameters#startdate"},"startDate")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionParameters#streamuri"},"streamUri")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionParameters#temporarysecretidentity"},"temporarySecretIdentity")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionParameters#title"},"title")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IElectionParameters#votetype"},"voteType"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"addSDKVersion"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"Used to add the SDK version to the election metadata"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L155"},"types/election/election.ts:155")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"census"},"census"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"census"),": ",(0,a.kt)("a",{parentName:"p",href:"../classes/Census"},(0,a.kt)("inlineCode",{parentName:"a"},"Census"))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L129"},"types/election/election.ts:129")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,"Election description"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L114"},"types/election/election.ts:114")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"electiontype"},"electionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"electionType"),": ",(0,a.kt)("a",{parentName:"p",href:"IElectionType"},(0,a.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L131"},"types/election/election.ts:131")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"enddate"},"endDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"endDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L128"},"types/election/election.ts:128")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"header"},"header"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"header"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Election header image url."),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L118"},"types/election/election.ts:118")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"Is used to limit the number of votes that can be registered for an election. This feature helps to prevent any\npotential overflow of the blockchain when the number of votes goes beyond the maximum limit."),(0,a.kt)("p",null,"In order to create an election, the creator is required to set the MaxCensusSize parameter to a proper value.\nTypically, this value should be equal to the size of the census. If the MaxCensusSize parameter is set to 0, an\nerror will occur and the election cannot be created."),(0,a.kt)("p",null,"If the number of votes exceeds this limit, will throw ",(0,a.kt)("inlineCode",{parentName:"p"},"Max census size for the election is greater than allowed\nsize")," error."),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L145"},"types/election/election.ts:145")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"meta"},"meta"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"meta"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("p",null,"Metadata (anything added by the election creator)"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L126"},"types/election/election.ts:126")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"questions"},"questions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"questions"),": ",(0,a.kt)("a",{parentName:"p",href:"IQuestion"},(0,a.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L132"},"types/election/election.ts:132")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"startdate"},"startDate"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"startDate"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Date")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L127"},"types/election/election.ts:127")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"streamuri"},"streamUri"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"streamUri"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Election stream Uri (ex: a video url)"),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L122"},"types/election/election.ts:122")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"Is used to remove the secret identities of the voters once the process is done."),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L150"},"types/election/election.ts:150")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"title"},"title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"title"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("p",null,"Election title"),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L110"},"types/election/election.ts:110")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"votetype"},"voteType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"voteType"),": ",(0,a.kt)("a",{parentName:"p",href:"IVoteType"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L130"},"types/election/election.ts:130")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d79e07b2.640415a2.js b/assets/js/d79e07b2.640415a2.js deleted file mode 100644 index 1e015f0de..000000000 --- a/assets/js/d79e07b2.640415a2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1054],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>f});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),c=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=c(e.components);return r.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),u=c(n),f=a,k=u["".concat(l,".").concat(f)]||u[f]||d[f]||i;return n?r.createElement(k,s(s({ref:t},p),{},{components:n})):r.createElement(k,s({ref:t},p))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,s=new Array(i);s[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,s[1]=o;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var r=n(87462),a=(n(67294),n(3905));const i={},s=void 0,o={unversionedId:"sdk/reference/interfaces/ICensus3StrategyToken",id:"sdk/reference/interfaces/ICensus3StrategyToken",title:"ICensus3StrategyToken",description:"@vocdoni/sdk / Exports / ICensus3StrategyToken",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategyToken.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategyToken",permalink:"/sdk/reference/interfaces/ICensus3StrategyToken",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategyImportQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse"},next:{title:"ICensus3SupportedChain",permalink:"/sdk/reference/interfaces/ICensus3SupportedChain"}},l={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"method",id:"method",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"minBalance",id:"minbalance",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-3",level:4}],p={toc:c};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3StrategyToken"),(0,a.kt)("h1",{id:"interface-icensus3strategytoken"},"Interface: ICensus3StrategyToken"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyToken#id"},"id")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyToken#method"},"method")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyToken#minbalance"},"minBalance")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyToken#name"},"name"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"id"},"id"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"id"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The id (address) of the token."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L175"},"api/census3/strategy.ts:175")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"method"},"method"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"method"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The method used for checking balances."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L190"},"api/census3/strategy.ts:190")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"minbalance"},"minBalance"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"minBalance"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The minimum balance."),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L185"},"api/census3/strategy.ts:185")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The name of the token."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L180"},"api/census3/strategy.ts:180")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d79e07b2.cfdbf42d.js b/assets/js/d79e07b2.cfdbf42d.js new file mode 100644 index 000000000..a2fb7a17e --- /dev/null +++ b/assets/js/d79e07b2.cfdbf42d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1054],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),u=p(n),f=a,k=u["".concat(l,".").concat(f)]||u[f]||d[f]||i;return n?r.createElement(k,o(o({ref:t},c),{},{components:n})):r.createElement(k,o({ref:t},c))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const i={},o=void 0,s={unversionedId:"sdk/reference/interfaces/ICensus3StrategyToken",id:"sdk/reference/interfaces/ICensus3StrategyToken",title:"ICensus3StrategyToken",description:"@vocdoni/sdk / Exports / ICensus3StrategyToken",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategyToken.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategyToken",permalink:"/sdk/reference/interfaces/ICensus3StrategyToken",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategyImportQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse"},next:{title:"ICensus3SupportedChain",permalink:"/sdk/reference/interfaces/ICensus3SupportedChain"}},l={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"method",id:"method",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"minBalance",id:"minbalance",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:p};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3StrategyToken"),(0,a.kt)("h1",{id:"interface-icensus3strategytoken"},"Interface: ICensus3StrategyToken"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3StrategyToken#id"},"id")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3StrategyToken#method"},"method")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3StrategyToken#minbalance"},"minBalance")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3StrategyToken#name"},"name"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"id"},"id"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"id"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The id (address) of the token."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L175"},"api/census3/strategy.ts:175")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"method"},"method"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"method"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The method used for checking balances."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L190"},"api/census3/strategy.ts:190")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"minbalance"},"minBalance"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"minBalance"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The minimum balance."),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L185"},"api/census3/strategy.ts:185")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The name of the token."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L180"},"api/census3/strategy.ts:180")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d7d13fd1.7377c312.js b/assets/js/d7d13fd1.7377c312.js new file mode 100644 index 000000000..c996f56ae --- /dev/null +++ b/assets/js/d7d13fd1.7377c312.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2005],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var i=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=i.createContext({}),s=function(e){var t=i.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=s(e.components);return i.createElement(d.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},c=i.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,d=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),c=s(n),m=r,f=c["".concat(d,".").concat(m)]||c[m]||u[m]||a;return n?i.createElement(f,l(l({ref:t},p),{},{components:n})):i.createElement(f,l({ref:t},p))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,l=new Array(a);l[0]=c;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:r,l[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>s});var i=n(87462),r=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight",id:"sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight",title:"IBudgetElectionParametersWithCensusWeight",description:"@vocdoni/sdk / Exports / IBudgetElectionParametersWithCensusWeight",source:"@site/docs/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IBudgetElectionParametersWithBudget",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget"},next:{title:"ICensus",permalink:"/sdk/reference/interfaces/ICensus"}},d={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"census",id:"census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"endDate",id:"enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"forceFullBudget",id:"forcefullbudget",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"header",id:"header",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"meta",id:"meta",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"minStep",id:"minstep",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"questions",id:"questions",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"startDate",id:"startdate",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"useCensusWeightAsBudget",id:"usecensusweightasbudget",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"voteType",id:"votetype",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-16",level:4}],p={toc:s};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,i.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IBudgetElectionParametersWithCensusWeight"),(0,r.kt)("h1",{id:"interface-ibudgetelectionparameterswithcensusweight"},"Interface: IBudgetElectionParametersWithCensusWeight"),(0,r.kt)("p",null,"Define election parameters."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo"},(0,r.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParametersInfo"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IBudgetElectionParametersWithCensusWeight"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#addsdkversion"},"addSDKVersion")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#census"},"census")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#description"},"description")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#electiontype"},"electionType")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#enddate"},"endDate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#forcefullbudget"},"forceFullBudget")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#header"},"header")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#maxcensussize"},"maxCensusSize")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#meta"},"meta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#minstep"},"minStep")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#questions"},"questions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#startdate"},"startDate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#streamuri"},"streamUri")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#temporarysecretidentity"},"temporarySecretIdentity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#title"},"title")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#usecensusweightasbudget"},"useCensusWeightAsBudget")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithCensusWeight#votetype"},"voteType"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"addSDKVersion"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Used to add the SDK version to the election metadata"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#addsdkversion"},"addSDKVersion")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L155"},"types/election/election.ts:155")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"census"},"census"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"census"),": ",(0,r.kt)("a",{parentName:"p",href:"../classes/Census"},(0,r.kt)("inlineCode",{parentName:"a"},"Census"))),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#census"},"census")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L129"},"types/election/election.ts:129")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Election description"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#description"},"description")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L114"},"types/election/election.ts:114")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electiontype"},"electionType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"electionType"),": ",(0,r.kt)("a",{parentName:"p",href:"IElectionType"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#electiontype"},"electionType")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L131"},"types/election/election.ts:131")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"enddate"},"endDate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"endDate"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#enddate"},"endDate")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L128"},"types/election/election.ts:128")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"forcefullbudget"},"forceFullBudget"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"forceFullBudget"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#forcefullbudget"},"forceFullBudget")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L9"},"types/election/budget.ts:9")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"header"},"header"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"header"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Election header image url."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#header"},"header")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L118"},"types/election/election.ts:118")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Is used to limit the number of votes that can be registered for an election. This feature helps to prevent any\npotential overflow of the blockchain when the number of votes goes beyond the maximum limit."),(0,r.kt)("p",null,"In order to create an election, the creator is required to set the MaxCensusSize parameter to a proper value.\nTypically, this value should be equal to the size of the census. If the MaxCensusSize parameter is set to 0, an\nerror will occur and the election cannot be created."),(0,r.kt)("p",null,"If the number of votes exceeds this limit, will throw ",(0,r.kt)("inlineCode",{parentName:"p"},"Max census size for the election is greater than allowed\nsize")," error."),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#maxcensussize"},"maxCensusSize")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L145"},"types/election/election.ts:145")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Metadata (anything added by the election creator)"),(0,r.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#meta"},"meta")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L126"},"types/election/election.ts:126")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"minstep"},"minStep"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"minStep"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#minstep"},"minStep")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L8"},"types/election/budget.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"questions"},"questions"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"questions"),": ",(0,r.kt)("a",{parentName:"p",href:"IQuestion"},(0,r.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,r.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#questions"},"questions")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L132"},"types/election/election.ts:132")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"startdate"},"startDate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"startDate"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#startdate"},"startDate")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L127"},"types/election/election.ts:127")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"streamuri"},"streamUri"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"streamUri"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Election stream Uri (ex: a video url)"),(0,r.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#streamuri"},"streamUri")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L122"},"types/election/election.ts:122")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Is used to remove the secret identities of the voters once the process is done."),(0,r.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#temporarysecretidentity"},"temporarySecretIdentity")),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L150"},"types/election/election.ts:150")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"title"},"title"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"title"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Election title"),(0,r.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#title"},"title")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L110"},"types/election/election.ts:110")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usecensusweightasbudget"},"useCensusWeightAsBudget"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"useCensusWeightAsBudget"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L13"},"types/election/budget.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"votetype"},"voteType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"voteType"),": ",(0,r.kt)("a",{parentName:"p",href:"IVoteType"},(0,r.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,r.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#votetype"},"voteType")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L130"},"types/election/election.ts:130")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d7d13fd1.f7c42b0d.js b/assets/js/d7d13fd1.f7c42b0d.js deleted file mode 100644 index 7eba64827..000000000 --- a/assets/js/d7d13fd1.f7c42b0d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2005],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>u});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var d=r.createContext({}),s=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=s(e.components);return r.createElement(d.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,d=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),f=s(n),u=i,m=f["".concat(d,".").concat(u)]||f[u]||p[u]||a;return n?r.createElement(m,l(l({ref:t},c),{},{components:n})):r.createElement(m,l({ref:t},c))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=f;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>s});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight",id:"sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight",title:"IBudgetElectionParametersWithCensusWeight",description:"@vocdoni/sdk / Exports / IBudgetElectionParametersWithCensusWeight",source:"@site/docs/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IBudgetElectionParametersWithBudget",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget"},next:{title:"ICensus",permalink:"/sdk/reference/interfaces/ICensus"}},d={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"census",id:"census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"endDate",id:"enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"forceFullBudget",id:"forcefullbudget",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"header",id:"header",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"meta",id:"meta",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"minStep",id:"minstep",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"questions",id:"questions",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"startDate",id:"startdate",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"useCensusWeightAsBudget",id:"usecensusweightasbudget",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"voteType",id:"votetype",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-16",level:4}],c={toc:s};function p(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IBudgetElectionParametersWithCensusWeight"),(0,i.kt)("h1",{id:"interface-ibudgetelectionparameterswithcensusweight"},"Interface: IBudgetElectionParametersWithCensusWeight"),(0,i.kt)("p",null,"Define election parameters."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},(0,i.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParametersInfo"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"IBudgetElectionParametersWithCensusWeight"))))),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#addsdkversion"},"addSDKVersion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#census"},"census")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#description"},"description")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#electiontype"},"electionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#enddate"},"endDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#forcefullbudget"},"forceFullBudget")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#header"},"header")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#maxcensussize"},"maxCensusSize")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#meta"},"meta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#minstep"},"minStep")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#questions"},"questions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#startdate"},"startDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#streamuri"},"streamUri")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#title"},"title")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#usecensusweightasbudget"},"useCensusWeightAsBudget")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight#votetype"},"voteType"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"addSDKVersion"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Used to add the SDK version to the election metadata"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#addsdkversion"},"addSDKVersion")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L155"},"types/election/election.ts:155")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"census"},"census"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"census"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census"))),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#census"},"census")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L129"},"types/election/election.ts:129")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Election description"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#description"},"description")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L114"},"types/election/election.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electiontype"},"electionType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"electionType"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#electiontype"},"electionType")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L131"},"types/election/election.ts:131")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enddate"},"endDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"endDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#enddate"},"endDate")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L128"},"types/election/election.ts:128")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"forcefullbudget"},"forceFullBudget"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"forceFullBudget"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#forcefullbudget"},"forceFullBudget")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L9"},"types/election/budget.ts:9")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"header"},"header"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"header"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Election header image url."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#header"},"header")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L118"},"types/election/election.ts:118")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Is used to limit the number of votes that can be registered for an election. This feature helps to prevent any\npotential overflow of the blockchain when the number of votes goes beyond the maximum limit."),(0,i.kt)("p",null,"In order to create an election, the creator is required to set the MaxCensusSize parameter to a proper value.\nTypically, this value should be equal to the size of the census. If the MaxCensusSize parameter is set to 0, an\nerror will occur and the election cannot be created."),(0,i.kt)("p",null,"If the number of votes exceeds this limit, will throw ",(0,i.kt)("inlineCode",{parentName:"p"},"Max census size for the election is greater than allowed\nsize")," error."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#maxcensussize"},"maxCensusSize")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L145"},"types/election/election.ts:145")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("p",null,"Metadata (anything added by the election creator)"),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#meta"},"meta")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L126"},"types/election/election.ts:126")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"minstep"},"minStep"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"minStep"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#minstep"},"minStep")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L8"},"types/election/budget.ts:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"questions"},"questions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"questions"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#questions"},"questions")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L132"},"types/election/election.ts:132")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"startdate"},"startDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"startDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#startdate"},"startDate")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L127"},"types/election/election.ts:127")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"streamuri"},"streamUri"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"streamUri"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Election stream Uri (ex: a video url)"),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#streamuri"},"streamUri")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L122"},"types/election/election.ts:122")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Is used to remove the secret identities of the voters once the process is done."),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L150"},"types/election/election.ts:150")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Election title"),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#title"},"title")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L110"},"types/election/election.ts:110")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"usecensusweightasbudget"},"useCensusWeightAsBudget"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"useCensusWeightAsBudget"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"true")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L13"},"types/election/budget.ts:13")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votetype"},"voteType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"voteType"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#votetype"},"voteType")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L130"},"types/election/election.ts:130")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d8c992a6.e85c5209.js b/assets/js/d8c992a6.10dc849d.js similarity index 65% rename from assets/js/d8c992a6.e85c5209.js rename to assets/js/d8c992a6.10dc849d.js index 5bbe8d98d..e70c2561b 100644 --- a/assets/js/d8c992a6.e85c5209.js +++ b/assets/js/d8c992a6.10dc849d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2175],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>d});var s=t(67294);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);n&&(s=s.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,s)}return t}function i(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(s=0;s=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var c=s.createContext({}),u=function(e){var n=s.useContext(c),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},p=function(e){var n=u(e.components);return s.createElement(c.Provider,{value:n},e.children)},l={inlineCode:"code",wrapper:function(e){var n=e.children;return s.createElement(s.Fragment,{},n)}},f=s.forwardRef((function(e,n){var t=e.components,r=e.mdxType,o=e.originalType,c=e.parentName,p=a(e,["components","mdxType","originalType","parentName"]),f=u(t),d=r,m=f["".concat(c,".").concat(d)]||f[d]||l[d]||o;return t?s.createElement(m,i(i({ref:n},p),{},{components:t})):s.createElement(m,i({ref:n},p))}));function d(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var o=t.length,i=new Array(o);i[0]=f;var a={};for(var c in n)hasOwnProperty.call(n,c)&&(a[c]=n[c]);a.originalType=e,a.mdxType="string"==typeof e?e:r,i[1]=a;for(var u=2;u{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>u});var s=t(87462),r=(t(67294),t(3905));const o={},i=void 0,a={unversionedId:"sdk/reference/interfaces/ICensus3CensusListResponse",id:"sdk/reference/interfaces/ICensus3CensusListResponse",title:"ICensus3CensusListResponse",description:"@vocdoni/sdk / Exports / ICensus3CensusListResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3CensusListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3CensusListResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus",permalink:"/sdk/reference/interfaces/ICensus"},next:{title:"ICensus3CensusQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusQueueResponse"}},c={},u=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"censuses",id:"censuses",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:u};function l(e){let{components:n,...t}=e;return(0,r.kt)("wrapper",(0,s.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3CensusListResponse"),(0,r.kt)("h1",{id:"interface-icensus3censuslistresponse"},"Interface: ICensus3CensusListResponse"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3CensusListResponse#censuses"},"censuses"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"censuses"},"censuses"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"censuses"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),"[]"),(0,r.kt)("p",null,"The list of the strategies identifiers"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L15"},"api/census3/census.ts:15")))}l.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2175],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>d});var s=t(67294);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);n&&(s=s.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,s)}return t}function i(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(s=0;s=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var u=s.createContext({}),c=function(e){var n=s.useContext(u),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},p=function(e){var n=c(e.components);return s.createElement(u.Provider,{value:n},e.children)},l={inlineCode:"code",wrapper:function(e){var n=e.children;return s.createElement(s.Fragment,{},n)}},f=s.forwardRef((function(e,n){var t=e.components,r=e.mdxType,o=e.originalType,u=e.parentName,p=a(e,["components","mdxType","originalType","parentName"]),f=c(t),d=r,m=f["".concat(u,".").concat(d)]||f[d]||l[d]||o;return t?s.createElement(m,i(i({ref:n},p),{},{components:t})):s.createElement(m,i({ref:n},p))}));function d(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var o=t.length,i=new Array(o);i[0]=f;var a={};for(var u in n)hasOwnProperty.call(n,u)&&(a[u]=n[u]);a.originalType=e,a.mdxType="string"==typeof e?e:r,i[1]=a;for(var c=2;c{t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var s=t(87462),r=(t(67294),t(3905));const o={},i=void 0,a={unversionedId:"sdk/reference/interfaces/ICensus3CensusListResponse",id:"sdk/reference/interfaces/ICensus3CensusListResponse",title:"ICensus3CensusListResponse",description:"@vocdoni/sdk / Exports / ICensus3CensusListResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3CensusListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3CensusListResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus",permalink:"/sdk/reference/interfaces/ICensus"},next:{title:"ICensus3CensusQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3CensusQueueResponse"}},u={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"censuses",id:"censuses",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:c};function l(e){let{components:n,...t}=e;return(0,r.kt)("wrapper",(0,s.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3CensusListResponse"),(0,r.kt)("h1",{id:"interface-icensus3censuslistresponse"},"Interface: ICensus3CensusListResponse"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ICensus3CensusListResponse#censuses"},"censuses"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"censuses"},"censuses"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"censuses"),": ",(0,r.kt)("a",{parentName:"p",href:"ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),"[]"),(0,r.kt)("p",null,"The list of the strategies identifiers"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L15"},"api/census3/census.ts:15")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d94ccd67.b01ce7cd.js b/assets/js/d94ccd67.b01ce7cd.js deleted file mode 100644 index 0de48c722..000000000 --- a/assets/js/d94ccd67.b01ce7cd.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[67],{3905:(e,t,a)=>{a.d(t,{Zo:()=>k,kt:()=>c});var n=a(67294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},k=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,k=p(e,["components","mdxType","originalType","parentName"]),m=o(a),c=r,N=m["".concat(d,".").concat(c)]||m[c]||s[c]||i;return a?n.createElement(N,l(l({ref:t},k),{},{components:a})):n.createElement(N,l({ref:t},k))}));function c(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:r,l[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var n=a(87462),r=(a(67294),a(3905));const i={},l=void 0,p={unversionedId:"sdk/reference/classes/ChainAPI",id:"sdk/reference/classes/ChainAPI",title:"ChainAPI",description:"@vocdoni/sdk / Exports / ChainAPI",source:"@site/docs/sdk/reference/classes/ChainAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/ChainAPI",permalink:"/sdk/reference/classes/ChainAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CensusService",permalink:"/sdk/reference/classes/CensusService"},next:{title:"ChainService",permalink:"/sdk/reference/classes/ChainService"}},d={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"blockByHash",id:"blockbyhash",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"blockByHeight",id:"blockbyheight",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"blockToDate",id:"blocktodate",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"blockTransactions",id:"blocktransactions",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"circuit",id:"circuit",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"circuits",id:"circuits",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"costs",id:"costs",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"dateToBlock",id:"datetoblock",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"info",id:"info",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"organizationCount",id:"organizationcount",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"organizationList",id:"organizationlist",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"submitTx",id:"submittx",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"txInfo",id:"txinfo",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"txInfoByBlock",id:"txinfobyblock",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"txList",id:"txlist",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"validatorsList",id:"validatorslist",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-18",level:4}],k={toc:o};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},k,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ChainAPI"),(0,r.kt)("h1",{id:"class-chainapi"},"Class: ChainAPI"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"API")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"ChainAPI"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#constructor"},"constructor"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#blockbyhash"},"blockByHash")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#blockbyheight"},"blockByHeight")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#blocktodate"},"blockToDate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#blocktransactions"},"blockTransactions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#circuit"},"circuit")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#circuits"},"circuits")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#costs"},"costs")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#datetoblock"},"dateToBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#info"},"info")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#isapierror"},"isApiError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#isundefinederror"},"isUndefinedError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#organizationcount"},"organizationCount")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#organizationlist"},"organizationList")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#submittx"},"submitTx")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#txinfo"},"txInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#txinfobyblock"},"txInfoByBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#txlist"},"txList")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/ChainAPI#validatorslist"},"validatorsList"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new ChainAPI"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ChainAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainAPI"))),(0,r.kt)("p",null,"Cannot be constructed."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ChainAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainAPI"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"API.constructor"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L358"},"api/chain.ts:358")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"blockbyhash"},"blockByHash"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"blockByHash"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hash"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainBlockInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainBlockInfoResponse")),">"),(0,r.kt)("p",null,"Get block information by hash"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"block hash")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainBlockInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainBlockInfoResponse")),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L556"},"api/chain.ts:556")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"blockbyheight"},"blockByHeight"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"blockByHeight"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"height"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainBlockInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainBlockInfoResponse")),">"),(0,r.kt)("p",null,"Get block information by height"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"height")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"block height")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainBlockInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainBlockInfoResponse")),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L529"},"api/chain.ts:529")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"blocktodate"},"blockToDate"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"blockToDate"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"height"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IBlockToDateResponse"),">"),(0,r.kt)("p",null,"Return approximate date by a given block height."),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"height")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"block height to calculate approximate timestamp")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IBlockToDateResponse"),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L600"},"api/chain.ts:600")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"blocktransactions"},"blockTransactions"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"blockTransactions"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"height"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBlockTransactionsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlockTransactionsResponse")),">"),(0,r.kt)("p",null,"Get paginated list of transactions registered on specific block"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"height")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"block height")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the page number")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBlockTransactionsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlockTransactionsResponse")),">"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L571"},"api/chain.ts:571")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"circuit"},"circuit"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"circuit"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array"),">"),(0,r.kt)("p",null,"Fetches a circuit."),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Circuit URL")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array"),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L407"},"api/chain.ts:407")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"circuits"},"circuits"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"circuits"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainGetCircuitResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCircuitResponse")),">"),(0,r.kt)("p",null,"Fetches info about the blockchain anonymous circuits."),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainGetCircuitResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCircuitResponse")),">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L394"},"api/chain.ts:394")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"costs"},"costs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"costs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainGetCostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCostsResponse")),">"),(0,r.kt)("p",null,"Fetches info about the blockchain costs."),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainGetCostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCostsResponse")),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L381"},"api/chain.ts:381")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"datetoblock"},"dateToBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dateToBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"timeStamp"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IDateToBlockResponse"),">"),(0,r.kt)("p",null,"By a given date give the estimate block for the current Vochain."),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"timeStamp")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"unix format timestamp")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IDateToBlockResponse"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L586"},"api/chain.ts:586")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"info"},"info"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"info"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainGetInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetInfoResponse")),">"),(0,r.kt)("p",null,"Fetches info about the blockchain status."),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainGetInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetInfoResponse")),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L368"},"api/chain.ts:368")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isapierror"},"isApiError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"API.isApiError"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L21"},"api/api.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"API.isUndefinedError"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L64"},"api/api.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"organizationcount"},"organizationCount"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"organizationCount"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainOrganizationCountResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainOrganizationCountResponse")),">"),(0,r.kt)("p",null,"Returns the number of organizations"),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainOrganizationCountResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainOrganizationCountResponse")),">"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L488"},"api/chain.ts:488")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"organizationlist"},"organizationList"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"organizationList"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"organizationId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainOrganizationListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainOrganizationListResponse")),">"),(0,r.kt)("p",null,"Returns the list of organizations by page"),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The page number")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"organizationId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Organization id or partial id to search. It has to be a valid hex string.")))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainOrganizationListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainOrganizationListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L503"},"api/chain.ts:503")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"submittx"},"submitTx"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"submitTx"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainSubmitTxResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainSubmitTxResponse")),">"),(0,r.kt)("p",null,"Submits a transaction to the blockchain"),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The transaction data payload")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainSubmitTxResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainSubmitTxResponse")),">"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L461"},"api/chain.ts:461")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"txinfo"},"txInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"txInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"txHash"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainTxReference"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainTxReference")),">"),(0,r.kt)("p",null,"Fetches information about a transaction from the blockchain."),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"txHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The transaction hash which we want to retrieve the info from")))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainTxReference"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainTxReference")),">"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L421"},"api/chain.ts:421")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"txinfobyblock"},"txInfoByBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"txInfoByBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"blockHeight"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"txIndex"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/Tx"},(0,r.kt)("inlineCode",{parentName:"a"},"Tx")),">"),(0,r.kt)("p",null,"Fetches information about a transaction by its containing block an index on the block."),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockHeight")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Block with the containing transaction")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"txIndex")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Index on the block")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/Tx"},(0,r.kt)("inlineCode",{parentName:"a"},"Tx")),">"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L441"},"api/chain.ts:441")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"txlist"},"txList"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"txList"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainTxListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainTxListResponse")),">"),(0,r.kt)("p",null,"Returns the list of transactions by page"),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{string} url API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{number} page The page number")))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainTxListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainTxListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L475"},"api/chain.ts:475")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"validatorslist"},"validatorsList"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"validatorsList"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainValidatorsListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainValidatorsListResponse")),">"),(0,r.kt)("p",null,"Returns the list of validators"),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainValidatorsListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainValidatorsListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L542"},"api/chain.ts:542")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d94ccd67.d580a008.js b/assets/js/d94ccd67.d580a008.js new file mode 100644 index 000000000..09c995452 --- /dev/null +++ b/assets/js/d94ccd67.d580a008.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[67],{3905:(e,t,a)=>{a.d(t,{Zo:()=>k,kt:()=>N});var n=a(67294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},k=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},s=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,k=p(e,["components","mdxType","originalType","parentName"]),s=o(a),N=r,h=s["".concat(d,".").concat(N)]||s[N]||m[N]||i;return a?n.createElement(h,l(l({ref:t},k),{},{components:a})):n.createElement(h,l({ref:t},k))}));function N(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=s;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:r,l[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var n=a(87462),r=(a(67294),a(3905));const i={},l=void 0,p={unversionedId:"sdk/reference/classes/ChainAPI",id:"sdk/reference/classes/ChainAPI",title:"ChainAPI",description:"@vocdoni/sdk / Exports / ChainAPI",source:"@site/docs/sdk/reference/classes/ChainAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/ChainAPI",permalink:"/sdk/reference/classes/ChainAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CensusService",permalink:"/sdk/reference/classes/CensusService"},next:{title:"ChainService",permalink:"/sdk/reference/classes/ChainService"}},d={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"blockByHash",id:"blockbyhash",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"blockByHeight",id:"blockbyheight",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"blockToDate",id:"blocktodate",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"blockTransactions",id:"blocktransactions",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"circuit",id:"circuit",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"circuits",id:"circuits",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"costs",id:"costs",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"dateToBlock",id:"datetoblock",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"info",id:"info",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"organizationCount",id:"organizationcount",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"organizationList",id:"organizationlist",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"submitTx",id:"submittx",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"txInfo",id:"txinfo",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"txInfoByBlock",id:"txinfobyblock",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"txList",id:"txlist",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"validatorsList",id:"validatorslist",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-18",level:4}],k={toc:o};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},k,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ChainAPI"),(0,r.kt)("h1",{id:"class-chainapi"},"Class: ChainAPI"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"API")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"ChainAPI"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#constructor"},"constructor"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#blockbyhash"},"blockByHash")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#blockbyheight"},"blockByHeight")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#blocktodate"},"blockToDate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#blocktransactions"},"blockTransactions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#circuit"},"circuit")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#circuits"},"circuits")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#costs"},"costs")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#datetoblock"},"dateToBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#info"},"info")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#isapierror"},"isApiError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#isundefinederror"},"isUndefinedError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#organizationcount"},"organizationCount")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#organizationlist"},"organizationList")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#submittx"},"submitTx")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#txinfo"},"txInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#txinfobyblock"},"txInfoByBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#txlist"},"txList")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"ChainAPI#validatorslist"},"validatorsList"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new ChainAPI"),"(): ",(0,r.kt)("a",{parentName:"p",href:"ChainAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainAPI"))),(0,r.kt)("p",null,"Cannot be constructed."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"ChainAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"ChainAPI"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"API.constructor"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L358"},"api/chain.ts:358")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"blockbyhash"},"blockByHash"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"blockByHash"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hash"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainBlockInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainBlockInfoResponse")),">"),(0,r.kt)("p",null,"Get block information by hash"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"block hash")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainBlockInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainBlockInfoResponse")),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L556"},"api/chain.ts:556")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"blockbyheight"},"blockByHeight"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"blockByHeight"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"height"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainBlockInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainBlockInfoResponse")),">"),(0,r.kt)("p",null,"Get block information by height"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"height")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"block height")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainBlockInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainBlockInfoResponse")),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L529"},"api/chain.ts:529")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"blocktodate"},"blockToDate"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"blockToDate"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"height"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IBlockToDateResponse"),">"),(0,r.kt)("p",null,"Return approximate date by a given block height."),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"height")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"block height to calculate approximate timestamp")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IBlockToDateResponse"),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L600"},"api/chain.ts:600")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"blocktransactions"},"blockTransactions"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"blockTransactions"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"height"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IBlockTransactionsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlockTransactionsResponse")),">"),(0,r.kt)("p",null,"Get paginated list of transactions registered on specific block"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"height")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"block height")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the page number")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IBlockTransactionsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlockTransactionsResponse")),">"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L571"},"api/chain.ts:571")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"circuit"},"circuit"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"circuit"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array"),">"),(0,r.kt)("p",null,"Fetches a circuit."),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Circuit URL")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"Uint8Array"),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L407"},"api/chain.ts:407")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"circuits"},"circuits"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"circuits"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainGetCircuitResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCircuitResponse")),">"),(0,r.kt)("p",null,"Fetches info about the blockchain anonymous circuits."),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainGetCircuitResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCircuitResponse")),">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L394"},"api/chain.ts:394")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"costs"},"costs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"costs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainGetCostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCostsResponse")),">"),(0,r.kt)("p",null,"Fetches info about the blockchain costs."),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainGetCostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetCostsResponse")),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L381"},"api/chain.ts:381")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"datetoblock"},"dateToBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"dateToBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"timeStamp"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IDateToBlockResponse"),">"),(0,r.kt)("p",null,"By a given date give the estimate block for the current Vochain."),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"timeStamp")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"unix format timestamp")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"IDateToBlockResponse"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L586"},"api/chain.ts:586")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"info"},"info"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"info"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainGetInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetInfoResponse")),">"),(0,r.kt)("p",null,"Fetches info about the blockchain status."),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainGetInfoResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainGetInfoResponse")),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L368"},"api/chain.ts:368")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isapierror"},"isApiError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"API.isApiError"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L21"},"api/api.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"API.isUndefinedError"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L64"},"api/api.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"organizationcount"},"organizationCount"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"organizationCount"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainOrganizationCountResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainOrganizationCountResponse")),">"),(0,r.kt)("p",null,"Returns the number of organizations"),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainOrganizationCountResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainOrganizationCountResponse")),">"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L488"},"api/chain.ts:488")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"organizationlist"},"organizationList"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"organizationList"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"organizationId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainOrganizationListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainOrganizationListResponse")),">"),(0,r.kt)("p",null,"Returns the list of organizations by page"),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The page number")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"organizationId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Organization id or partial id to search. It has to be a valid hex string.")))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainOrganizationListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainOrganizationListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L503"},"api/chain.ts:503")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"submittx"},"submitTx"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"submitTx"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainSubmitTxResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainSubmitTxResponse")),">"),(0,r.kt)("p",null,"Submits a transaction to the blockchain"),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The transaction data payload")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainSubmitTxResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainSubmitTxResponse")),">"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L461"},"api/chain.ts:461")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"txinfo"},"txInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"txInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"txHash"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainTxReference"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainTxReference")),">"),(0,r.kt)("p",null,"Fetches information about a transaction from the blockchain."),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"txHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The transaction hash which we want to retrieve the info from")))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainTxReference"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainTxReference")),">"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L421"},"api/chain.ts:421")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"txinfobyblock"},"txInfoByBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"txInfoByBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"blockHeight"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"txIndex"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/Tx"},(0,r.kt)("inlineCode",{parentName:"a"},"Tx")),">"),(0,r.kt)("p",null,"Fetches information about a transaction by its containing block an index on the block."),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockHeight")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Block with the containing transaction")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"txIndex")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Index on the block")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/Tx"},(0,r.kt)("inlineCode",{parentName:"a"},"Tx")),">"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L441"},"api/chain.ts:441")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"txlist"},"txList"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"txList"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"page?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainTxListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainTxListResponse")),">"),(0,r.kt)("p",null,"Returns the list of transactions by page"),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{string} url API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{number} page The page number")))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainTxListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainTxListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L475"},"api/chain.ts:475")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"validatorslist"},"validatorsList"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"validatorsList"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainValidatorsListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainValidatorsListResponse")),">"),(0,r.kt)("p",null,"Returns the list of validators"),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/IChainValidatorsListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"IChainValidatorsListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L542"},"api/chain.ts:542")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d95cd4ff.cb8c2e9f.js b/assets/js/d95cd4ff.cb8c2e9f.js new file mode 100644 index 000000000..11b2b060b --- /dev/null +++ b/assets/js/d95cd4ff.cb8c2e9f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4019],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var o=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function r(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=o.createContext({}),p=function(e){var t=o.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},c=function(e){var t=p(e.components);return o.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},d=o.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),d=p(n),m=i,h=d["".concat(s,".").concat(m)]||d[m]||u[m]||a;return n?o.createElement(h,r(r({ref:t},c),{},{components:n})):o.createElement(h,r({ref:t},c))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,r=new Array(a);r[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:i,r[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>r,default:()=>u,frontMatter:()=>a,metadata:()=>l,toc:()=>p});var o=n(87462),i=(n(67294),n(3905));const a={sidebar_position:4,slug:"approval"},r="Approval Voting (Multiple Choice)",l={unversionedId:"sdk/integration-details/voting-types/approval",id:"sdk/integration-details/voting-types/approval",title:"Approval Voting (Multiple Choice)",description:"An election with Approval voting is a voting system where voters are allowed to indicate their support for multiple",source:"@site/docs/sdk/integration-details/voting-types/approval.md",sourceDirName:"sdk/integration-details/voting-types",slug:"/sdk/integration-details/voting-types/approval",permalink:"/sdk/integration-details/voting-types/approval",draft:!1,tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4,slug:"approval"},sidebar:"defaultSidebar",previous:{title:"Ranked Voting",permalink:"/sdk/integration-details/voting-types/ranked"},next:{title:"Weighted voting",permalink:"/sdk/integration-details/voting-types/weighted"}},s={},p=[{value:"Setting up the election",id:"setting-up-the-election",level:2},{value:"Casting a vote",id:"casting-a-vote",level:2},{value:"Results interpretation",id:"results-interpretation",level:2}],c={toc:p};function u(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,o.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"approval-voting-multiple-choice"},"Approval Voting (Multiple Choice)"),(0,i.kt)("p",null,'An election with Approval voting is a voting system where voters are allowed to indicate their support for multiple\ncandidates or options on the ballot. Instead of selecting just one preferred choice, voters can approve or "check" off\nall the candidates they deem acceptable or worthy of their support.'),(0,i.kt)("p",null,"Approval voting does not involve ranking or prioritizing candidates; it simply allows voters to express their approval\nfor multiple choices. This system aims to provide a more nuanced representation of voter preferences and can encourage\ncandidates to appeal to a broader range of voters."),(0,i.kt)("p",null,"For example: select your two favourite colors from a list of 4."),(0,i.kt)("p",null,"See:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/examples/typescript/src/approval.ts"},"Complete example")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/protocol/ballot-protocol#multiple-choice"},"Ballot protocol implementation"))),(0,i.kt)("h2",{id:"setting-up-the-election"},"Setting up the election"),(0,i.kt)("p",null,"The configuration of the vote type for the election should be set as follows:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"const election_opts: IVoteType = {\n uniqueChoices: false,\n costFromWeight: false,\n maxCount: 4, // Correspond to the number of choices of the given question.\n maxValue: 1, // Determines the maximum value that can be assigned to a single choice.\n maxTotalCost: 2, // Set the maximum number of choices a user can select. \n}\n")),(0,i.kt)("p",null,"In this election type, a voter can cast a vote for option, hence ",(0,i.kt)("inlineCode",{parentName:"p"},"maxValue")," must be set to ",(0,i.kt)("inlineCode",{parentName:"p"},"1"),". Also, the ",(0,i.kt)("inlineCode",{parentName:"p"},"maxTotalCost"),"\nis used to define the maximum number of selectable choices."),(0,i.kt)("admonition",{title:"Multiple questions not supported",type:"danger"},(0,i.kt)("p",{parentName:"admonition"},(0,i.kt)("strong",{parentName:"p"},"This election type not support multiple questions"),": the current Vocdoni implementation restricts this kind of elections to a single question. To create an election with multiple questions check ",(0,i.kt)("a",{parentName:"p",href:"/protocol/ballot-protocol#multiquestion"},"multi question election"))),(0,i.kt)("h2",{id:"casting-a-vote"},"Casting a vote"),(0,i.kt)("p",null,"To cast a vote, use the method below:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"client.submitVote(new Vote([0, 1, 0, 1]));\n")),(0,i.kt)("p",null,"Each entry in the array corresponds to a selected choice in the election, with the value assigned to each entry set to 1,\nas per ",(0,i.kt)("inlineCode",{parentName:"p"},"maxValue"),". ",(0,i.kt)("inlineCode",{parentName:"p"},"maxTotalCost")," defines the maximum number of choices a voter can select. The array's length should\nmatch the total number of choices in the election (",(0,i.kt)("inlineCode",{parentName:"p"},"maxCount"),")."),(0,i.kt)("h2",{id:"results-interpretation"},"Results interpretation"),(0,i.kt)("p",null,"Assume a scenario where ten voters cast identical votes, i.e. ",(0,i.kt)("inlineCode",{parentName:"p"},"[0, 1, 0, 1]"),"."),(0,i.kt)("p",null,"The election results would be represented as a two-dimensional array:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre"},"[ \n [ '10', '0' ], \n [ '0', '10' ], \n [ '10', '0' ], \n [ '0', '10' ] \n]\n")),(0,i.kt)("p",null,"Each position in the outer array corresponds to the available choices, and each position within the inner arrays\nsignifies the number of voters who selected or did not select the corresponding choice. For example, ",(0,i.kt)("inlineCode",{parentName:"p"},"[10, 0]")," indicates\nten users did not select the choice, whereas ",(0,i.kt)("inlineCode",{parentName:"p"},"[0, 10]")," means that ten users voted for the choice. So:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"For choice ",(0,i.kt)("inlineCode",{parentName:"li"},"0"),", all 10 voters assigned it ",(0,i.kt)("inlineCode",{parentName:"li"},"0")," points,"),(0,i.kt)("li",{parentName:"ul"},"For choice ",(0,i.kt)("inlineCode",{parentName:"li"},"1"),", all 10 voters assigned it ",(0,i.kt)("inlineCode",{parentName:"li"},"1")," point,"),(0,i.kt)("li",{parentName:"ul"},"For choice ",(0,i.kt)("inlineCode",{parentName:"li"},"2"),", all 10 voters assigned it ",(0,i.kt)("inlineCode",{parentName:"li"},"0")," points, and"),(0,i.kt)("li",{parentName:"ul"},"For choice ",(0,i.kt)("inlineCode",{parentName:"li"},"3"),", all 10 voters assigned it ",(0,i.kt)("inlineCode",{parentName:"li"},"1")," point.")),(0,i.kt)("p",null,"Remember, this interpretation assumes that all voters have used the same voting pattern."))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d970501b.adbd0d15.js b/assets/js/d970501b.5c680b1a.js similarity index 60% rename from assets/js/d970501b.adbd0d15.js rename to assets/js/d970501b.5c680b1a.js index 021624e2f..2039ace7b 100644 --- a/assets/js/d970501b.adbd0d15.js +++ b/assets/js/d970501b.5c680b1a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1357],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>u});var n=r(67294);function i(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(i[r]=e[r]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(i[r]=e[r])}return i}var l=n.createContext({}),s=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},p=function(e){var t=s(e.components);return n.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,i=e.mdxType,a=e.originalType,l=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),f=s(r),u=i,m=f["".concat(l,".").concat(u)]||f[u]||d[u]||a;return r?n.createElement(m,o(o({ref:t},p),{},{components:r})):n.createElement(m,o({ref:t},p))}));function u(e,t){var r=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=r.length,o=new Array(a);o[0]=f;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c.mdxType="string"==typeof e?e:i,o[1]=c;for(var s=2;s{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>c,toc:()=>s});var n=r(87462),i=(r(67294),r(3905));const a={},o=void 0,c={unversionedId:"sdk/reference/interfaces/IInvalidElectionParameters",id:"sdk/reference/interfaces/IInvalidElectionParameters",title:"IInvalidElectionParameters",description:"@vocdoni/sdk / Exports / IInvalidElectionParameters",source:"@site/docs/sdk/reference/interfaces/IInvalidElectionParameters.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IInvalidElectionParameters",permalink:"/sdk/reference/interfaces/IInvalidElectionParameters",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IEncryptionKey",permalink:"/sdk/reference/interfaces/IEncryptionKey"},next:{title:"IMultiChoiceElectionParameters",permalink:"/sdk/reference/interfaces/IMultiChoiceElectionParameters"}},l={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:s};function d(e){let{components:t,...r}=e;return(0,i.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IInvalidElectionParameters"),(0,i.kt)("h1",{id:"interface-iinvalidelectionparameters"},"Interface: IInvalidElectionParameters"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IInvalidElectionParameters#id"},"id"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/invalid.ts#L2"},"types/election/invalid.ts:2")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1357],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>u});var n=r(67294);function i(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(i[r]=e[r]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(i[r]=e[r])}return i}var c=n.createContext({}),s=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},p=function(e){var t=s(e.components);return n.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,i=e.mdxType,a=e.originalType,c=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),f=s(r),u=i,m=f["".concat(c,".").concat(u)]||f[u]||d[u]||a;return r?n.createElement(m,o(o({ref:t},p),{},{components:r})):n.createElement(m,o({ref:t},p))}));function u(e,t){var r=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=r.length,o=new Array(a);o[0]=f;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l.mdxType="string"==typeof e?e:i,o[1]=l;for(var s=2;s{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>s});var n=r(87462),i=(r(67294),r(3905));const a={},o=void 0,l={unversionedId:"sdk/reference/interfaces/IInvalidElectionParameters",id:"sdk/reference/interfaces/IInvalidElectionParameters",title:"IInvalidElectionParameters",description:"@vocdoni/sdk / Exports / IInvalidElectionParameters",source:"@site/docs/sdk/reference/interfaces/IInvalidElectionParameters.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IInvalidElectionParameters",permalink:"/sdk/reference/interfaces/IInvalidElectionParameters",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IEncryptionKey",permalink:"/sdk/reference/interfaces/IEncryptionKey"},next:{title:"IMultiChoiceElectionParameters",permalink:"/sdk/reference/interfaces/IMultiChoiceElectionParameters"}},c={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:s};function d(e){let{components:t,...r}=e;return(0,i.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IInvalidElectionParameters"),(0,i.kt)("h1",{id:"interface-iinvalidelectionparameters"},"Interface: IInvalidElectionParameters"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IInvalidElectionParameters#id"},"id"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/invalid.ts#L2"},"types/election/invalid.ts:2")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/dae27e03.052931fa.js b/assets/js/dae27e03.052931fa.js new file mode 100644 index 000000000..e3f22787f --- /dev/null +++ b/assets/js/dae27e03.052931fa.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1738],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>h});var r=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=r.createContext({}),s=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},p=function(e){var n=s(e.components);return r.createElement(l.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},f=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),f=s(t),h=a,u=f["".concat(l,".").concat(h)]||f[h]||d[h]||i;return t?r.createElement(u,o(o({ref:n},p),{},{components:t})):r.createElement(u,o({ref:n},p))}));function h(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,o=new Array(i);o[0]=f;var c={};for(var l in n)hasOwnProperty.call(n,l)&&(c[l]=n[l]);c.originalType=e,c.mdxType="string"==typeof e?e:a,o[1]=c;for(var s=2;s{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>s});var r=t(87462),a=(t(67294),t(3905));const i={},o=void 0,c={unversionedId:"sdk/reference/interfaces/IChainTxReference",id:"sdk/reference/interfaces/IChainTxReference",title:"IChainTxReference",description:"@vocdoni/sdk / Exports / IChainTxReference",source:"@site/docs/sdk/reference/interfaces/IChainTxReference.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainTxReference",permalink:"/sdk/reference/interfaces/IChainTxReference",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainTxListResponse",permalink:"/sdk/reference/interfaces/IChainTxListResponse"},next:{title:"IChainValidator",permalink:"/sdk/reference/interfaces/IChainValidator"}},l={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"blockHeight",id:"blockheight",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"transactionHash",id:"transactionhash",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"transactionIndex",id:"transactionindex",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"transactionNumber",id:"transactionnumber",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"transactionType",id:"transactiontype",level:3},{value:"Defined in",id:"defined-in-4",level:4}],p={toc:s};function d(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IChainTxReference"),(0,a.kt)("h1",{id:"interface-ichaintxreference"},"Interface: IChainTxReference"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainTxReference#blockheight"},"blockHeight")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainTxReference#transactionhash"},"transactionHash")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainTxReference#transactionindex"},"transactionIndex")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainTxReference#transactionnumber"},"transactionNumber")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainTxReference#transactiontype"},"transactionType"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"blockheight"},"blockHeight"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"blockHeight"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of the block where the transaction is."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L193"},"api/chain.ts:193")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"transactionhash"},"transactionHash"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"transactionHash"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The hash of the transaction."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L188"},"api/chain.ts:188")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"transactionindex"},"transactionIndex"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"transactionIndex"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The index of the transaction inside the block."),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L198"},"api/chain.ts:198")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"transactionnumber"},"transactionNumber"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"transactionNumber"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of the transaction."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L183"},"api/chain.ts:183")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"transactiontype"},"transactionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"transactionType"),": ",(0,a.kt)("a",{parentName:"p",href:"../enums/TransactionType"},(0,a.kt)("inlineCode",{parentName:"a"},"TransactionType"))),(0,a.kt)("p",null,"The type of the transaction."),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L203"},"api/chain.ts:203")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/dae27e03.601562c9.js b/assets/js/dae27e03.601562c9.js deleted file mode 100644 index 40f7f1bd1..000000000 --- a/assets/js/dae27e03.601562c9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1738],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>h});var r=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function c(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=r.createContext({}),s=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):c(c({},n),e)),t},p=function(e){var n=s(e.components);return r.createElement(l.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},f=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),f=s(t),h=a,u=f["".concat(l,".").concat(h)]||f[h]||d[h]||i;return t?r.createElement(u,c(c({ref:n},p),{},{components:t})):r.createElement(u,c({ref:n},p))}));function h(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,c=new Array(i);c[0]=f;var o={};for(var l in n)hasOwnProperty.call(n,l)&&(o[l]=n[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,c[1]=o;for(var s=2;s{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>s});var r=t(87462),a=(t(67294),t(3905));const i={},c=void 0,o={unversionedId:"sdk/reference/interfaces/IChainTxReference",id:"sdk/reference/interfaces/IChainTxReference",title:"IChainTxReference",description:"@vocdoni/sdk / Exports / IChainTxReference",source:"@site/docs/sdk/reference/interfaces/IChainTxReference.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainTxReference",permalink:"/sdk/reference/interfaces/IChainTxReference",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainTxListResponse",permalink:"/sdk/reference/interfaces/IChainTxListResponse"},next:{title:"IChainValidator",permalink:"/sdk/reference/interfaces/IChainValidator"}},l={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"blockHeight",id:"blockheight",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"transactionHash",id:"transactionhash",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"transactionIndex",id:"transactionindex",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"transactionNumber",id:"transactionnumber",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"transactionType",id:"transactiontype",level:3},{value:"Defined in",id:"defined-in-4",level:4}],p={toc:s};function d(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IChainTxReference"),(0,a.kt)("h1",{id:"interface-ichaintxreference"},"Interface: IChainTxReference"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainTxReference#blockheight"},"blockHeight")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainTxReference#transactionhash"},"transactionHash")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainTxReference#transactionindex"},"transactionIndex")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainTxReference#transactionnumber"},"transactionNumber")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainTxReference#transactiontype"},"transactionType"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"blockheight"},"blockHeight"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"blockHeight"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of the block where the transaction is."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L193"},"api/chain.ts:193")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"transactionhash"},"transactionHash"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"transactionHash"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The hash of the transaction."),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L188"},"api/chain.ts:188")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"transactionindex"},"transactionIndex"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"transactionIndex"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The index of the transaction inside the block."),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L198"},"api/chain.ts:198")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"transactionnumber"},"transactionNumber"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"transactionNumber"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"The number of the transaction."),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L183"},"api/chain.ts:183")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"transactiontype"},"transactionType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"transactionType"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/enums/TransactionType"},(0,a.kt)("inlineCode",{parentName:"a"},"TransactionType"))),(0,a.kt)("p",null,"The type of the transaction."),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L203"},"api/chain.ts:203")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/db5a5176.aebdcd70.js b/assets/js/db5a5176.aebdcd70.js deleted file mode 100644 index d9f175300..000000000 --- a/assets/js/db5a5176.aebdcd70.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1173],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>o});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),d=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},u=function(e){var t=d(e.components);return a.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),k=d(n),o=r,m=k["".concat(p,".").concat(o)]||k[o]||c[o]||i;return n?a.createElement(m,s(s({ref:t},u),{},{components:n})):a.createElement(m,s({ref:t},u))}));function o(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,s=new Array(i);s[0]=k;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:r,s[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var a=n(87462),r=(n(67294),n(3905));const i={},s=void 0,l={unversionedId:"sdk/reference/classes/OffchainCensus",id:"sdk/reference/classes/OffchainCensus",title:"OffchainCensus",description:"@vocdoni/sdk / Exports / OffchainCensus",source:"@site/docs/sdk/reference/classes/OffchainCensus.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/OffchainCensus",permalink:"/sdk/reference/classes/OffchainCensus",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"MultiChoiceElection",permalink:"/sdk/reference/classes/MultiChoiceElection"},next:{title:"PlainCensus",permalink:"/sdk/reference/classes/PlainCensus"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_censusId",id:"_censusid",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_censusURI",id:"_censusuri",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_participants",id:"_participants",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"_type",id:"_type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"censusId",id:"censusid",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isPublished",id:"ispublished",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"participants",id:"participants",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"type",id:"type",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"weight",id:"weight",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Methods",id:"methods-1",level:2},{value:"addParticipants",id:"addparticipants",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"checkParticipant",id:"checkparticipant",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"removeParticipant",id:"removeparticipant",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"censusTypeFromCensusOrigin",id:"censustypefromcensusorigin",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-21",level:4}],u={toc:d};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / OffchainCensus"),(0,r.kt)("h1",{id:"class-offchaincensus"},"Class: OffchainCensus"),(0,r.kt)("p",null,"Represents an offchain census"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,r.kt)("inlineCode",{parentName:"a"},"Census"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"OffchainCensus"))),(0,r.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/PlainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PlainCensus"))),(0,r.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/WeightedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"WeightedCensus"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#_censusid"},"_","censusId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#_censusuri"},"_","censusURI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#_participants"},"_","participants")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#_type"},"_","type"))),(0,r.kt)("h3",{id:"accessors"},"Accessors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#censusid"},"censusId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#censusuri"},"censusURI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#ispublished"},"isPublished")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#participants"},"participants")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#size"},"size")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#type"},"type")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#weight"},"weight"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#addparticipants"},"addParticipants")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#checkparticipant"},"checkParticipant")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#removeparticipant"},"removeParticipant")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new OffchainCensus"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))),(0,r.kt)("p",null,"Constructs an offchain census"),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/OffchainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#constructor"},"constructor")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L19"},"types/census/offchain.ts:19")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"_censusid"},"_","censusId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","censusId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_censusid"},"_censusId")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L12"},"types/census/census.ts:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_censusuri"},"_","censusURI"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","censusURI"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_censusuri"},"_censusURI")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L13"},"types/census/census.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_participants"},"_","participants"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","participants"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L14"},"types/census/offchain.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_type"},"_","type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","type"),": ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_type"},"_type")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L14"},"types/census/census.ts:14")),(0,r.kt)("h2",{id:"accessors-1"},"Accessors"),(0,r.kt)("h3",{id:"censusid"},"censusId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"censusId"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,"Census.censusId"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L35"},"types/census/census.ts:35")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"censusId"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,"Census.censusId"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L39"},"types/census/census.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censusuri"},"censusURI"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"censusURI"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,"Census.censusURI"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L43"},"types/census/census.ts:43")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"censusURI"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,"Census.censusURI"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L47"},"types/census/census.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ispublished"},"isPublished"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"isPublished"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,"Census.isPublished"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L75"},"types/census/census.ts:75")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"participants"},"participants"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"participants"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]"),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L45"},"types/census/offchain.ts:45")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"participants"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L49"},"types/census/offchain.ts:49")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"size"},"size"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"size"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,r.kt)("p",null,"Census.size"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L59"},"types/census/census.ts:59")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"size"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,r.kt)("p",null,"Census.size"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L63"},"types/census/census.ts:63")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"type"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,r.kt)("p",null,"Census.type"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L51"},"types/census/census.ts:51")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"type"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType")))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,r.kt)("p",null,"Census.type"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L55"},"types/census/census.ts:55")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"weight"},"weight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"weight"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"bigint")),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"bigint")),(0,r.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,r.kt)("p",null,"Census.weight"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L67"},"types/census/census.ts:67")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"weight"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,r.kt)("p",null,"Census.weight"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L71"},"types/census/census.ts:71")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"addparticipants"},"addParticipants"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addParticipants"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participants")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L25"},"types/census/offchain.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"checkparticipant"},"checkParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"participant"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participant")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")))))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L35"},"types/census/offchain.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removeparticipant"},"removeParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/offchain.ts#L41"},"types/census/offchain.ts:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censustypefromcensusorigin"},"censusTypeFromCensusOrigin"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"censusTypeFromCensusOrigin"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusOrigin"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusOrigin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#censustypefromcensusorigin"},"censusTypeFromCensusOrigin")),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L81"},"types/census/census.ts:81")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/db5a5176.ed9d2cec.js b/assets/js/db5a5176.ed9d2cec.js new file mode 100644 index 000000000..7ae1dc041 --- /dev/null +++ b/assets/js/db5a5176.ed9d2cec.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1173],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>c});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),d=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},u=function(e){var t=d(e.components);return a.createElement(p.Provider,{value:t},e.children)},o={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),k=d(n),c=r,m=k["".concat(p,".").concat(c)]||k[c]||o[c]||i;return n?a.createElement(m,s(s({ref:t},u),{},{components:n})):a.createElement(m,s({ref:t},u))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,s=new Array(i);s[0]=k;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:r,s[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>o,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var a=n(87462),r=(n(67294),n(3905));const i={},s=void 0,l={unversionedId:"sdk/reference/classes/OffchainCensus",id:"sdk/reference/classes/OffchainCensus",title:"OffchainCensus",description:"@vocdoni/sdk / Exports / OffchainCensus",source:"@site/docs/sdk/reference/classes/OffchainCensus.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/OffchainCensus",permalink:"/sdk/reference/classes/OffchainCensus",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"MultiChoiceElection",permalink:"/sdk/reference/classes/MultiChoiceElection"},next:{title:"PlainCensus",permalink:"/sdk/reference/classes/PlainCensus"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_censusId",id:"_censusid",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_censusURI",id:"_censusuri",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_participants",id:"_participants",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"_type",id:"_type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"censusId",id:"censusid",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"isPublished",id:"ispublished",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"participants",id:"participants",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"type",id:"type",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"weight",id:"weight",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Methods",id:"methods-1",level:2},{value:"addParticipants",id:"addparticipants",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"checkParticipant",id:"checkparticipant",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"removeParticipant",id:"removeparticipant",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"censusTypeFromCensusOrigin",id:"censustypefromcensusorigin",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-21",level:4}],u={toc:d};function o(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / OffchainCensus"),(0,r.kt)("h1",{id:"class-offchaincensus"},"Class: OffchainCensus"),(0,r.kt)("p",null,"Represents an offchain census"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"Census"},(0,r.kt)("inlineCode",{parentName:"a"},"Census"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"OffchainCensus"))),(0,r.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"PlainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"PlainCensus"))),(0,r.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"WeightedCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"WeightedCensus"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"OffchainCensus#constructor"},"constructor"))),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#_censusid"},"_","censusId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#_censusuri"},"_","censusURI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#_participants"},"_","participants")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/OffchainCensus#_type"},"_","type"))),(0,r.kt)("h3",{id:"accessors"},"Accessors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"OffchainCensus#censusid"},"censusId")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"OffchainCensus#censusuri"},"censusURI")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"OffchainCensus#ispublished"},"isPublished")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"OffchainCensus#participants"},"participants")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"OffchainCensus#size"},"size")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"OffchainCensus#type"},"type")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"OffchainCensus#weight"},"weight"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"OffchainCensus#addparticipants"},"addParticipants")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"OffchainCensus#checkparticipant"},"checkParticipant")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"OffchainCensus#removeparticipant"},"removeParticipant")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"OffchainCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new OffchainCensus"),"(): ",(0,r.kt)("a",{parentName:"p",href:"OffchainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))),(0,r.kt)("p",null,"Constructs an offchain census"),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"OffchainCensus"},(0,r.kt)("inlineCode",{parentName:"a"},"OffchainCensus"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,r.kt)("a",{parentName:"p",href:"Census#constructor"},"constructor")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L19"},"types/census/offchain.ts:19")),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"_censusid"},"_","censusId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","censusId"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"Census"},"Census"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_censusid"},"_censusId")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L12"},"types/census/census.ts:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_censusuri"},"_","censusURI"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","censusURI"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"Census"},"Census"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_censusuri"},"_censusURI")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L13"},"types/census/census.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_participants"},"_","participants"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"_","participants"),": ",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L14"},"types/census/offchain.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_type"},"_","type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,r.kt)("strong",{parentName:"p"},"_","type"),": ",(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"Census"},"Census"),".",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_type"},"_type")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L14"},"types/census/census.ts:14")),(0,r.kt)("h2",{id:"accessors-1"},"Accessors"),(0,r.kt)("h3",{id:"censusid"},"censusId"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"censusId"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,"Census.censusId"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L35"},"types/census/census.ts:35")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"censusId"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,"Census.censusId"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L39"},"types/census/census.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censusuri"},"censusURI"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"censusURI"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,"Census.censusURI"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L43"},"types/census/census.ts:43")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"censusURI"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,"Census.censusURI"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L47"},"types/census/census.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ispublished"},"isPublished"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"isPublished"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,"Census.isPublished"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L75"},"types/census/census.ts:75")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"participants"},"participants"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"participants"),"(): ",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]"),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L45"},"types/census/offchain.ts:45")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"participants"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L49"},"types/census/offchain.ts:49")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"size"},"size"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"size"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,r.kt)("p",null,"Census.size"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L59"},"types/census/census.ts:59")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"size"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,r.kt)("p",null,"Census.size"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L63"},"types/census/census.ts:63")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"type"),"(): ",(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,r.kt)("p",null,"Census.type"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L51"},"types/census/census.ts:51")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"type"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType")))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,r.kt)("p",null,"Census.type"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L55"},"types/census/census.ts:55")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"weight"},"weight"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"get")," ",(0,r.kt)("strong",{parentName:"p"},"weight"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"bigint")),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"bigint")),(0,r.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,r.kt)("p",null,"Census.weight"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L67"},"types/census/census.ts:67")),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"set")," ",(0,r.kt)("strong",{parentName:"p"},"weight"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,r.kt)("p",null,"Census.weight"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L71"},"types/census/census.ts:71")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"addparticipants"},"addParticipants"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addParticipants"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participants")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")),"[]")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L25"},"types/census/offchain.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"checkparticipant"},"checkParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"participant"),"): ",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participant")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant")))))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensusParticipant"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensusParticipant"))),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L35"},"types/census/offchain.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removeparticipant"},"removeParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/offchain.ts#L41"},"types/census/offchain.ts:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"censustypefromcensusorigin"},"censusTypeFromCensusOrigin"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"censusTypeFromCensusOrigin"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"censusOrigin"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"censusOrigin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,r.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,r.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,r.kt)("a",{parentName:"p",href:"Census#censustypefromcensusorigin"},"censusTypeFromCensusOrigin")),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L81"},"types/census/census.ts:81")))}o.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ddb99459.04fc37ab.js b/assets/js/ddb99459.04fc37ab.js new file mode 100644 index 000000000..676784fd1 --- /dev/null +++ b/assets/js/ddb99459.04fc37ab.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9379],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var p=r.createContext({}),s=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=s(e.components);return r.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),m=s(n),k=i,f=m["".concat(p,".").concat(k)]||m[k]||c[k]||a;return n?r.createElement(f,l(l({ref:t},d),{},{components:n})):r.createElement(f,l({ref:t},d))}));function k(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>c,frontMatter:()=>a,metadata:()=>o,toc:()=>s});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IApprovalElectionParameters",id:"sdk/reference/interfaces/IApprovalElectionParameters",title:"IApprovalElectionParameters",description:"@vocdoni/sdk / Exports / IApprovalElectionParameters",source:"@site/docs/sdk/reference/interfaces/IApprovalElectionParameters.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IApprovalElectionParameters",permalink:"/sdk/reference/interfaces/IApprovalElectionParameters",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IAccountsListResponse",permalink:"/sdk/reference/interfaces/IAccountsListResponse"},next:{title:"IBlockTransactionsResponse",permalink:"/sdk/reference/interfaces/IBlockTransactionsResponse"}},p={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"census",id:"census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"endDate",id:"enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"header",id:"header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"meta",id:"meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"questions",id:"questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"startDate",id:"startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"voteType",id:"votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-13",level:4}],d={toc:s};function c(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IApprovalElectionParameters"),(0,i.kt)("h1",{id:"interface-iapprovalelectionparameters"},"Interface: IApprovalElectionParameters"),(0,i.kt)("p",null,"Define election parameters."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"IElectionParameters"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"IApprovalElectionParameters"))))),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IApprovalElectionParameters#addsdkversion"},"addSDKVersion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IApprovalElectionParameters#census"},"census")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IApprovalElectionParameters#description"},"description")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IApprovalElectionParameters#electiontype"},"electionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IApprovalElectionParameters#enddate"},"endDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IApprovalElectionParameters#header"},"header")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IApprovalElectionParameters#maxcensussize"},"maxCensusSize")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IApprovalElectionParameters#meta"},"meta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IApprovalElectionParameters#questions"},"questions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IApprovalElectionParameters#startdate"},"startDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IApprovalElectionParameters#streamuri"},"streamUri")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IApprovalElectionParameters#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IApprovalElectionParameters#title"},"title")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IApprovalElectionParameters#votetype"},"voteType"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"addSDKVersion"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Used to add the SDK version to the election metadata"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#addsdkversion"},"addSDKVersion")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L155"},"types/election/election.ts:155")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"census"},"census"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"census"),": ",(0,i.kt)("a",{parentName:"p",href:"../classes/Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census"))),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#census"},"census")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L129"},"types/election/election.ts:129")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Election description"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#description"},"description")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L114"},"types/election/election.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electiontype"},"electionType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"electionType"),": ",(0,i.kt)("a",{parentName:"p",href:"IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#electiontype"},"electionType")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L131"},"types/election/election.ts:131")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enddate"},"endDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"endDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#enddate"},"endDate")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L128"},"types/election/election.ts:128")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"header"},"header"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"header"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Election header image url."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#header"},"header")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L118"},"types/election/election.ts:118")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Is used to limit the number of votes that can be registered for an election. This feature helps to prevent any\npotential overflow of the blockchain when the number of votes goes beyond the maximum limit."),(0,i.kt)("p",null,"In order to create an election, the creator is required to set the MaxCensusSize parameter to a proper value.\nTypically, this value should be equal to the size of the census. If the MaxCensusSize parameter is set to 0, an\nerror will occur and the election cannot be created."),(0,i.kt)("p",null,"If the number of votes exceeds this limit, will throw ",(0,i.kt)("inlineCode",{parentName:"p"},"Max census size for the election is greater than allowed\nsize")," error."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#maxcensussize"},"maxCensusSize")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L145"},"types/election/election.ts:145")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("p",null,"Metadata (anything added by the election creator)"),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#meta"},"meta")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L126"},"types/election/election.ts:126")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"questions"},"questions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"questions"),": ",(0,i.kt)("a",{parentName:"p",href:"IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#questions"},"questions")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L132"},"types/election/election.ts:132")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"startdate"},"startDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"startDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#startdate"},"startDate")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L127"},"types/election/election.ts:127")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"streamuri"},"streamUri"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"streamUri"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Election stream Uri (ex: a video url)"),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#streamuri"},"streamUri")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L122"},"types/election/election.ts:122")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Is used to remove the secret identities of the voters once the process is done."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L150"},"types/election/election.ts:150")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Election title"),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#title"},"title")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L110"},"types/election/election.ts:110")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votetype"},"voteType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"voteType"),": ",(0,i.kt)("a",{parentName:"p",href:"IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"IElectionParameters#votetype"},"voteType")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L130"},"types/election/election.ts:130")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ddb99459.ec7209ff.js b/assets/js/ddb99459.ec7209ff.js deleted file mode 100644 index b6c6efe4a..000000000 --- a/assets/js/ddb99459.ec7209ff.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9379],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),m=p(n),f=i,k=m["".concat(s,".").concat(f)]||m[f]||c[f]||a;return n?r.createElement(k,l(l({ref:t},d),{},{components:n})):r.createElement(k,l({ref:t},d))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=m;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>c,frontMatter:()=>a,metadata:()=>o,toc:()=>p});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IApprovalElectionParameters",id:"sdk/reference/interfaces/IApprovalElectionParameters",title:"IApprovalElectionParameters",description:"@vocdoni/sdk / Exports / IApprovalElectionParameters",source:"@site/docs/sdk/reference/interfaces/IApprovalElectionParameters.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IApprovalElectionParameters",permalink:"/sdk/reference/interfaces/IApprovalElectionParameters",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IAccountsListResponse",permalink:"/sdk/reference/interfaces/IAccountsListResponse"},next:{title:"IBlockTransactionsResponse",permalink:"/sdk/reference/interfaces/IBlockTransactionsResponse"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"census",id:"census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"endDate",id:"enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"header",id:"header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"meta",id:"meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"questions",id:"questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"startDate",id:"startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"voteType",id:"votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-13",level:4}],d={toc:p};function c(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IApprovalElectionParameters"),(0,i.kt)("h1",{id:"interface-iapprovalelectionparameters"},"Interface: IApprovalElectionParameters"),(0,i.kt)("p",null,"Define election parameters."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"IApprovalElectionParameters"))))),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IApprovalElectionParameters#addsdkversion"},"addSDKVersion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IApprovalElectionParameters#census"},"census")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IApprovalElectionParameters#description"},"description")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IApprovalElectionParameters#electiontype"},"electionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IApprovalElectionParameters#enddate"},"endDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IApprovalElectionParameters#header"},"header")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IApprovalElectionParameters#maxcensussize"},"maxCensusSize")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IApprovalElectionParameters#meta"},"meta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IApprovalElectionParameters#questions"},"questions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IApprovalElectionParameters#startdate"},"startDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IApprovalElectionParameters#streamuri"},"streamUri")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IApprovalElectionParameters#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IApprovalElectionParameters#title"},"title")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IApprovalElectionParameters#votetype"},"voteType"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"addSDKVersion"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Used to add the SDK version to the election metadata"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#addsdkversion"},"addSDKVersion")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L155"},"types/election/election.ts:155")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"census"},"census"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"census"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census"))),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#census"},"census")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L129"},"types/election/election.ts:129")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Election description"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#description"},"description")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L114"},"types/election/election.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electiontype"},"electionType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"electionType"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#electiontype"},"electionType")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L131"},"types/election/election.ts:131")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enddate"},"endDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"endDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#enddate"},"endDate")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L128"},"types/election/election.ts:128")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"header"},"header"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"header"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Election header image url."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#header"},"header")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L118"},"types/election/election.ts:118")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Is used to limit the number of votes that can be registered for an election. This feature helps to prevent any\npotential overflow of the blockchain when the number of votes goes beyond the maximum limit."),(0,i.kt)("p",null,"In order to create an election, the creator is required to set the MaxCensusSize parameter to a proper value.\nTypically, this value should be equal to the size of the census. If the MaxCensusSize parameter is set to 0, an\nerror will occur and the election cannot be created."),(0,i.kt)("p",null,"If the number of votes exceeds this limit, will throw ",(0,i.kt)("inlineCode",{parentName:"p"},"Max census size for the election is greater than allowed\nsize")," error."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#maxcensussize"},"maxCensusSize")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L145"},"types/election/election.ts:145")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("p",null,"Metadata (anything added by the election creator)"),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#meta"},"meta")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L126"},"types/election/election.ts:126")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"questions"},"questions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"questions"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#questions"},"questions")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L132"},"types/election/election.ts:132")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"startdate"},"startDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"startDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#startdate"},"startDate")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L127"},"types/election/election.ts:127")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"streamuri"},"streamUri"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"streamUri"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Election stream Uri (ex: a video url)"),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#streamuri"},"streamUri")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L122"},"types/election/election.ts:122")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Is used to remove the secret identities of the voters once the process is done."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L150"},"types/election/election.ts:150")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Election title"),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#title"},"title")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L110"},"types/election/election.ts:110")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votetype"},"voteType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"voteType"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters"},"IElectionParameters"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionParameters#votetype"},"voteType")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L130"},"types/election/election.ts:130")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/dded7333.475b6d03.js b/assets/js/dded7333.475b6d03.js deleted file mode 100644 index 321f7249d..000000000 --- a/assets/js/dded7333.475b6d03.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2329],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>c});var a=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=a.createContext({}),p=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},o=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),u=p(n),c=i,m=u["".concat(s,".").concat(c)]||u[c]||k[c]||r;return n?a.createElement(m,l(l({ref:t},o),{},{components:n})):a.createElement(m,l({ref:t},o))}));function c(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=u;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d.mdxType="string"==typeof e?e:i,l[1]=d;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>k,frontMatter:()=>r,metadata:()=>d,toc:()=>p});var a=n(87462),i=(n(67294),n(3905));const r={},l=void 0,d={unversionedId:"sdk/reference/classes/UnpublishedElection",id:"sdk/reference/classes/UnpublishedElection",title:"UnpublishedElection",description:"@vocdoni/sdk / Exports / UnpublishedElection",source:"@site/docs/sdk/reference/classes/UnpublishedElection.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/UnpublishedElection",permalink:"/sdk/reference/classes/UnpublishedElection",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"TokenCensus",permalink:"/sdk/reference/classes/TokenCensus"},next:{title:"VocdoniCensus3Client",permalink:"/sdk/reference/classes/VocdoniCensus3Client"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_addSDKVersion",id:"_addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_census",id:"_census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_description",id:"_description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"_electionType",id:"_electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"_endDate",id:"_enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"_header",id:"_header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"_maxCensusSize",id:"_maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"_meta",id:"_meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"_questions",id:"_questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"_startDate",id:"_startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"_streamUri",id:"_streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"_temporarySecretIdentity",id:"_temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"_title",id:"_title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"_voteType",id:"_votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"census",id:"census",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"description",id:"description",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-6",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"duration",id:"duration",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Overrides",id:"overrides-7",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-8",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"endDate",id:"enddate",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Overrides",id:"overrides-9",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Overrides",id:"overrides-10",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"header",id:"header",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Overrides",id:"overrides-11",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Overrides",id:"overrides-12",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Overrides",id:"overrides-13",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Overrides",id:"overrides-14",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"meta",id:"meta",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Overrides",id:"overrides-15",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Overrides",id:"overrides-16",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"questions",id:"questions",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Overrides",id:"overrides-17",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Overrides",id:"overrides-18",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"startDate",id:"startdate",level:3},{value:"Returns",id:"returns-20",level:4},{value:"Overrides",id:"overrides-19",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Overrides",id:"overrides-20",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Returns",id:"returns-22",level:4},{value:"Overrides",id:"overrides-21",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Overrides",id:"overrides-22",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Returns",id:"returns-24",level:4},{value:"Overrides",id:"overrides-23",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Overrides",id:"overrides-24",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"title",id:"title",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Overrides",id:"overrides-25",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Overrides",id:"overrides-26",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"voteType",id:"votetype",level:3},{value:"Returns",id:"returns-28",level:4},{value:"Overrides",id:"overrides-27",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Overrides",id:"overrides-28",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"Methods",id:"methods-1",level:2},{value:"addQuestion",id:"addquestion",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"generateEnvelopeType",id:"generateenvelopetype",level:3},{value:"Returns",id:"returns-31",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"generateMetadata",id:"generatemetadata",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"generateMode",id:"generatemode",level:3},{value:"Returns",id:"returns-33",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"generateVoteOptions",id:"generatevoteoptions",level:3},{value:"Returns",id:"returns-34",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"removeQuestion",id:"removequestion",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"from",id:"from",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"fullElectionType",id:"fullelectiontype",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-38",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"fullVoteType",id:"fullvotetype",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-39",level:4},{value:"Defined in",id:"defined-in-53",level:4}],o={toc:p};function k(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / UnpublishedElection"),(0,i.kt)("h1",{id:"class-unpublishedelection"},"Class: UnpublishedElection"),(0,i.kt)("p",null,"Represents an unpublished election"),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},(0,i.kt)("inlineCode",{parentName:"a"},"Election"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"UnpublishedElection"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/MultiChoiceElection"},(0,i.kt)("inlineCode",{parentName:"a"},"MultiChoiceElection"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/BudgetElection"},(0,i.kt)("inlineCode",{parentName:"a"},"BudgetElection"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ApprovalElection"},(0,i.kt)("inlineCode",{parentName:"a"},"ApprovalElection"))))),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"constructors"},"Constructors"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#constructor"},"constructor"))),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_addsdkversion"},"_","addSDKVersion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_census"},"_","census")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_description"},"_","description")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_electiontype"},"_","electionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_enddate"},"_","endDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_header"},"_","header")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_maxcensussize"},"_","maxCensusSize")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_meta"},"_","meta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_questions"},"_","questions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_startdate"},"_","startDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_streamuri"},"_","streamUri")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_temporarysecretidentity"},"_","temporarySecretIdentity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_title"},"_","title")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_votetype"},"_","voteType"))),(0,i.kt)("h3",{id:"accessors"},"Accessors"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#addsdkversion"},"addSDKVersion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#census"},"census")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#description"},"description")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#duration"},"duration")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#electiontype"},"electionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#enddate"},"endDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#header"},"header")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#maxcensussize"},"maxCensusSize")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#meta"},"meta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#questions"},"questions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#startdate"},"startDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#streamuri"},"streamUri")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#title"},"title")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#votetype"},"voteType"))),(0,i.kt)("h3",{id:"methods"},"Methods"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#addquestion"},"addQuestion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#generateenvelopetype"},"generateEnvelopeType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#generatemetadata"},"generateMetadata")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#generatemode"},"generateMode")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#generatevoteoptions"},"generateVoteOptions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#get"},"get")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#removequestion"},"removeQuestion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#from"},"from")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#fullelectiontype"},"fullElectionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#fullvotetype"},"fullVoteType"))),(0,i.kt)("h2",{id:"constructors-1"},"Constructors"),(0,i.kt)("h3",{id:"constructor"},"constructor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"new UnpublishedElection"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("p",null,"Constructs an unpublished election"),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"params")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IElectionParameters"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"Election parameters")))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#constructor"},"constructor")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L23"},"types/election/unpublished.ts:23")),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"_addsdkversion"},"_","addSDKVersion"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","addSDKVersion"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_addsdkversion"},"_addSDKVersion")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L175"},"types/election/election.ts:175")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_census"},"_","census"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","census"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census"))),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_census"},"_census")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L172"},"types/election/election.ts:172")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_description"},"_","description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_description"},"_description")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L163"},"types/election/election.ts:163")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_electiontype"},"_","electionType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","electionType"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_electiontype"},"_electionType")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L169"},"types/election/election.ts:169")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_enddate"},"_","endDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","endDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_enddate"},"_endDate")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L168"},"types/election/election.ts:168")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_header"},"_","header"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","header"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_header"},"_header")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L164"},"types/election/election.ts:164")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_maxcensussize"},"_","maxCensusSize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","maxCensusSize"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_maxcensussize"},"_maxCensusSize")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L173"},"types/election/election.ts:173")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_meta"},"_","meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_meta"},"_meta")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L166"},"types/election/election.ts:166")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_questions"},"_","questions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","questions"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_questions"},"_questions")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L171"},"types/election/election.ts:171")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_startdate"},"_","startDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","startDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_startdate"},"_startDate")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L167"},"types/election/election.ts:167")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_streamuri"},"_","streamUri"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","streamUri"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_streamuri"},"_streamUri")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L165"},"types/election/election.ts:165")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_temporarysecretidentity"},"_","temporarySecretIdentity"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","temporarySecretIdentity"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_temporarysecretidentity"},"_temporarySecretIdentity")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L174"},"types/election/election.ts:174")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_title"},"_","title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_title"},"_title")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L162"},"types/election/election.ts:162")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_votetype"},"_","voteType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","voteType"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_votetype"},"_voteType")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L170"},"types/election/election.ts:170")),(0,i.kt)("h2",{id:"accessors-1"},"Accessors"),(0,i.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"addSDKVersion"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,"Election.addSDKVersion"),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L275"},"types/election/unpublished.ts:275")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"addSDKVersion"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-2"},"Overrides"),(0,i.kt)("p",null,"Election.addSDKVersion"),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L279"},"types/election/unpublished.ts:279")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"census"},"census"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"census"),"(): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census"))),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census"))),(0,i.kt)("h4",{id:"overrides-3"},"Overrides"),(0,i.kt)("p",null,"Election.census"),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L249"},"types/election/unpublished.ts:249")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"census"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-2"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/classes/Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census")))))),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-4"},"Overrides"),(0,i.kt)("p",null,"Election.census"),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L253"},"types/election/unpublished.ts:253")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"description"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"overrides-5"},"Overrides"),(0,i.kt)("p",null,"Election.description"),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L173"},"types/election/unpublished.ts:173")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"description"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-3"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,i.kt)("h4",{id:"returns-6"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-6"},"Overrides"),(0,i.kt)("p",null,"Election.description"),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L177"},"types/election/unpublished.ts:177")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"duration"},"duration"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"duration"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"returns-7"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L138"},"types/election/unpublished.ts:138")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electiontype"},"electionType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"electionType"),"(): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"returns-8"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"overrides-7"},"Overrides"),(0,i.kt)("p",null,"Election.electionType"),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L225"},"types/election/unpublished.ts:225")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"electionType"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-4"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType")))))),(0,i.kt)("h4",{id:"returns-9"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-8"},"Overrides"),(0,i.kt)("p",null,"Election.electionType"),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L229"},"types/election/unpublished.ts:229")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enddate"},"endDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"endDate"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"returns-10"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"overrides-9"},"Overrides"),(0,i.kt)("p",null,"Election.endDate"),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L215"},"types/election/unpublished.ts:215")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"endDate"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-5"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,i.kt)("h4",{id:"returns-11"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-10"},"Overrides"),(0,i.kt)("p",null,"Election.endDate"),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L219"},"types/election/unpublished.ts:219")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"header"},"header"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"header"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-12"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"overrides-11"},"Overrides"),(0,i.kt)("p",null,"Election.header"),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L181"},"types/election/unpublished.ts:181")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"header"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-6"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-13"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-12"},"Overrides"),(0,i.kt)("p",null,"Election.header"),(0,i.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L185"},"types/election/unpublished.ts:185")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"maxCensusSize"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"returns-14"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"overrides-13"},"Overrides"),(0,i.kt)("p",null,"Election.maxCensusSize"),(0,i.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L258"},"types/election/unpublished.ts:258")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"maxCensusSize"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-7"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-15"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-14"},"Overrides"),(0,i.kt)("p",null,"Election.maxCensusSize"),(0,i.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L262"},"types/election/unpublished.ts:262")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"returns-16"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"overrides-15"},"Overrides"),(0,i.kt)("p",null,"Election.meta"),(0,i.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L197"},"types/election/unpublished.ts:197")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-8"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"returns-17"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-16"},"Overrides"),(0,i.kt)("p",null,"Election.meta"),(0,i.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L201"},"types/election/unpublished.ts:201")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"questions"},"questions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"questions"),"(): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"returns-18"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"overrides-17"},"Overrides"),(0,i.kt)("p",null,"Election.questions"),(0,i.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L241"},"types/election/unpublished.ts:241")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"questions"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-9"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]")))),(0,i.kt)("h4",{id:"returns-19"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-18"},"Overrides"),(0,i.kt)("p",null,"Election.questions"),(0,i.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L245"},"types/election/unpublished.ts:245")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"startdate"},"startDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"startDate"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"returns-20"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"overrides-19"},"Overrides"),(0,i.kt)("p",null,"Election.startDate"),(0,i.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L206"},"types/election/unpublished.ts:206")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"startDate"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-10"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,i.kt)("h4",{id:"returns-21"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-20"},"Overrides"),(0,i.kt)("p",null,"Election.startDate"),(0,i.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L210"},"types/election/unpublished.ts:210")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"streamuri"},"streamUri"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"streamUri"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-22"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"overrides-21"},"Overrides"),(0,i.kt)("p",null,"Election.streamUri"),(0,i.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L189"},"types/election/unpublished.ts:189")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"streamUri"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-11"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-23"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-22"},"Overrides"),(0,i.kt)("p",null,"Election.streamUri"),(0,i.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L193"},"types/election/unpublished.ts:193")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"returns-24"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"overrides-23"},"Overrides"),(0,i.kt)("p",null,"Election.temporarySecretIdentity"),(0,i.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L267"},"types/election/unpublished.ts:267")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-12"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,i.kt)("h4",{id:"returns-25"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-24"},"Overrides"),(0,i.kt)("p",null,"Election.temporarySecretIdentity"),(0,i.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L271"},"types/election/unpublished.ts:271")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"title"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"returns-26"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"overrides-25"},"Overrides"),(0,i.kt)("p",null,"Election.title"),(0,i.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L164"},"types/election/unpublished.ts:164")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"title"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-13"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,i.kt)("h4",{id:"returns-27"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-26"},"Overrides"),(0,i.kt)("p",null,"Election.title"),(0,i.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L168"},"types/election/unpublished.ts:168")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votetype"},"voteType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"voteType"),"(): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"returns-28"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"overrides-27"},"Overrides"),(0,i.kt)("p",null,"Election.voteType"),(0,i.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L233"},"types/election/unpublished.ts:233")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"voteType"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-14"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,i.kt)("h4",{id:"returns-29"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-28"},"Overrides"),(0,i.kt)("p",null,"Election.voteType"),(0,i.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L237"},"types/election/unpublished.ts:237")),(0,i.kt)("h2",{id:"methods-1"},"Methods"),(0,i.kt)("h3",{id:"addquestion"},"addQuestion"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"addQuestion"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"title"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"description"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"choices"),"): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("h4",{id:"parameters-15"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"title")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"description")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"choices")),(0,i.kt)("td",{parentName:"tr",align:"left"},"(","{"," ",(0,i.kt)("inlineCode",{parentName:"td"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"value"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"number")," } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"td"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),">"," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"value"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"number")," })[]")))),(0,i.kt)("h4",{id:"returns-30"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L41"},"types/election/unpublished.ts:41")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generateenvelopetype"},"generateEnvelopeType"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"generateEnvelopeType"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"returns-31"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L144"},"types/election/unpublished.ts:144")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generatemetadata"},"generateMetadata"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"generateMetadata"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"metadata?"),"): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ElectionMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,i.kt)("h4",{id:"parameters-16"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"metadata?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/ElectionMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionMetadata")))))),(0,i.kt)("h4",{id:"returns-32"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ElectionMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,i.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L88"},"types/election/unpublished.ts:88")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generatemode"},"generateMode"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"generateMode"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"returns-33"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L154"},"types/election/unpublished.ts:154")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generatevoteoptions"},"generateVoteOptions"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"generateVoteOptions"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"returns-34"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L123"},"types/election/unpublished.ts:123")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"get"},"get"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"get"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"dot"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"parameters-17"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"dot")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-35"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#get"},"get")),(0,i.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L266"},"types/election/election.ts:266")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"removequestion"},"removeQuestion"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"removeQuestion"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"questionNumber"),"): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("h4",{id:"parameters-18"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"questionNumber")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-36"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L60"},"types/election/unpublished.ts:60")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"from"},"from"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"from"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("p",null,"Returns an unpublished election object"),(0,i.kt)("h4",{id:"parameters-19"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"params")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IElectionParameters"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"Unpublished Election parameters")))),(0,i.kt)("h4",{id:"returns-37"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#from"},"from")),(0,i.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L206"},"types/election/election.ts:206")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fullelectiontype"},"fullElectionType"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fullElectionType"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"parameters-20"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType")))))),(0,i.kt)("h4",{id:"returns-38"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L66"},"types/election/unpublished.ts:66")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fullvotetype"},"fullVoteType"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fullVoteType"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"parameters-21"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,i.kt)("h4",{id:"returns-39"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/unpublished.ts#L76"},"types/election/unpublished.ts:76")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/dded7333.f3855c11.js b/assets/js/dded7333.f3855c11.js new file mode 100644 index 000000000..bcea91695 --- /dev/null +++ b/assets/js/dded7333.f3855c11.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2329],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>m});var a=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function r(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var p=a.createContext({}),s=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},o=function(e){var t=s(e.components);return a.createElement(p.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,l=e.originalType,p=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),u=s(n),m=i,c=u["".concat(p,".").concat(m)]||u[m]||k[m]||l;return n?a.createElement(c,r(r({ref:t},o),{},{components:n})):a.createElement(c,r({ref:t},o))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=n.length,r=new Array(l);r[0]=u;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:i,r[1]=d;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>r,default:()=>k,frontMatter:()=>l,metadata:()=>d,toc:()=>s});var a=n(87462),i=(n(67294),n(3905));const l={},r=void 0,d={unversionedId:"sdk/reference/classes/UnpublishedElection",id:"sdk/reference/classes/UnpublishedElection",title:"UnpublishedElection",description:"@vocdoni/sdk / Exports / UnpublishedElection",source:"@site/docs/sdk/reference/classes/UnpublishedElection.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/UnpublishedElection",permalink:"/sdk/reference/classes/UnpublishedElection",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"TokenCensus",permalink:"/sdk/reference/classes/TokenCensus"},next:{title:"VocdoniCensus3Client",permalink:"/sdk/reference/classes/VocdoniCensus3Client"}},p={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_addSDKVersion",id:"_addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_census",id:"_census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_description",id:"_description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"_electionType",id:"_electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"_endDate",id:"_enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"_header",id:"_header",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"_maxCensusSize",id:"_maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"_meta",id:"_meta",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"_questions",id:"_questions",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"_startDate",id:"_startdate",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"_streamUri",id:"_streamuri",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"_temporarySecretIdentity",id:"_temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"_title",id:"_title",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"_voteType",id:"_votetype",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"census",id:"census",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"description",id:"description",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-6",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"duration",id:"duration",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Overrides",id:"overrides-7",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-8",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"endDate",id:"enddate",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Overrides",id:"overrides-9",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Overrides",id:"overrides-10",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"header",id:"header",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Overrides",id:"overrides-11",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Overrides",id:"overrides-12",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Returns",id:"returns-14",level:4},{value:"Overrides",id:"overrides-13",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Overrides",id:"overrides-14",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"meta",id:"meta",level:3},{value:"Returns",id:"returns-16",level:4},{value:"Overrides",id:"overrides-15",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Overrides",id:"overrides-16",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"questions",id:"questions",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Overrides",id:"overrides-17",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Overrides",id:"overrides-18",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"startDate",id:"startdate",level:3},{value:"Returns",id:"returns-20",level:4},{value:"Overrides",id:"overrides-19",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Overrides",id:"overrides-20",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Returns",id:"returns-22",level:4},{value:"Overrides",id:"overrides-21",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Overrides",id:"overrides-22",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Returns",id:"returns-24",level:4},{value:"Overrides",id:"overrides-23",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Overrides",id:"overrides-24",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"title",id:"title",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Overrides",id:"overrides-25",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Overrides",id:"overrides-26",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"voteType",id:"votetype",level:3},{value:"Returns",id:"returns-28",level:4},{value:"Overrides",id:"overrides-27",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Overrides",id:"overrides-28",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"Methods",id:"methods-1",level:2},{value:"addQuestion",id:"addquestion",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"generateEnvelopeType",id:"generateenvelopetype",level:3},{value:"Returns",id:"returns-31",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"generateMetadata",id:"generatemetadata",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"generateMode",id:"generatemode",level:3},{value:"Returns",id:"returns-33",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"generateVoteOptions",id:"generatevoteoptions",level:3},{value:"Returns",id:"returns-34",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"get",id:"get",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"removeQuestion",id:"removequestion",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"from",id:"from",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"fullElectionType",id:"fullelectiontype",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-38",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"fullVoteType",id:"fullvotetype",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-39",level:4},{value:"Defined in",id:"defined-in-53",level:4}],o={toc:s};function k(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / UnpublishedElection"),(0,i.kt)("h1",{id:"class-unpublishedelection"},"Class: UnpublishedElection"),(0,i.kt)("p",null,"Represents an unpublished election"),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"Election"},(0,i.kt)("inlineCode",{parentName:"a"},"Election"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"UnpublishedElection"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"MultiChoiceElection"},(0,i.kt)("inlineCode",{parentName:"a"},"MultiChoiceElection"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"BudgetElection"},(0,i.kt)("inlineCode",{parentName:"a"},"BudgetElection"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"ApprovalElection"},(0,i.kt)("inlineCode",{parentName:"a"},"ApprovalElection"))))),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"constructors"},"Constructors"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#constructor"},"constructor"))),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_addsdkversion"},"_","addSDKVersion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_census"},"_","census")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_description"},"_","description")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_electiontype"},"_","electionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_enddate"},"_","endDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_header"},"_","header")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_maxcensussize"},"_","maxCensusSize")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_meta"},"_","meta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_questions"},"_","questions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_startdate"},"_","startDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_streamuri"},"_","streamUri")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_temporarysecretidentity"},"_","temporarySecretIdentity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_title"},"_","title")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/UnpublishedElection#_votetype"},"_","voteType"))),(0,i.kt)("h3",{id:"accessors"},"Accessors"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#addsdkversion"},"addSDKVersion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#census"},"census")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#description"},"description")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#duration"},"duration")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#electiontype"},"electionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#enddate"},"endDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#header"},"header")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#maxcensussize"},"maxCensusSize")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#meta"},"meta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#questions"},"questions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#startdate"},"startDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#streamuri"},"streamUri")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#title"},"title")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#votetype"},"voteType"))),(0,i.kt)("h3",{id:"methods"},"Methods"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#addquestion"},"addQuestion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#generateenvelopetype"},"generateEnvelopeType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#generatemetadata"},"generateMetadata")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#generatemode"},"generateMode")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#generatevoteoptions"},"generateVoteOptions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#get"},"get")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#removequestion"},"removeQuestion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#from"},"from")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#fullelectiontype"},"fullElectionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"UnpublishedElection#fullvotetype"},"fullVoteType"))),(0,i.kt)("h2",{id:"constructors-1"},"Constructors"),(0,i.kt)("h3",{id:"constructor"},"constructor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"new UnpublishedElection"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,i.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("p",null,"Constructs an unpublished election"),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"params")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"../interfaces/IElectionParameters"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"Election parameters")))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"Election#constructor"},"constructor")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L23"},"types/election/unpublished.ts:23")),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"_addsdkversion"},"_","addSDKVersion"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","addSDKVersion"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_addsdkversion"},"_addSDKVersion")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L175"},"types/election/election.ts:175")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_census"},"_","census"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","census"),": ",(0,i.kt)("a",{parentName:"p",href:"Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census"))),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_census"},"_census")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L172"},"types/election/election.ts:172")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_description"},"_","description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_description"},"_description")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L163"},"types/election/election.ts:163")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_electiontype"},"_","electionType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","electionType"),": ",(0,i.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_electiontype"},"_electionType")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L169"},"types/election/election.ts:169")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_enddate"},"_","endDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","endDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_enddate"},"_endDate")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L168"},"types/election/election.ts:168")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_header"},"_","header"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","header"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_header"},"_header")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L164"},"types/election/election.ts:164")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_maxcensussize"},"_","maxCensusSize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","maxCensusSize"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_maxcensussize"},"_maxCensusSize")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L173"},"types/election/election.ts:173")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_meta"},"_","meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_meta"},"_meta")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L166"},"types/election/election.ts:166")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_questions"},"_","questions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","questions"),": ",(0,i.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_questions"},"_questions")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L171"},"types/election/election.ts:171")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_startdate"},"_","startDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","startDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_startdate"},"_startDate")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L167"},"types/election/election.ts:167")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_streamuri"},"_","streamUri"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","streamUri"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_streamuri"},"_streamUri")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L165"},"types/election/election.ts:165")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_temporarysecretidentity"},"_","temporarySecretIdentity"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","temporarySecretIdentity"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_temporarysecretidentity"},"_temporarySecretIdentity")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L174"},"types/election/election.ts:174")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_title"},"_","title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_title"},"_title")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L162"},"types/election/election.ts:162")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"_votetype"},"_","voteType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,i.kt)("strong",{parentName:"p"},"_","voteType"),": ",(0,i.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election#_votetype"},"_voteType")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L170"},"types/election/election.ts:170")),(0,i.kt)("h2",{id:"accessors-1"},"Accessors"),(0,i.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"addSDKVersion"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,"Election.addSDKVersion"),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L275"},"types/election/unpublished.ts:275")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"addSDKVersion"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-2"},"Overrides"),(0,i.kt)("p",null,"Election.addSDKVersion"),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L279"},"types/election/unpublished.ts:279")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"census"},"census"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"census"),"(): ",(0,i.kt)("a",{parentName:"p",href:"Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census"))),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census"))),(0,i.kt)("h4",{id:"overrides-3"},"Overrides"),(0,i.kt)("p",null,"Election.census"),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L249"},"types/election/unpublished.ts:249")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"census"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-2"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census")))))),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-4"},"Overrides"),(0,i.kt)("p",null,"Election.census"),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L253"},"types/election/unpublished.ts:253")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"description"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"overrides-5"},"Overrides"),(0,i.kt)("p",null,"Election.description"),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L173"},"types/election/unpublished.ts:173")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"description"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-3"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,i.kt)("h4",{id:"returns-6"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-6"},"Overrides"),(0,i.kt)("p",null,"Election.description"),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L177"},"types/election/unpublished.ts:177")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"duration"},"duration"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"duration"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"returns-7"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L138"},"types/election/unpublished.ts:138")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electiontype"},"electionType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"electionType"),"(): ",(0,i.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"returns-8"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"overrides-7"},"Overrides"),(0,i.kt)("p",null,"Election.electionType"),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L225"},"types/election/unpublished.ts:225")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"electionType"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-4"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"../interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType")))))),(0,i.kt)("h4",{id:"returns-9"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-8"},"Overrides"),(0,i.kt)("p",null,"Election.electionType"),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L229"},"types/election/unpublished.ts:229")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enddate"},"endDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"endDate"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"returns-10"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"overrides-9"},"Overrides"),(0,i.kt)("p",null,"Election.endDate"),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L215"},"types/election/unpublished.ts:215")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"endDate"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-5"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,i.kt)("h4",{id:"returns-11"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-10"},"Overrides"),(0,i.kt)("p",null,"Election.endDate"),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L219"},"types/election/unpublished.ts:219")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"header"},"header"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"header"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-12"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"overrides-11"},"Overrides"),(0,i.kt)("p",null,"Election.header"),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L181"},"types/election/unpublished.ts:181")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"header"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-6"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-13"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-12"},"Overrides"),(0,i.kt)("p",null,"Election.header"),(0,i.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L185"},"types/election/unpublished.ts:185")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"maxCensusSize"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"returns-14"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"overrides-13"},"Overrides"),(0,i.kt)("p",null,"Election.maxCensusSize"),(0,i.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L258"},"types/election/unpublished.ts:258")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"maxCensusSize"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-7"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-15"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-14"},"Overrides"),(0,i.kt)("p",null,"Election.maxCensusSize"),(0,i.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L262"},"types/election/unpublished.ts:262")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"returns-16"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"overrides-15"},"Overrides"),(0,i.kt)("p",null,"Election.meta"),(0,i.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L197"},"types/election/unpublished.ts:197")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-8"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"returns-17"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-16"},"Overrides"),(0,i.kt)("p",null,"Election.meta"),(0,i.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L201"},"types/election/unpublished.ts:201")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"questions"},"questions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"questions"),"(): ",(0,i.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"returns-18"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"../interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"overrides-17"},"Overrides"),(0,i.kt)("p",null,"Election.questions"),(0,i.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L241"},"types/election/unpublished.ts:241")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"questions"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-9"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"../interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]")))),(0,i.kt)("h4",{id:"returns-19"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-18"},"Overrides"),(0,i.kt)("p",null,"Election.questions"),(0,i.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L245"},"types/election/unpublished.ts:245")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"startdate"},"startDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"startDate"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"returns-20"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"overrides-19"},"Overrides"),(0,i.kt)("p",null,"Election.startDate"),(0,i.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L206"},"types/election/unpublished.ts:206")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"startDate"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-10"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Date"))))),(0,i.kt)("h4",{id:"returns-21"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-20"},"Overrides"),(0,i.kt)("p",null,"Election.startDate"),(0,i.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L210"},"types/election/unpublished.ts:210")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"streamuri"},"streamUri"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"streamUri"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-22"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"overrides-21"},"Overrides"),(0,i.kt)("p",null,"Election.streamUri"),(0,i.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L189"},"types/election/unpublished.ts:189")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"streamUri"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-11"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-23"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-22"},"Overrides"),(0,i.kt)("p",null,"Election.streamUri"),(0,i.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L193"},"types/election/unpublished.ts:193")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"returns-24"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"overrides-23"},"Overrides"),(0,i.kt)("p",null,"Election.temporarySecretIdentity"),(0,i.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L267"},"types/election/unpublished.ts:267")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-12"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,i.kt)("h4",{id:"returns-25"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-24"},"Overrides"),(0,i.kt)("p",null,"Election.temporarySecretIdentity"),(0,i.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L271"},"types/election/unpublished.ts:271")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"title"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"returns-26"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"overrides-25"},"Overrides"),(0,i.kt)("p",null,"Election.title"),(0,i.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L164"},"types/election/unpublished.ts:164")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"title"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-13"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),">")))),(0,i.kt)("h4",{id:"returns-27"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-26"},"Overrides"),(0,i.kt)("p",null,"Election.title"),(0,i.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L168"},"types/election/unpublished.ts:168")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votetype"},"voteType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"voteType"),"(): ",(0,i.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"returns-28"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"overrides-27"},"Overrides"),(0,i.kt)("p",null,"Election.voteType"),(0,i.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L233"},"types/election/unpublished.ts:233")),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"set")," ",(0,i.kt)("strong",{parentName:"p"},"voteType"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"parameters-14"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"../interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,i.kt)("h4",{id:"returns-29"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"overrides-28"},"Overrides"),(0,i.kt)("p",null,"Election.voteType"),(0,i.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L237"},"types/election/unpublished.ts:237")),(0,i.kt)("h2",{id:"methods-1"},"Methods"),(0,i.kt)("h3",{id:"addquestion"},"addQuestion"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"addQuestion"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"title"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"description"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"choices"),"): ",(0,i.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("h4",{id:"parameters-15"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"title")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"description")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"choices")),(0,i.kt)("td",{parentName:"tr",align:"left"},"(","{"," ",(0,i.kt)("inlineCode",{parentName:"td"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"value"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"number")," } ","|"," ","{"," ",(0,i.kt)("inlineCode",{parentName:"td"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),">"," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"value"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"number")," })[]")))),(0,i.kt)("h4",{id:"returns-30"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L41"},"types/election/unpublished.ts:41")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generateenvelopetype"},"generateEnvelopeType"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"generateEnvelopeType"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"returns-31"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L144"},"types/election/unpublished.ts:144")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generatemetadata"},"generateMetadata"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"generateMetadata"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"metadata?"),"): ",(0,i.kt)("a",{parentName:"p",href:"../interfaces/ElectionMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,i.kt)("h4",{id:"parameters-16"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"metadata?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"../interfaces/ElectionMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionMetadata")))))),(0,i.kt)("h4",{id:"returns-32"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"../interfaces/ElectionMetadata"},(0,i.kt)("inlineCode",{parentName:"a"},"ElectionMetadata"))),(0,i.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L88"},"types/election/unpublished.ts:88")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generatemode"},"generateMode"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"generateMode"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"returns-33"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L154"},"types/election/unpublished.ts:154")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generatevoteoptions"},"generateVoteOptions"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"generateVoteOptions"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"returns-34"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"object")),(0,i.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L123"},"types/election/unpublished.ts:123")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"get"},"get"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"get"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"dot"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"parameters-17"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"dot")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-35"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"Election#get"},"get")),(0,i.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L266"},"types/election/election.ts:266")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"removequestion"},"removeQuestion"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"removeQuestion"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"questionNumber"),"): ",(0,i.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("h4",{id:"parameters-18"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"questionNumber")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-36"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L60"},"types/election/unpublished.ts:60")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"from"},"from"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"from"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,i.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("p",null,"Returns an unpublished election object"),(0,i.kt)("h4",{id:"parameters-19"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"params")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"../interfaces/IElectionParameters"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionParameters"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"Unpublished Election parameters")))),(0,i.kt)("h4",{id:"returns-37"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"UnpublishedElection"},(0,i.kt)("inlineCode",{parentName:"a"},"UnpublishedElection"))),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Election"},"Election"),".",(0,i.kt)("a",{parentName:"p",href:"Election#from"},"from")),(0,i.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L206"},"types/election/election.ts:206")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fullelectiontype"},"fullElectionType"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fullElectionType"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"parameters-20"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"../interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType")))))),(0,i.kt)("h4",{id:"returns-38"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"../interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L66"},"types/election/unpublished.ts:66")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fullvotetype"},"fullVoteType"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"fullVoteType"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,i.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"parameters-21"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"../interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType")))))),(0,i.kt)("h4",{id:"returns-39"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"../interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/unpublished.ts#L76"},"types/election/unpublished.ts:76")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/de66f94a.2a4574a2.js b/assets/js/de66f94a.60833895.js similarity index 60% rename from assets/js/de66f94a.2a4574a2.js rename to assets/js/de66f94a.60833895.js index 5118aecfa..d81347d9e 100644 --- a/assets/js/de66f94a.2a4574a2.js +++ b/assets/js/de66f94a.60833895.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2691],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>d});var n=r(67294);function s(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(s[r]=e[r]);return s}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(s[r]=e[r])}return s}var c=n.createContext({}),p=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},l=function(e){var t=p(e.components);return n.createElement(c.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,s=e.mdxType,a=e.originalType,c=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),f=p(r),d=s,y=f["".concat(c,".").concat(d)]||f[d]||u[d]||a;return r?n.createElement(y,o(o({ref:t},l),{},{components:r})):n.createElement(y,o({ref:t},l))}));function d(e,t){var r=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var a=r.length,o=new Array(a);o[0]=f;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i.mdxType="string"==typeof e?e:s,o[1]=i;for(var p=2;p{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>p});var n=r(87462),s=(r(67294),r(3905));const a={},o=void 0,i={unversionedId:"sdk/reference/interfaces/ICensus3StrategyCreateResponse",id:"sdk/reference/interfaces/ICensus3StrategyCreateResponse",title:"ICensus3StrategyCreateResponse",description:"@vocdoni/sdk / Exports / ICensus3StrategyCreateResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategyCreateResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategyCreateResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyCreateResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategiesOperatorsResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse"},next:{title:"ICensus3StrategyEstimationQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"strategyID",id:"strategyid",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function u(e){let{components:t,...r}=e;return(0,s.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3StrategyCreateResponse"),(0,s.kt)("h1",{id:"interface-icensus3strategycreateresponse"},"Interface: ICensus3StrategyCreateResponse"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyCreateResponse#strategyid"},"strategyID"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"strategyid"},"strategyID"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"strategyID"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("p",null,"The identifier of the created strategy"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L197"},"api/census3/strategy.ts:197")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2691],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>d});var n=r(67294);function s(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(s[r]=e[r]);return s}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(s[r]=e[r])}return s}var p=n.createContext({}),c=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},l=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,s=e.mdxType,a=e.originalType,p=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),f=c(r),d=s,y=f["".concat(p,".").concat(d)]||f[d]||u[d]||a;return r?n.createElement(y,o(o({ref:t},l),{},{components:r})):n.createElement(y,o({ref:t},l))}));function d(e,t){var r=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var a=r.length,o=new Array(a);o[0]=f;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i.mdxType="string"==typeof e?e:s,o[1]=i;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>c});var n=r(87462),s=(r(67294),r(3905));const a={},o=void 0,i={unversionedId:"sdk/reference/interfaces/ICensus3StrategyCreateResponse",id:"sdk/reference/interfaces/ICensus3StrategyCreateResponse",title:"ICensus3StrategyCreateResponse",description:"@vocdoni/sdk / Exports / ICensus3StrategyCreateResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategyCreateResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategyCreateResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyCreateResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategiesOperatorsResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse"},next:{title:"ICensus3StrategyEstimationQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"strategyID",id:"strategyid",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:c};function u(e){let{components:t,...r}=e;return(0,s.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3StrategyCreateResponse"),(0,s.kt)("h1",{id:"interface-icensus3strategycreateresponse"},"Interface: ICensus3StrategyCreateResponse"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"ICensus3StrategyCreateResponse#strategyid"},"strategyID"))),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"strategyid"},"strategyID"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"strategyID"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("p",null,"The identifier of the created strategy"),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L197"},"api/census3/strategy.ts:197")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/dffc9575.449dcf46.js b/assets/js/dffc9575.e1c76ab3.js similarity index 74% rename from assets/js/dffc9575.449dcf46.js rename to assets/js/dffc9575.e1c76ab3.js index 2dce628e0..bcc080b2f 100644 --- a/assets/js/dffc9575.449dcf46.js +++ b/assets/js/dffc9575.e1c76ab3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6873],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>u});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var c=r.createContext({}),p=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},l=function(e){var t=p(e.components);return r.createElement(c.Provider,{value:t},e.children)},f={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),d=p(n),u=a,m=d["".concat(c,".").concat(u)]||d[u]||f[u]||i;return n?r.createElement(m,o(o({ref:t},l),{},{components:n})):r.createElement(m,o({ref:t},l))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=d;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>f,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const i={},o=void 0,s={unversionedId:"sdk/reference/interfaces/IChainTxListResponse",id:"sdk/reference/interfaces/IChainTxListResponse",title:"IChainTxListResponse",description:"@vocdoni/sdk / Exports / IChainTxListResponse",source:"@site/docs/sdk/reference/interfaces/IChainTxListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainTxListResponse",permalink:"/sdk/reference/interfaces/IChainTxListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainTxCountResponse",permalink:"/sdk/reference/interfaces/IChainTxCountResponse"},next:{title:"IChainTxReference",permalink:"/sdk/reference/interfaces/IChainTxReference"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"transactions",id:"transactions",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function f(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IChainTxListResponse"),(0,a.kt)("h1",{id:"interface-ichaintxlistresponse"},"Interface: IChainTxListResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainTxListResponse#transactions"},"transactions"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"transactions"},"transactions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"transactions"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IChainTxReference"},(0,a.kt)("inlineCode",{parentName:"a"},"IChainTxReference")),"[]"),(0,a.kt)("p",null,"List of transactions reference"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L234"},"api/chain.ts:234")))}f.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6873],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>d});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var c=r.createContext({}),p=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},l=function(e){var t=p(e.components);return r.createElement(c.Provider,{value:t},e.children)},f={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),u=p(n),d=a,m=u["".concat(c,".").concat(d)]||u[d]||f[d]||i;return n?r.createElement(m,o(o({ref:t},l),{},{components:n})):r.createElement(m,o({ref:t},l))}));function d(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=u;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>f,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const i={},o=void 0,s={unversionedId:"sdk/reference/interfaces/IChainTxListResponse",id:"sdk/reference/interfaces/IChainTxListResponse",title:"IChainTxListResponse",description:"@vocdoni/sdk / Exports / IChainTxListResponse",source:"@site/docs/sdk/reference/interfaces/IChainTxListResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainTxListResponse",permalink:"/sdk/reference/interfaces/IChainTxListResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IChainTxCountResponse",permalink:"/sdk/reference/interfaces/IChainTxCountResponse"},next:{title:"IChainTxReference",permalink:"/sdk/reference/interfaces/IChainTxReference"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"transactions",id:"transactions",level:3},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function f(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IChainTxListResponse"),(0,a.kt)("h1",{id:"interface-ichaintxlistresponse"},"Interface: IChainTxListResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"IChainTxListResponse#transactions"},"transactions"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"transactions"},"transactions"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"transactions"),": ",(0,a.kt)("a",{parentName:"p",href:"IChainTxReference"},(0,a.kt)("inlineCode",{parentName:"a"},"IChainTxReference")),"[]"),(0,a.kt)("p",null,"List of transactions reference"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L234"},"api/chain.ts:234")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e0557e97.24f5d30e.js b/assets/js/e0557e97.24f5d30e.js deleted file mode 100644 index cfc136ce8..000000000 --- a/assets/js/e0557e97.24f5d30e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9203],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>h});var o=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function a(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=o.createContext({}),s=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},d=function(e){var t=s(e.components);return o.createElement(l.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},u=o.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,d=c(e,["components","mdxType","originalType","parentName"]),u=s(n),h=r,m=u["".concat(l,".").concat(h)]||u[h]||p[h]||i;return n?o.createElement(m,a(a({ref:t},d),{},{components:n})):o.createElement(m,a({ref:t},d))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,a=new Array(i);a[0]=u;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c.mdxType="string"==typeof e?e:r,a[1]=c;for(var s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>s});var o=n(87462),r=(n(67294),n(3905));const i={},a="Vocdoni SDK",c={unversionedId:"sdk/index",id:"sdk/index",title:"Vocdoni SDK",description:"The Vocdoni SDK is a convenient way to interact with the Vocdoni Protocol through the API, allowing anyone to create, manage and participate in voting processes and collective decision-making. The SDK is the primary mode by which developers should interface with Vocdoni - if you think the SDK is missing functionality you need, please get in touch.",source:"@site/docs/sdk/index.md",sourceDirName:"sdk",slug:"/sdk/",permalink:"/sdk/",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Vote Data",permalink:"/protocol/data-schemes/vote"},next:{title:"SDK Integration Details",permalink:"/sdk/integration-details"}},l={},s=[{value:"Start by following along with the SDK tutorial",id:"start-by-following-along-with-the-sdk-tutorial",level:3},{value:"Detailed SDK reference",id:"detailed-sdk-reference",level:3},{value:"Examples",id:"examples",level:2},{value:"Reference Docs",id:"reference-docs",level:2},{value:"Disclaimer",id:"disclaimer",level:3},{value:"License",id:"license",level:2}],d={toc:s};function p(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,o.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"vocdoni-sdk"},"Vocdoni SDK"),(0,r.kt)("p",null,"The Vocdoni SDK is a convenient way to interact with the Vocdoni Protocol through the ",(0,r.kt)("a",{parentName:"p",href:"/vocdoni-api/vocdoni-api"},"API"),", allowing anyone to create, manage and participate in voting processes and collective decision-making. The SDK is the primary mode by which developers should interface with Vocdoni - if you think the SDK is missing functionality you need, please ",(0,r.kt)("a",{parentName:"p",href:"https://chat.vocdoni.io"},"get in touch"),". "),(0,r.kt)("h3",{id:"start-by-following-along-with-the-sdk-tutorial"},"Start by following along with the ",(0,r.kt)("a",{parentName:"h3",href:"/sdk/tutorial"},"SDK tutorial")),(0,r.kt)("h3",{id:"detailed-sdk-reference"},"Detailed ",(0,r.kt)("a",{parentName:"h3",href:"/sdk/reference/modules"},"SDK reference")),(0,r.kt)("h2",{id:"examples"},"Examples"),(0,r.kt)("p",null,"You can find examples using ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/examples/esm"},"es modules"),", ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/examples/typescript"},"typescript"),", and ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/examples/vite-react-app"},"vite react")," in the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/examples"},"examples")," folder."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://raw.githubusercontent.com/vocdoni/vocdoni-sdk/main/examples/esm/esm.gif",alt:"example-esm demo"})),(0,r.kt)("h2",{id:"reference-docs"},"Reference Docs"),(0,r.kt)("p",null,"You can find the autogenerated docs in our ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"SDK Reference"),". You can build them following ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/docs/README.md"},"this guide"),"."),(0,r.kt)("h3",{id:"disclaimer"},"Disclaimer"),(0,r.kt)("p",null,"The Vocdoni SDK and the underlying API is WIP. Please beware that it can be broken\nat any time if the release is ",(0,r.kt)("inlineCode",{parentName:"p"},"alpha")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"beta"),". We encourage to review this\nrepository for any change."),(0,r.kt)("h2",{id:"license"},"License"),(0,r.kt)("p",null,"This SDK is licensed under the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/LICENSE"},"GNU Affero General Public License v3.0"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Vocdoni API Typescript SDK\nCopyright (C) 2022 Vocdoni Roots MCU\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program. If not, see .\n")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e0557e97.a04b5ac9.js b/assets/js/e0557e97.a04b5ac9.js new file mode 100644 index 000000000..7ade3d2c5 --- /dev/null +++ b/assets/js/e0557e97.a04b5ac9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9203],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>h});var o=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function a(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=o.createContext({}),c=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},d=function(e){var t=c(e.components);return o.createElement(l.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},u=o.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=c(n),h=i,m=u["".concat(l,".").concat(h)]||u[h]||p[h]||r;return n?o.createElement(m,a(a({ref:t},d),{},{components:n})):o.createElement(m,a({ref:t},d))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,a=new Array(r);a[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:i,a[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>p,frontMatter:()=>r,metadata:()=>s,toc:()=>c});var o=n(87462),i=(n(67294),n(3905));const r={},a="Vocdoni SDK",s={unversionedId:"sdk/index",id:"sdk/index",title:"Vocdoni SDK",description:"The Vocdoni SDK is a convenient way to interact with the Vocdoni Protocol through the API, allowing anyone to create, manage and participate in voting processes and collective decision-making. The SDK is the primary mode by which developers should interface with Vocdoni - if you think the SDK is missing functionality you need, please get in touch.",source:"@site/docs/sdk/index.md",sourceDirName:"sdk",slug:"/sdk/",permalink:"/sdk/",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Vote Data",permalink:"/protocol/data-schemes/vote"},next:{title:"SDK Tutorial",permalink:"/sdk/tutorial"}},l={},c=[{value:"Start by following along with the SDK tutorial",id:"start-by-following-along-with-the-sdk-tutorial",level:3},{value:"There is also a tutorial for using an on-chain token-based census",id:"there-is-also-a-tutorial-for-using-an-on-chain-token-based-census",level:4},{value:"Detailed SDK reference",id:"detailed-sdk-reference",level:3},{value:"Examples",id:"examples",level:2},{value:"Reference Docs",id:"reference-docs",level:2},{value:"Disclaimer",id:"disclaimer",level:3},{value:"License",id:"license",level:2}],d={toc:c};function p(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,o.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"vocdoni-sdk"},"Vocdoni SDK"),(0,i.kt)("p",null,"The Vocdoni SDK is a convenient way to interact with the Vocdoni Protocol through the ",(0,i.kt)("a",{parentName:"p",href:"/vocdoni-api/vocdoni-api"},"API"),", allowing anyone to create, manage and participate in voting processes and collective decision-making. The SDK is the primary mode by which developers should interface with Vocdoni - if you think the SDK is missing functionality you need, please ",(0,i.kt)("a",{parentName:"p",href:"https://chat.vocdoni.io"},"get in touch"),". "),(0,i.kt)("h3",{id:"start-by-following-along-with-the-sdk-tutorial"},"Start by following along with the ",(0,i.kt)("a",{parentName:"h3",href:"/sdk/tutorial"},"SDK tutorial")),(0,i.kt)("h4",{id:"there-is-also-a-tutorial-for-using-an-on-chain-token-based-census"},"There is also a ",(0,i.kt)("a",{parentName:"h4",href:"/sdk/integration-details/census-types/on-chain#tutorial"},"tutorial")," for using an on-chain token-based census"),(0,i.kt)("h3",{id:"detailed-sdk-reference"},"Detailed ",(0,i.kt)("a",{parentName:"h3",href:"/sdk/reference/modules"},"SDK reference")),(0,i.kt)("h2",{id:"examples"},"Examples"),(0,i.kt)("p",null,"You can find examples using ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/examples/esm"},"es modules"),", ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/examples/typescript"},"typescript"),", and ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/examples/vite-react-app"},"vite react")," in the ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/examples"},"examples")," folder."),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://raw.githubusercontent.com/vocdoni/vocdoni-sdk/main/examples/esm/esm.gif",alt:"example-esm demo"})),(0,i.kt)("h2",{id:"reference-docs"},"Reference Docs"),(0,i.kt)("p",null,"You can find the autogenerated docs in our ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"SDK Reference"),". You can build them following ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/docs/README.md"},"this guide"),"."),(0,i.kt)("h3",{id:"disclaimer"},"Disclaimer"),(0,i.kt)("p",null,"The Vocdoni SDK and the underlying API is WIP. Please beware that it can be broken\nat any time if the release is ",(0,i.kt)("inlineCode",{parentName:"p"},"alpha")," or ",(0,i.kt)("inlineCode",{parentName:"p"},"beta"),". We encourage to review this\nrepository for any change."),(0,i.kt)("h2",{id:"license"},"License"),(0,i.kt)("p",null,"This SDK is licensed under the ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/LICENSE"},"GNU Affero General Public License v3.0"),"."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre"},"Vocdoni API Typescript SDK\nCopyright (C) 2022 Vocdoni Roots MCU\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program. If not, see .\n")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e1594dfa.9aef19fd.js b/assets/js/e1594dfa.4852cd3c.js similarity index 78% rename from assets/js/e1594dfa.9aef19fd.js rename to assets/js/e1594dfa.4852cd3c.js index aaa47c62f..8f9a7b05a 100644 --- a/assets/js/e1594dfa.9aef19fd.js +++ b/assets/js/e1594dfa.4852cd3c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8257],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function c(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var l=r.createContext({}),s=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):c(c({},t),e)),n},p=function(e){var t=s(e.components);return r.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,l=e.parentName,p=a(e,["components","mdxType","originalType","parentName"]),f=s(n),u=o,m=f["".concat(l,".").concat(u)]||f[u]||d[u]||i;return n?r.createElement(m,c(c({ref:t},p),{},{components:n})):r.createElement(m,c({ref:t},p))}));function u(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,c=new Array(i);c[0]=f;var a={};for(var l in t)hasOwnProperty.call(t,l)&&(a[l]=t[l]);a.originalType=e,a.mdxType="string"==typeof e?e:o,c[1]=a;for(var s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>a,toc:()=>s});var r=n(87462),o=(n(67294),n(3905));const i={},c=void 0,a={unversionedId:"sdk/reference/interfaces/IElectionNextIdResponse",id:"sdk/reference/interfaces/IElectionNextIdResponse",title:"IElectionNextIdResponse",description:"@vocdoni/sdk / Exports / IElectionNextIdResponse",source:"@site/docs/sdk/reference/interfaces/IElectionNextIdResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionNextIdResponse",permalink:"/sdk/reference/interfaces/IElectionNextIdResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionMode",permalink:"/sdk/reference/interfaces/IElectionMode"},next:{title:"IElectionParameters",permalink:"/sdk/reference/interfaces/IElectionParameters"}},l={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"electionID",id:"electionid",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:s};function d(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IElectionNextIdResponse"),(0,o.kt)("h1",{id:"interface-ielectionnextidresponse"},"Interface: IElectionNextIdResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionNextIdResponse#electionid"},"electionID"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"electionid"},"electionID"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"electionID"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The next election identifier"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/election.ts#L146"},"api/election.ts:146")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8257],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function c(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var l=r.createContext({}),s=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):c(c({},t),e)),n},p=function(e){var t=s(e.components);return r.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,l=e.parentName,p=a(e,["components","mdxType","originalType","parentName"]),f=s(n),u=o,m=f["".concat(l,".").concat(u)]||f[u]||d[u]||i;return n?r.createElement(m,c(c({ref:t},p),{},{components:n})):r.createElement(m,c({ref:t},p))}));function u(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,c=new Array(i);c[0]=f;var a={};for(var l in t)hasOwnProperty.call(t,l)&&(a[l]=t[l]);a.originalType=e,a.mdxType="string"==typeof e?e:o,c[1]=a;for(var s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>a,toc:()=>s});var r=n(87462),o=(n(67294),n(3905));const i={},c=void 0,a={unversionedId:"sdk/reference/interfaces/IElectionNextIdResponse",id:"sdk/reference/interfaces/IElectionNextIdResponse",title:"IElectionNextIdResponse",description:"@vocdoni/sdk / Exports / IElectionNextIdResponse",source:"@site/docs/sdk/reference/interfaces/IElectionNextIdResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionNextIdResponse",permalink:"/sdk/reference/interfaces/IElectionNextIdResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionMode",permalink:"/sdk/reference/interfaces/IElectionMode"},next:{title:"IElectionParameters",permalink:"/sdk/reference/interfaces/IElectionParameters"}},l={},s=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"electionID",id:"electionid",level:3},{value:"Defined in",id:"defined-in",level:4}],p={toc:s};function d(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,o.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IElectionNextIdResponse"),(0,o.kt)("h1",{id:"interface-ielectionnextidresponse"},"Interface: IElectionNextIdResponse"),(0,o.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,o.kt)("h3",{id:"properties"},"Properties"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"IElectionNextIdResponse#electionid"},"electionID"))),(0,o.kt)("h2",{id:"properties-1"},"Properties"),(0,o.kt)("h3",{id:"electionid"},"electionID"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"electionID"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The next election identifier"),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/election.ts#L146"},"api/election.ts:146")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e24c431f.777baed9.js b/assets/js/e24c431f.777baed9.js new file mode 100644 index 000000000..aee80802e --- /dev/null +++ b/assets/js/e24c431f.777baed9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2872],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),c=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),u=c(n),m=r,h=u["".concat(l,".").concat(m)]||u[m]||d[m]||o;return n?a.createElement(h,s(s({ref:t},p),{},{components:n})):a.createElement(h,s({ref:t},p))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,s=new Array(o);s[0]=u;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i.mdxType="string"==typeof e?e:r,s[1]=i;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var a=n(87462),r=(n(67294),n(3905));const o={},s="Complex Census",i={unversionedId:"sdk/integration-details/census-types/on-chain/complex-census",id:"sdk/integration-details/census-types/on-chain/complex-census",title:"Complex Census",description:"The census3 service makes it easy to create a census based off of the balance holders of a token taken to represent an organization. It is possible, however, to create a token-based census with more complex logic, incorporating balance information from multiple tokens at once.",source:"@site/docs/sdk/integration-details/census-types/on-chain/complex-census.md",sourceDirName:"sdk/integration-details/census-types/on-chain",slug:"/sdk/integration-details/census-types/on-chain/complex-census",permalink:"/sdk/integration-details/census-types/on-chain/complex-census",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"On-chain Token-Based Census",permalink:"/sdk/integration-details/census-types/on-chain/"},next:{title:"Vocdoni Tokens",permalink:"/sdk/integration-details/vocdoni-tokens"}},l={},c=[{value:"Strategies",id:"strategies",level:2},{value:"Predicates",id:"predicates",level:2},{value:"Creating a Census",id:"creating-a-census",level:2}],p={toc:c};function d(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"complex-census"},"Complex Census"),(0,r.kt)("p",null,"The census3 service makes it easy to create a census based off of the balance holders of a token taken to represent an organization. It is possible, however, to create a token-based census with more complex logic, incorporating balance information from multiple tokens at once."),(0,r.kt)("h2",{id:"strategies"},"Strategies"),(0,r.kt)("p",null,"The logic that defines inclusion in a token-based census is called a 'strategy.' For the basic token-holder use case, the strategy is defined solely by that token. ",(0,r.kt)("inlineCode",{parentName:"p"},"createTokenCensus")," chooses the default strategy for that token, so for a basic token-based census you don't need to worry about strategies at all."),(0,r.kt)("p",null,'More complex strategies exist, however, such as "holders of both ',(0,r.kt)("inlineCode",{parentName:"p"},"VOC1")," token AND ",(0,r.kt)("inlineCode",{parentName:"p"},"VOC2"),' token."'),(0,r.kt)("p",null,"Just like checking for supported tokens, you can see a list of the strategies supported by the census3 service:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"const strategies = await census3Client.getStrategies();\nconsole.log(JSON.stringify(strategies, null, 4));\n")),(0,r.kt)("p",null,"This will print a long list of strategies. Some of them will be basic strategies for a single token:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},'...\n {\n "ID": 72,\n "alias": "Default strategy for token VOC3TEST",\n "predicate": "VOC3TEST",\n "uri": "ipfs://bafybeih7rmjsdzqjr6pyjv46jo4kjpl3qfv2yufpdxzmcw2j63z47u6czy",\n "tokens": {\n "VOC3TEST": {\n "ID": "0x9286d95DB5a59306113028EF0BA85bF7068A199F",\n "chainID": 11155111,\n "minBalance": "1",\n "chainAddress": "sep:0x9286d95DB5a59306113028EF0BA85bF7068A199F"\n }\n }\n },\n...\n')),(0,r.kt)("p",null,"Some, on the other hand, will be more complex strategies involving multiple tokens:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},'...\n {\n "ID": 103,\n "alias": "gitcoin_onvote_1711040172449",\n "predicate": "GPS AND:mul (GPS:Discord OR GPS:Github)",\n "uri": "ipfs://bafybeidopynxc746oorzkh7yvhomcw56w72aaw3klqce4gkjcczc7ry3uu",\n "tokens": {\n "GPS": {\n "ID": "0x000000000000000000000000000000000000006C",\n "chainID": 1,\n "minBalance": "16",\n "chainAddress": "eth:0x000000000000000000000000000000000000006C"\n },\n "GPS:Discord": {\n "ID": "0x000000000000000000000000000000000000006C",\n "chainID": 1,\n "minBalance": "1",\n "chainAddress": "eth:0x000000000000000000000000000000000000006C",\n "externalID": "Discord"\n },\n "GPS:Github": {\n "ID": "0x000000000000000000000000000000000000006C",\n "chainID": 1,\n "minBalance": "1",\n "chainAddress": "eth:0x000000000000000000000000000000000000006C",\n "externalID": "Github"\n }\n }\n },\n...\n')),(0,r.kt)("h2",{id:"predicates"},"Predicates"),(0,r.kt)("p",null,"As you can see, there are two main differences between the simple and complex strategies: the ",(0,r.kt)("inlineCode",{parentName:"p"},"predicate")," and the ",(0,r.kt)("inlineCode",{parentName:"p"},"tokens"),". "),(0,r.kt)("p",null,"Predicates are logical operators that define how strategies create a census. There are currently two logical operators (",(0,r.kt)("inlineCode",{parentName:"p"},"AND")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"OR"),"), each with two additional 'powerups' (",(0,r.kt)("inlineCode",{parentName:"p"},"sum")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"mul"),")."),(0,r.kt)("p",null,"Each of the operators uses a different logical strategy for combining token holder balances to create a weighted census:"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Operator"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Powerup"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Usage"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AND")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AND")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Holders of both tokens, with a fixed weight of 1.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"OR")),(0,r.kt)("td",{parentName:"tr",align:"left"}),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"OR"),"\xa0"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Holders of either or both tokens, with fixed weight of 1.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AND")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sum")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AND:sum")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Holders of both tokens, with a weight adding the token balances.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AND")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"mul")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AND:mul")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Holders of both tokens, with a weight multiplying the token balances.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"OR")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sum")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"OR:sum")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Holders of either or both tokens, with a weight adding the token balances.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"OR")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"mul")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"OR:mul")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Holders of either or both tokens, with a weight multiplying the token balances if both are non-zero, or equaling the balance that is non-zero.")))),(0,r.kt)("p",null,"You can also query the census3 service for a list of available operators:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"const operators = await census3Client.getSupportedOperators();\nconsole.log(operators);\n")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"[\n {\n description: 'AND logical operator that returns the common token holders between symbols with fixed balance to 1',\n tag: 'AND'\n },\n {\n description: 'AND:sum logical operator that returns the common token holders between symbols with the sum of their balances on both tokens',\n tag: 'AND:sum'\n },\n {\n description: 'AND:mul logical operator that returns the common token holders between symbols with the multiplication of their balances on both tokens',\n tag: 'AND:mul'\n },\n {\n description: 'OR logical operator that returns the token holders of both symbols with fixed balance to 1',\n tag: 'OR'\n },\n {\n description: 'OR:sum logical operator that returns the token holders of both symbols with the sum of their balances on both tokens',\n tag: 'OR:sum'\n },\n {\n description: 'OR:mul logical operator that returns the token holders of both symbols with the multiplication of their balances on both tokens',\n tag: 'OR:mul'\n }\n]\n")),(0,r.kt)("p",null,"As seen in the strategy example above, you can combine operators to create complex predicates with many tokens: "),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-json"},'"predicate": "GPS AND:mul (GPS:Discord OR GPS:Github)"\n')),(0,r.kt)("h2",{id:"creating-a-census"},"Creating a Census"),(0,r.kt)("p",null,"The first step in creating a complex census is to create the strategy itself. You can write a predicate with the operators defined above and use the predicate with ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/vocdonicensus3client#createstrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"createStrategy()")),". The only requirement is that you include a list of the necessary tokens used by this predicate, including the token ",(0,r.kt)("inlineCode",{parentName:"p"},"ID")," (address), ",(0,r.kt)("inlineCode",{parentName:"p"},"chainID"),", and optionally the ",(0,r.kt)("inlineCode",{parentName:"p"},"minBalance")," (the minimum necessary balance to include a token-holder in a census)."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"const strategyID = await census3Client.createStrategy('voc_test_strategy', 'VOC3TEST AND VOC3TEST3', {\n VOC3TEST: {\n ID: '0x9286d95DB5a59306113028EF0BA85bF7068A199F',\n chainID: 11155111,\n minBalance: '1',\n },\n VOC3TEST3: {\n ID: '0x61353Bc49B062EEe99F4768225f4e4f0df5DB1b9',\n chainID: 11155111,\n minBalance: '1',\n },\n});\n")),(0,r.kt)("p",null,"This API call, if successful, returns the ID of the newly-created strategy. You can also use ",(0,r.kt)("inlineCode",{parentName:"p"},"getStrategies()")," again to make sure the strategy is supported. This ID is needed to create the census based off of the strategy:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"const censusInfo = await census3Client.createCensus(strategyID);\n")),(0,r.kt)("p",null,"This returns a set of information about the census but cannot be used to directly create an election. To do this, just manually create a ",(0,r.kt)("inlineCode",{parentName:"p"},"PublishedCensus"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"const census = new PublishedCensus(\n censusInfo.merkleRoot,\n censusInfo.uri,\n censusInfo.anonymous ? CensusType.ANONYMOUS : CensusType.WEIGHTED,\n censusInfo.size,\n BigInt(censusInfo.weight)\n);\n")),(0,r.kt)("p",null,"This census can be used to create an election just like any other. In this case, the census would represent all token-holders of the ",(0,r.kt)("inlineCode",{parentName:"p"},"VOC3TEST")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"VOC3TEST3")," tokens, all with a weight of 1."))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e3461e1c.516a21b8.js b/assets/js/e3461e1c.516a21b8.js deleted file mode 100644 index 258b7137f..000000000 --- a/assets/js/e3461e1c.516a21b8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9849],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>c});var r=n(67294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var d=r.createContext({}),p=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=p(e.components);return r.createElement(d.Provider,{value:t},e.children)},o={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var n=e.components,s=e.mdxType,a=e.originalType,d=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),k=p(n),c=s,m=k["".concat(d,".").concat(c)]||k[c]||o[c]||a;return n?r.createElement(m,i(i({ref:t},u),{},{components:n})):r.createElement(m,i({ref:t},u))}));function c(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var a=n.length,i=new Array(a);i[0]=k;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l.mdxType="string"==typeof e?e:s,i[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>o,frontMatter:()=>a,metadata:()=>l,toc:()=>p});var r=n(87462),s=(n(67294),n(3905));const a={},i=void 0,l={unversionedId:"sdk/reference/classes/CspCensus",id:"sdk/reference/classes/CspCensus",title:"CspCensus",description:"@vocdoni/sdk / Exports / CspCensus",source:"@site/docs/sdk/reference/classes/CspCensus.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/CspCensus",permalink:"/sdk/reference/classes/CspCensus",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ChainService",permalink:"/sdk/reference/classes/ChainService"},next:{title:"CspService",permalink:"/sdk/reference/classes/CspService"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_censusId",id:"_censusid",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_censusURI",id:"_censusuri",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_type",id:"_type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"censusId",id:"censusid",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isPublished",id:"ispublished",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"type",id:"type",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"weight",id:"weight",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Methods",id:"methods-1",level:2},{value:"censusTypeFromCensusOrigin",id:"censustypefromcensusorigin",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-15",level:4}],u={toc:p};function o(e){let{components:t,...n}=e;return(0,s.kt)("wrapper",(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / CspCensus"),(0,s.kt)("h1",{id:"class-cspcensus"},"Class: CspCensus"),(0,s.kt)("p",null,"Represents a published census"),(0,s.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("p",{parentName:"li"},(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,s.kt)("inlineCode",{parentName:"a"},"Census"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("strong",{parentName:"p"},(0,s.kt)("inlineCode",{parentName:"strong"},"CspCensus"))))),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"constructors"},"Constructors"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspCensus#constructor"},"constructor"))),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspCensus#_censusid"},"_","censusId")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspCensus#_censusuri"},"_","censusURI")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspCensus#_type"},"_","type"))),(0,s.kt)("h3",{id:"accessors"},"Accessors"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspCensus#censusid"},"censusId")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspCensus#censusuri"},"censusURI")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspCensus#ispublished"},"isPublished")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspCensus#size"},"size")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspCensus#type"},"type")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspCensus#weight"},"weight"))),(0,s.kt)("h3",{id:"methods"},"Methods"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin"))),(0,s.kt)("h2",{id:"constructors-1"},"Constructors"),(0,s.kt)("h3",{id:"constructor"},"constructor"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"new CspCensus"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"publicKey"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"cspURI"),"): ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CspCensus"},(0,s.kt)("inlineCode",{parentName:"a"},"CspCensus"))),(0,s.kt)("p",null,"Constructs a CSP census"),(0,s.kt)("h4",{id:"parameters"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"publicKey")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The public")),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"cspURI")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The URI of the CSP server")))),(0,s.kt)("h4",{id:"returns"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CspCensus"},(0,s.kt)("inlineCode",{parentName:"a"},"CspCensus"))),(0,s.kt)("h4",{id:"overrides"},"Overrides"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#constructor"},"constructor")),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/csp.ts#L14"},"types/census/csp.ts:14")),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"_censusid"},"_","censusId"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,s.kt)("strong",{parentName:"p"},"_","censusId"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_censusid"},"_censusId")),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L12"},"types/census/census.ts:12")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"_censusuri"},"_","censusURI"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,s.kt)("strong",{parentName:"p"},"_","censusURI"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_censusuri"},"_censusURI")),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L13"},"types/census/census.ts:13")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"_type"},"_","type"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,s.kt)("strong",{parentName:"p"},"_","type"),": ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_type"},"_type")),(0,s.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L14"},"types/census/census.ts:14")),(0,s.kt)("h2",{id:"accessors-1"},"Accessors"),(0,s.kt)("h3",{id:"censusid"},"censusId"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"censusId"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"returns-1"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,s.kt)("p",null,"Census.censusId"),(0,s.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L35"},"types/census/census.ts:35")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"censusId"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-1"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string"))))),(0,s.kt)("h4",{id:"returns-2"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,s.kt)("p",null,"Census.censusId"),(0,s.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L39"},"types/census/census.ts:39")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"censusuri"},"censusURI"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"censusURI"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"returns-3"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,s.kt)("p",null,"Census.censusURI"),(0,s.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L43"},"types/census/census.ts:43")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"censusURI"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-2"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string"))))),(0,s.kt)("h4",{id:"returns-4"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,s.kt)("p",null,"Census.censusURI"),(0,s.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L47"},"types/census/census.ts:47")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"ispublished"},"isPublished"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"isPublished"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"boolean")),(0,s.kt)("h4",{id:"returns-5"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"boolean")),(0,s.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,s.kt)("p",null,"Census.isPublished"),(0,s.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L75"},"types/census/census.ts:75")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"size"},"size"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"size"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("h4",{id:"returns-6"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,s.kt)("p",null,"Census.size"),(0,s.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L59"},"types/census/census.ts:59")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"size"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-3"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"number"))))),(0,s.kt)("h4",{id:"returns-7"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,s.kt)("p",null,"Census.size"),(0,s.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L63"},"types/census/census.ts:63")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"type"},"type"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"type"),"(): ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"returns-8"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,s.kt)("p",null,"Census.type"),(0,s.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L51"},"types/census/census.ts:51")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"type"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-4"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("a",{parentName:"td",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType")))))),(0,s.kt)("h4",{id:"returns-9"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,s.kt)("p",null,"Census.type"),(0,s.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L55"},"types/census/census.ts:55")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"weight"},"weight"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"weight"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"bigint")),(0,s.kt)("h4",{id:"returns-10"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"bigint")),(0,s.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,s.kt)("p",null,"Census.weight"),(0,s.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L67"},"types/census/census.ts:67")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"weight"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-5"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,s.kt)("h4",{id:"returns-11"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,s.kt)("p",null,"Census.weight"),(0,s.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L71"},"types/census/census.ts:71")),(0,s.kt)("h2",{id:"methods-1"},"Methods"),(0,s.kt)("h3",{id:"censustypefromcensusorigin"},"censusTypeFromCensusOrigin"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("strong",{parentName:"p"},"censusTypeFromCensusOrigin"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"censusOrigin"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"parameters-6"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"censusOrigin")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"boolean")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"false"))))),(0,s.kt)("h4",{id:"returns-12"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#censustypefromcensusorigin"},"censusTypeFromCensusOrigin")),(0,s.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L81"},"types/census/census.ts:81")))}o.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e3461e1c.56b74d98.js b/assets/js/e3461e1c.56b74d98.js new file mode 100644 index 000000000..4c54df55e --- /dev/null +++ b/assets/js/e3461e1c.56b74d98.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9849],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var r=n(67294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var p=r.createContext({}),d=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},o={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var n=e.components,s=e.mdxType,a=e.originalType,p=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),k=d(n),m=s,c=k["".concat(p,".").concat(m)]||k[m]||o[m]||a;return n?r.createElement(c,i(i({ref:t},u),{},{components:n})):r.createElement(c,i({ref:t},u))}));function m(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var a=n.length,i=new Array(a);i[0]=k;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:s,i[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>o,frontMatter:()=>a,metadata:()=>l,toc:()=>d});var r=n(87462),s=(n(67294),n(3905));const a={},i=void 0,l={unversionedId:"sdk/reference/classes/CspCensus",id:"sdk/reference/classes/CspCensus",title:"CspCensus",description:"@vocdoni/sdk / Exports / CspCensus",source:"@site/docs/sdk/reference/classes/CspCensus.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/CspCensus",permalink:"/sdk/reference/classes/CspCensus",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ChainService",permalink:"/sdk/reference/classes/ChainService"},next:{title:"CspService",permalink:"/sdk/reference/classes/CspService"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_censusId",id:"_censusid",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"_censusURI",id:"_censusuri",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"_type",id:"_type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"censusId",id:"censusid",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"censusURI",id:"censusuri",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"isPublished",id:"ispublished",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"size",id:"size",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"type",id:"type",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"weight",id:"weight",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"Methods",id:"methods-1",level:2},{value:"censusTypeFromCensusOrigin",id:"censustypefromcensusorigin",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-15",level:4}],u={toc:d};function o(e){let{components:t,...n}=e;return(0,s.kt)("wrapper",(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / CspCensus"),(0,s.kt)("h1",{id:"class-cspcensus"},"Class: CspCensus"),(0,s.kt)("p",null,"Represents a published census"),(0,s.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("p",{parentName:"li"},(0,s.kt)("a",{parentName:"p",href:"Census"},(0,s.kt)("inlineCode",{parentName:"a"},"Census"))),(0,s.kt)("p",{parentName:"li"},"\u21b3 ",(0,s.kt)("strong",{parentName:"p"},(0,s.kt)("inlineCode",{parentName:"strong"},"CspCensus"))))),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"constructors"},"Constructors"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"CspCensus#constructor"},"constructor"))),(0,s.kt)("h3",{id:"properties"},"Properties"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspCensus#_censusid"},"_","censusId")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspCensus#_censusuri"},"_","censusURI")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/classes/CspCensus#_type"},"_","type"))),(0,s.kt)("h3",{id:"accessors"},"Accessors"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"CspCensus#censusid"},"censusId")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"CspCensus#censusuri"},"censusURI")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"CspCensus#ispublished"},"isPublished")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"CspCensus#size"},"size")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"CspCensus#type"},"type")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"CspCensus#weight"},"weight"))),(0,s.kt)("h3",{id:"methods"},"Methods"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"CspCensus#censustypefromcensusorigin"},"censusTypeFromCensusOrigin"))),(0,s.kt)("h2",{id:"constructors-1"},"Constructors"),(0,s.kt)("h3",{id:"constructor"},"constructor"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"new CspCensus"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"publicKey"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"cspURI"),"): ",(0,s.kt)("a",{parentName:"p",href:"CspCensus"},(0,s.kt)("inlineCode",{parentName:"a"},"CspCensus"))),(0,s.kt)("p",null,"Constructs a CSP census"),(0,s.kt)("h4",{id:"parameters"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"publicKey")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The public")),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"cspURI")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},"The URI of the CSP server")))),(0,s.kt)("h4",{id:"returns"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"CspCensus"},(0,s.kt)("inlineCode",{parentName:"a"},"CspCensus"))),(0,s.kt)("h4",{id:"overrides"},"Overrides"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,s.kt)("a",{parentName:"p",href:"Census#constructor"},"constructor")),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/csp.ts#L14"},"types/census/csp.ts:14")),(0,s.kt)("h2",{id:"properties-1"},"Properties"),(0,s.kt)("h3",{id:"_censusid"},"_","censusId"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,s.kt)("strong",{parentName:"p"},"_","censusId"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"Census"},"Census"),".",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_censusid"},"_censusId")),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L12"},"types/census/census.ts:12")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"_censusuri"},"_","censusURI"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,s.kt)("strong",{parentName:"p"},"_","censusURI"),": ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"Census"},"Census"),".",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_censusuri"},"_censusURI")),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L13"},"types/census/census.ts:13")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"_type"},"_","type"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"Protected")," ",(0,s.kt)("strong",{parentName:"p"},"_","type"),": ",(0,s.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"Census"},"Census"),".",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census#_type"},"_type")),(0,s.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L14"},"types/census/census.ts:14")),(0,s.kt)("h2",{id:"accessors-1"},"Accessors"),(0,s.kt)("h3",{id:"censusid"},"censusId"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"censusId"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"returns-1"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,s.kt)("p",null,"Census.censusId"),(0,s.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L35"},"types/census/census.ts:35")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"censusId"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-1"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string"))))),(0,s.kt)("h4",{id:"returns-2"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,s.kt)("p",null,"Census.censusId"),(0,s.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L39"},"types/census/census.ts:39")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"censusuri"},"censusURI"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"censusURI"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"returns-3"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"string")),(0,s.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,s.kt)("p",null,"Census.censusURI"),(0,s.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L43"},"types/census/census.ts:43")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"censusURI"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-2"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string"))))),(0,s.kt)("h4",{id:"returns-4"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,s.kt)("p",null,"Census.censusURI"),(0,s.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L47"},"types/census/census.ts:47")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"ispublished"},"isPublished"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"isPublished"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"boolean")),(0,s.kt)("h4",{id:"returns-5"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"boolean")),(0,s.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,s.kt)("p",null,"Census.isPublished"),(0,s.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L75"},"types/census/census.ts:75")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"size"},"size"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"size"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("h4",{id:"returns-6"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"number")),(0,s.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,s.kt)("p",null,"Census.size"),(0,s.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L59"},"types/census/census.ts:59")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"size"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-3"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"number"))))),(0,s.kt)("h4",{id:"returns-7"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,s.kt)("p",null,"Census.size"),(0,s.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L63"},"types/census/census.ts:63")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"type"},"type"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"type"),"(): ",(0,s.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"returns-8"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,s.kt)("p",null,"Census.type"),(0,s.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L51"},"types/census/census.ts:51")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"type"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-4"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("a",{parentName:"td",href:"../enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType")))))),(0,s.kt)("h4",{id:"returns-9"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,s.kt)("p",null,"Census.type"),(0,s.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L55"},"types/census/census.ts:55")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"weight"},"weight"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"get")," ",(0,s.kt)("strong",{parentName:"p"},"weight"),"(): ",(0,s.kt)("inlineCode",{parentName:"p"},"bigint")),(0,s.kt)("h4",{id:"returns-10"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"bigint")),(0,s.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,s.kt)("p",null,"Census.weight"),(0,s.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L67"},"types/census/census.ts:67")),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("inlineCode",{parentName:"p"},"set")," ",(0,s.kt)("strong",{parentName:"p"},"weight"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"parameters-5"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"value")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"bigint"))))),(0,s.kt)("h4",{id:"returns-11"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("inlineCode",{parentName:"p"},"void")),(0,s.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,s.kt)("p",null,"Census.weight"),(0,s.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L71"},"types/census/census.ts:71")),(0,s.kt)("h2",{id:"methods-1"},"Methods"),(0,s.kt)("h3",{id:"censustypefromcensusorigin"},"censusTypeFromCensusOrigin"),(0,s.kt)("p",null,"\u25b8 ",(0,s.kt)("strong",{parentName:"p"},"censusTypeFromCensusOrigin"),"(",(0,s.kt)("inlineCode",{parentName:"p"},"censusOrigin"),", ",(0,s.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,s.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"parameters-6"},"Parameters"),(0,s.kt)("table",null,(0,s.kt)("thead",{parentName:"table"},(0,s.kt)("tr",{parentName:"thead"},(0,s.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,s.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,s.kt)("tbody",{parentName:"table"},(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"censusOrigin")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"string")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,s.kt)("tr",{parentName:"tbody"},(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"boolean")),(0,s.kt)("td",{parentName:"tr",align:"left"},(0,s.kt)("inlineCode",{parentName:"td"},"false"))))),(0,s.kt)("h4",{id:"returns-12"},"Returns"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"../enums/CensusType"},(0,s.kt)("inlineCode",{parentName:"a"},"CensusType"))),(0,s.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},"Census"),".",(0,s.kt)("a",{parentName:"p",href:"Census#censustypefromcensusorigin"},"censusTypeFromCensusOrigin")),(0,s.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L81"},"types/census/census.ts:81")))}o.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e3cace69.56f3d4e9.js b/assets/js/e3cace69.56f3d4e9.js deleted file mode 100644 index e507a42a1..000000000 --- a/assets/js/e3cace69.56f3d4e9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9787],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>d});var o=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function a(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=o.createContext({}),p=function(e){var t=o.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},c=function(e){var t=p(e.components);return o.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},m=o.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),m=p(n),d=i,h=m["".concat(s,".").concat(d)]||m[d]||u[d]||r;return n?o.createElement(h,a(a({ref:t},c),{},{components:n})):o.createElement(h,a({ref:t},c))}));function d(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,a=new Array(r);a[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:i,a[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>l,toc:()=>p});var o=n(87462),i=(n(67294),n(3905));const r={sidebar_position:4,slug:"approval"},a="Approval Voting (Multiple Choice)",l={unversionedId:"sdk/voting-types/approval",id:"sdk/voting-types/approval",title:"Approval Voting (Multiple Choice)",description:"An election with Approval voting is a voting system where voters are allowed to indicate their support for multiple",source:"@site/docs/sdk/voting-types/approval.md",sourceDirName:"sdk/voting-types",slug:"/sdk/voting-types/approval",permalink:"/sdk/voting-types/approval",draft:!1,tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4,slug:"approval"},sidebar:"defaultSidebar",previous:{title:"Ranked Voting",permalink:"/sdk/voting-types/ranked"},next:{title:"Weighted voting",permalink:"/sdk/voting-types/weighted"}},s={},p=[{value:"Setting up the election",id:"setting-up-the-election",level:2},{value:"Casting a vote",id:"casting-a-vote",level:2},{value:"Results interpretation",id:"results-interpretation",level:2}],c={toc:p};function u(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,o.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"approval-voting-multiple-choice"},"Approval Voting (Multiple Choice)"),(0,i.kt)("p",null,'An election with Approval voting is a voting system where voters are allowed to indicate their support for multiple\ncandidates or options on the ballot. Instead of selecting just one preferred choice, voters can approve or "check" off\nall the candidates they deem acceptable or worthy of their support.'),(0,i.kt)("p",null,"Approval voting does not involve ranking or prioritizing candidates; it simply allows voters to express their approval\nfor multiple choices. This system aims to provide a more nuanced representation of voter preferences and can encourage\ncandidates to appeal to a broader range of voters."),(0,i.kt)("p",null,"For example: select your two favourite colors from a list of 4."),(0,i.kt)("p",null,"See:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/vocdoni-sdk/blob/main/examples/typescript/src/approval.ts"},"Complete example")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/protocol/ballot-protocol#multiple-choice"},"Ballot protocol implementation"))),(0,i.kt)("h2",{id:"setting-up-the-election"},"Setting up the election"),(0,i.kt)("p",null,"The configuration of the vote type for the election should be set as follows:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"const election_opts: IVoteType = {\n uniqueChoices: false,\n costFromWeight: false,\n maxCount: 4, // Correspond to the number of choices of the given question.\n maxValue: 1, // Determines the maximum value that can be assigned to a single choice.\n maxTotalCost: 2, // Set the maximum number of choices a user can select. \n}\n")),(0,i.kt)("p",null,"In this election type, a voter can cast a vote for option, hence ",(0,i.kt)("inlineCode",{parentName:"p"},"maxValue")," must be set to ",(0,i.kt)("inlineCode",{parentName:"p"},"1"),". Also, the ",(0,i.kt)("inlineCode",{parentName:"p"},"maxTotalCost"),"\nis used to define the maximum number of selectable choices."),(0,i.kt)("admonition",{title:"Multiple questions not supported",type:"danger"},(0,i.kt)("p",{parentName:"admonition"},(0,i.kt)("strong",{parentName:"p"},"This election type not support multiple questions"),": the current Vocdoni implementation restricts this kind of elections to a single question. To create an election with multiple questions check ",(0,i.kt)("a",{parentName:"p",href:"/protocol/ballot-protocol#multiquestion"},"multi question election"))),(0,i.kt)("h2",{id:"casting-a-vote"},"Casting a vote"),(0,i.kt)("p",null,"To cast a vote, use the method below:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"client.submitVote(new Vote([0, 1, 0, 1]));\n")),(0,i.kt)("p",null,"Each entry in the array corresponds to a selected choice in the election, with the value assigned to each entry set to 1,\nas per ",(0,i.kt)("inlineCode",{parentName:"p"},"maxValue"),". ",(0,i.kt)("inlineCode",{parentName:"p"},"maxTotalCost")," defines the maximum number of choices a voter can select. The array's length should\nmatch the total number of choices in the election (",(0,i.kt)("inlineCode",{parentName:"p"},"maxCount"),")."),(0,i.kt)("h2",{id:"results-interpretation"},"Results interpretation"),(0,i.kt)("p",null,"Assume a scenario where ten voters cast identical votes, i.e. ",(0,i.kt)("inlineCode",{parentName:"p"},"[0, 1, 0, 1]"),"."),(0,i.kt)("p",null,"The election results would be represented as a two-dimensional array:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre"},"[ \n [ '10', '0' ], \n [ '0', '10' ], \n [ '10', '0' ], \n [ '0', '10' ] \n]\n")),(0,i.kt)("p",null,"Each position in the outer array corresponds to the available choices, and each position within the inner arrays\nsignifies the number of voters who selected or did not select the corresponding choice. For example, ",(0,i.kt)("inlineCode",{parentName:"p"},"[10, 0]")," indicates\nten users did not select the choice, whereas ",(0,i.kt)("inlineCode",{parentName:"p"},"[0, 10]")," means that ten users voted for the choice. So:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"For choice ",(0,i.kt)("inlineCode",{parentName:"li"},"0"),", all 10 voters assigned it ",(0,i.kt)("inlineCode",{parentName:"li"},"0")," points,"),(0,i.kt)("li",{parentName:"ul"},"For choice ",(0,i.kt)("inlineCode",{parentName:"li"},"1"),", all 10 voters assigned it ",(0,i.kt)("inlineCode",{parentName:"li"},"1")," point,"),(0,i.kt)("li",{parentName:"ul"},"For choice ",(0,i.kt)("inlineCode",{parentName:"li"},"2"),", all 10 voters assigned it ",(0,i.kt)("inlineCode",{parentName:"li"},"0")," points, and"),(0,i.kt)("li",{parentName:"ul"},"For choice ",(0,i.kt)("inlineCode",{parentName:"li"},"3"),", all 10 voters assigned it ",(0,i.kt)("inlineCode",{parentName:"li"},"1")," point.")),(0,i.kt)("p",null,"Remember, this interpretation assumes that all voters have used the same voting pattern."))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e7df0fec.efaa1644.js b/assets/js/e7df0fec.260f4aad.js similarity index 55% rename from assets/js/e7df0fec.efaa1644.js rename to assets/js/e7df0fec.260f4aad.js index 9da8fa304..6247ebce2 100644 --- a/assets/js/e7df0fec.efaa1644.js +++ b/assets/js/e7df0fec.260f4aad.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[248],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>f});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),l=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},u=function(e){var t=l(e.components);return n.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),c=l(r),f=a,m=c["".concat(p,".").concat(f)]||c[f]||d[f]||o;return r?n.createElement(m,s(s({ref:t},u),{},{components:r})):n.createElement(m,s({ref:t},u))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,s=new Array(o);s[0]=c;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i.mdxType="string"==typeof e?e:a,s[1]=i;for(var l=2;l{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var n=r(87462),a=(r(67294),r(3905));const o={},s=void 0,i={unversionedId:"sdk/reference/interfaces/ICensus3StrategyImportQueueResponse",id:"sdk/reference/interfaces/ICensus3StrategyImportQueueResponse",title:"ICensus3StrategyImportQueueResponse",description:"@vocdoni/sdk / Exports / ICensus3StrategyImportQueueResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategyHoldersResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated"},next:{title:"ICensus3StrategyToken",permalink:"/sdk/reference/interfaces/ICensus3StrategyToken"}},p={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"done",id:"done",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"strategy",id:"strategy",level:3},{value:"Defined in",id:"defined-in-2",level:4}],u={toc:l};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3StrategyImportQueueResponse"),(0,a.kt)("h1",{id:"interface-icensus3strategyimportqueueresponse"},"Interface: ICensus3StrategyImportQueueResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse#done"},"done")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse#error"},"error")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse#strategy"},"strategy"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"done"},"done"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"done"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"If the queue has been done"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L148"},"api/census3/strategy.ts:148")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"error"},"error"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"error"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("p",null,"The error of the queue"),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"code")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The code of the error")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The string of the error")))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L153"},"api/census3/strategy.ts:153")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"strategy"},"strategy"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"strategy"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules#census3strategy"},(0,a.kt)("inlineCode",{parentName:"a"},"Census3Strategy"))),(0,a.kt)("p",null,"The imported strategy"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L168"},"api/census3/strategy.ts:168")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[248],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>f});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),l=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},u=function(e){var t=l(e.components);return n.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),c=l(r),f=a,m=c["".concat(p,".").concat(f)]||c[f]||d[f]||o;return r?n.createElement(m,s(s({ref:t},u),{},{components:r})):n.createElement(m,s({ref:t},u))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,s=new Array(o);s[0]=c;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i.mdxType="string"==typeof e?e:a,s[1]=i;for(var l=2;l{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var n=r(87462),a=(r(67294),r(3905));const o={},s=void 0,i={unversionedId:"sdk/reference/interfaces/ICensus3StrategyImportQueueResponse",id:"sdk/reference/interfaces/ICensus3StrategyImportQueueResponse",title:"ICensus3StrategyImportQueueResponse",description:"@vocdoni/sdk / Exports / ICensus3StrategyImportQueueResponse",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategyHoldersResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated"},next:{title:"ICensus3StrategyToken",permalink:"/sdk/reference/interfaces/ICensus3StrategyToken"}},p={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"done",id:"done",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"strategy",id:"strategy",level:3},{value:"Defined in",id:"defined-in-2",level:4}],u={toc:l};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3StrategyImportQueueResponse"),(0,a.kt)("h1",{id:"interface-icensus3strategyimportqueueresponse"},"Interface: ICensus3StrategyImportQueueResponse"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3StrategyImportQueueResponse#done"},"done")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3StrategyImportQueueResponse#error"},"error")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3StrategyImportQueueResponse#strategy"},"strategy"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"done"},"done"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"done"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"If the queue has been done"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L148"},"api/census3/strategy.ts:148")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"error"},"error"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"error"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("p",null,"The error of the queue"),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"code")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"number")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The code of the error")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The string of the error")))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L153"},"api/census3/strategy.ts:153")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"strategy"},"strategy"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"strategy"),": ",(0,a.kt)("a",{parentName:"p",href:"../modules#census3strategy"},(0,a.kt)("inlineCode",{parentName:"a"},"Census3Strategy"))),(0,a.kt)("p",null,"The imported strategy"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L168"},"api/census3/strategy.ts:168")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e7ebf400.09c59db1.js b/assets/js/e7ebf400.09c59db1.js deleted file mode 100644 index 06ad9b63c..000000000 --- a/assets/js/e7ebf400.09c59db1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2226],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>d});var o=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);n&&(o=o.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,o)}return t}function i(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=o.createContext({}),c=function(e){var n=o.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},p=function(e){var n=c(e.components);return o.createElement(l.Provider,{value:n},e.children)},m={inlineCode:"code",wrapper:function(e){var n=e.children;return o.createElement(o.Fragment,{},n)}},u=o.forwardRef((function(e,n){var t=e.components,a=e.mdxType,r=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(t),d=a,h=u["".concat(l,".").concat(d)]||u[d]||m[d]||r;return t?o.createElement(h,i(i({ref:n},p),{},{components:t})):o.createElement(h,i({ref:n},p))}));function d(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var r=t.length,i=new Array(r);i[0]=u;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,i[1]=s;for(var c=2;c{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>i,default:()=>m,frontMatter:()=>r,metadata:()=>s,toc:()=>c});var o=t(87462),a=(t(67294),t(3905));const r={title:"UI Components",description:"Vocdoni Chakra components"},i="UI Components with Chakra UI",s={unversionedId:"ui-components/index",id:"ui-components/index",title:"UI Components",description:"Vocdoni Chakra components",source:"@site/docs/ui-components/index.md",sourceDirName:"ui-components",slug:"/ui-components/",permalink:"/ui-components/",draft:!1,tags:[],version:"current",frontMatter:{title:"UI Components",description:"Vocdoni Chakra components"},sidebar:"defaultSidebar",previous:{title:"Quadratic voting",permalink:"/sdk/voting-types/quadratic"},next:{title:"Organization components",permalink:"/ui-components/Organization"}},l={},c=[{value:"Installing",id:"installing",level:2},{value:"Usage",id:"usage",level:2},{value:"Theming",id:"theming",level:2},{value:"Theming components",id:"theming-components",level:3},{value:"Styling via props",id:"styling-via-props",level:4},{value:"Theming complex multipart components",id:"theming-complex-multipart-components",level:4},{value:"i18n",id:"i18n",level:3},{value:"LICENSE",id:"license",level:2}],p={toc:c};function m(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,o.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"ui-components-with-chakra-ui"},"UI Components with Chakra UI"),(0,a.kt)("p",null,"Chakra ui components for easily integrating Vocdoni services."),(0,a.kt)("h2",{id:"installing"},"Installing"),(0,a.kt)("p",null,"You'll first need to have a project with chakra installed and configured. Follow\ntheir ",(0,a.kt)("a",{parentName:"p",href:"https://chakra-ui.com/getting-started"},"official documentation")," in order to do so."),(0,a.kt)("p",null,"After that, you can add the required vocdoni components dependencies:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"yarn add @vocdoni/sdk @vocdoni/chakra-components react-markdown remark-gfm\n")),(0,a.kt)("h2",{id:"usage"},"Usage"),(0,a.kt)("p",null,"The very first step is to add the ",(0,a.kt)("inlineCode",{parentName:"p"},"")," as a wrapper of your\napplication or, at least, of your election:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"import { ClientProvider } from '@vocdoni/chakra-components'\n\nconst App = () => {\n const signer = /* any ethers based signer */\n return (\n \n {/* your actual app code */}\n \n )\n}\n")),(0,a.kt)("p",null,"Note ",(0,a.kt)("inlineCode",{parentName:"p"},"env")," can be any of the ",(0,a.kt)("a",{parentName:"p",href:"/sdk/integration-details#environment"},"SDK available environments"),",\neither in string format, or using the SDK ",(0,a.kt)("inlineCode",{parentName:"p"},"EnvOptions")," enum."),(0,a.kt)("p",null,"After that, the easiest way to integrate a voting would be to just import the\n",(0,a.kt)("inlineCode",{parentName:"p"},"Election")," component and specify it an id for your election:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"import { Election } from '@vocdoni/chakra-components'\n\nconst CustomVoteComponent = () => {\n return \n}\n")),(0,a.kt)("p",null,"This will automatically instance the Election Provider with all the available\nvoting components. You can style it following the ",(0,a.kt)("a",{parentName:"p",href:"#theming"},"instructions below"),",\nand/or you can also create your own vote view, based on the components used by\nthe ",(0,a.kt)("inlineCode",{parentName:"p"},"Election")," component, and style it directly with props:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"import {\n ElectionProvider,\n ElectionTitle,\n ElectionSchedule,\n ElectionStatusBadge,\n ElectionDescription,\n HR,\n ElectionQuestions,\n} from '@vocdoni/chakra-components'\n\nconst CustomVoteComponent = () => {\n return (\n \n \n \n \n \n \n
\n \n \n )\n}\n")),(0,a.kt)("p",null,"Take a look at section below on more examples of how to style the voting\ncomponents."),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"Note you won't see some required styles if you have not added the\nChakraProvider to your project, see below for more details on this.")),(0,a.kt)("h2",{id:"theming"},"Theming"),(0,a.kt)("p",null,"Since these components use chakra's theming system, the way to style these\nvoting components is\n",(0,a.kt)("a",{parentName:"p",href:"https://chakra-ui.com/docs/styled-system/customize-theme#customizing-component-styles"},"the same as described in their documentation"),", but using the\ncustom components we defined (see ",(0,a.kt)("a",{parentName:"p",href:"#theming-components"},"theming components")," for more details)."),(0,a.kt)("p",null,"In order to start styling the voting components, you should use the\n",(0,a.kt)("inlineCode",{parentName:"p"},"ChakraProvider"),", and customize the passed theme:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"// this can be imported from '@chakra-ui/react' too, but that's more generic\nimport { extendTheme } from '@chakra-ui/system'\nimport { theme } from '@vocdoni/chakra-components'\n\nexport const App = () => (\n \n {/* YOUR APP CONTENTS */}\n \n)\n")),(0,a.kt)("p",null,"As you can see, we're importing a custom defined theme from\n",(0,a.kt)("inlineCode",{parentName:"p"},"@vocdoni/chakra-components"),", but at the same time, we're using ",(0,a.kt)("inlineCode",{parentName:"p"},"extendTheme"),".\nThis is because we're not merging our styles with the base chakra theme, both to\navoid a bigger bundle size and to ensure we don't unexpectedly overwrite styles."),(0,a.kt)("p",null,"The above example is the easiest way to get all the default styles up and\nrunning, but you can always define your entire theme and ignore our base styles.\nSee how our components are grainly styled below, in ","[components structure]","."),(0,a.kt)("p",null,"In case you want to add the voting components to a page and ensure chakra-ui\nwill not affect your theme, you may need to pass ",(0,a.kt)("inlineCode",{parentName:"p"},"resetCSS={false}")," as a\ncomponent prop:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"import { extendTheme } from '@chakra-ui/system'\nimport { theme } from '@vocdoni/chakra-components'\n\nexport const App = () => (\n \n {/* YOUR APP CONTENTS */}\n \n)\n")),(0,a.kt)("p",null,"If you want to extend or change the theme, you can pass your changes as a second\nargument to ",(0,a.kt)("inlineCode",{parentName:"p"},"extendTheme"),":"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"import { extendTheme } from '@chakra-ui/react'\nimport { theme as vtheme } from '@vocdoni/chakra-components'\n\nconst theme = extendTheme(vtheme, {\n // any theme changes would go here\n components: {\n // [...]\n },\n})\n\nexport const App = () => (\n \n {/* YOUR APP CONTENTS */}\n \n)\n")),(0,a.kt)("p",null,"We have applied a few amount of styles, so you can perfectly ignore our styles\nand write them from the ground up."),(0,a.kt)("h3",{id:"theming-components"},"Theming components"),(0,a.kt)("p",null,"Since you have components for every part of an election process, you can follow\nthe official Chakra documentation on how to customize component styles, and just\nuse our components where required."),(0,a.kt)("p",null,"Here's a small example styling the title and image of elections:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { extendTheme, ComponentSingleStyleConfig } from '@chakra-ui/react'\nimport { theme as vtheme } from '@vocdoni/chakra-components'\n\nconst ElectionTitle : ComponentsStyleConfig = {\n baseStyle: {\n paddingTop: '.5em',\n position: 'relative',\n marginTop: '-2.5em',\n background: 'linear-gradient(180deg, rgba(0,0,0,0.50) 0%, rgba(255,255,255,0) 100%)',\n }\n}\n\nconst ElectionHeader : ComponentsStyleConfig = {\n baseStyle: {\n minHeight: '3em'\n }\n}\n\nconst theme = extendTheme(vtheme, {\n components: {\n ElectionTitle,\n ElectionHeader,\n },\n})\n\n// this theme would then be used directly in your ChakraProvider instance\nexport default theme\n")),(0,a.kt)("h4",{id:"styling-via-props"},"Styling via props"),(0,a.kt)("p",null,"All components have all the features you would expect from a chakra component,\nmeaning you can style all components via component props too:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"import { ElectionTitle, ElectionHeader } from '@vocdoni/chakra-components'\n\nconst App = () => (\n \n \n \n \n)\n")),(0,a.kt)("h4",{id:"theming-complex-multipart-components"},"Theming complex multipart components"),(0,a.kt)("p",null,"Some components, like ",(0,a.kt)("inlineCode",{parentName:"p"},"")," follow a multipart component\nstructure. Please refer to the\n",(0,a.kt)("a",{parentName:"p",href:"https://chakra-ui.com/docs/styled-system/component-style#styling-multipart-components"},"official chakra documentation")," for more info on how to\nstyle these type of components."),(0,a.kt)("p",null,"Here's a small example styling the ",(0,a.kt)("inlineCode",{parentName:"p"},"ElectionQuestions")," component:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { extendTheme, createMultiStyleConfigHelpers } from '@chakra-ui/react'\nimport { theme as vtheme, questionsAnatomy } from '@vocdoni/chakra-components'\n\nconst { defineMultiStyleConfig, definePartsStyle } = createMultiStyleConfigHelpers(questionsAnatomy)\n\nconst ElectionQuestions = defineMultiStyleConfig({\n baseStyle: definePartsStyle({\n title: {\n color: 'lightblue',\n },\n description: {\n color: 'lightgreen',\n }\n }),\n})\n\nconst theme = extendTheme(vtheme, {\n components: {\n ElectionQuestions,\n },\n})\n\n// this theme would then be used directly in your ChakraProvider instance\nexport default theme\n")),(0,a.kt)("p",null,"You can check out each component's anatomy by checking\n",(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/ui-components/tree/7e2f161be654b287ebc82d553c316164e20c8fd3/templates/chakra/src/theme"},"their theme files"),"."),(0,a.kt)("h3",{id:"i18n"},"i18n"),(0,a.kt)("p",null,"In order to change any of the texts contained in ",(0,a.kt)("inlineCode",{parentName:"p"},"@vocdoni/chakra-components"),",\nyou must specify the translations for each language in the ClientProvider:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"const translationsObject = {\n en: {\n // all english translations\n },\n ca: {\n // catalan translations\n }\n}\n\n")),(0,a.kt)("p",null,"Check out the ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/ui-components/blob/7e2f161be654b287ebc82d553c316164e20c8fd3/packages/react-providers/src/i18n/localize.tsx"},"translations file")," in order to see all the available keys."),(0,a.kt)("h2",{id:"license"},"LICENSE"),(0,a.kt)("p",null,"This components library is licensed under the ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/ui-components/blob/main/LICENSE"},"GNU Affero General Public License\nv3.0"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"Vocdoni UI React Components\nCopyright (C) 2023 Vocdoni Roots MCU\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program. If not, see .\n")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e7ebf400.27c3ff88.js b/assets/js/e7ebf400.27c3ff88.js new file mode 100644 index 000000000..540004dd7 --- /dev/null +++ b/assets/js/e7ebf400.27c3ff88.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2226],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>d});var o=t(67294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);n&&(o=o.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,o)}return t}function i(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=o.createContext({}),c=function(e){var n=o.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},p=function(e){var n=c(e.components);return o.createElement(l.Provider,{value:n},e.children)},m={inlineCode:"code",wrapper:function(e){var n=e.children;return o.createElement(o.Fragment,{},n)}},u=o.forwardRef((function(e,n){var t=e.components,a=e.mdxType,r=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(t),d=a,h=u["".concat(l,".").concat(d)]||u[d]||m[d]||r;return t?o.createElement(h,i(i({ref:n},p),{},{components:t})):o.createElement(h,i({ref:n},p))}));function d(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var r=t.length,i=new Array(r);i[0]=u;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,i[1]=s;for(var c=2;c{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>i,default:()=>m,frontMatter:()=>r,metadata:()=>s,toc:()=>c});var o=t(87462),a=(t(67294),t(3905));const r={title:"UI Components",description:"Vocdoni Chakra components"},i="UI Components with Chakra UI",s={unversionedId:"ui-components/index",id:"ui-components/index",title:"UI Components",description:"Vocdoni Chakra components",source:"@site/docs/ui-components/index.md",sourceDirName:"ui-components",slug:"/ui-components/",permalink:"/ui-components/",draft:!1,tags:[],version:"current",frontMatter:{title:"UI Components",description:"Vocdoni Chakra components"},sidebar:"defaultSidebar",previous:{title:"Changelog",permalink:"/sdk/reference/changelog"},next:{title:"Organization components",permalink:"/ui-components/Organization"}},l={},c=[{value:"Installing",id:"installing",level:2},{value:"Usage",id:"usage",level:2},{value:"Theming",id:"theming",level:2},{value:"Theming components",id:"theming-components",level:3},{value:"Styling via props",id:"styling-via-props",level:4},{value:"Theming complex multipart components",id:"theming-complex-multipart-components",level:4},{value:"i18n",id:"i18n",level:3},{value:"LICENSE",id:"license",level:2}],p={toc:c};function m(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,o.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"ui-components-with-chakra-ui"},"UI Components with Chakra UI"),(0,a.kt)("p",null,"Chakra ui components for easily integrating Vocdoni services."),(0,a.kt)("h2",{id:"installing"},"Installing"),(0,a.kt)("p",null,"You'll first need to have a project with chakra installed and configured. Follow\ntheir ",(0,a.kt)("a",{parentName:"p",href:"https://chakra-ui.com/getting-started"},"official documentation")," in order to do so."),(0,a.kt)("p",null,"After that, you can add the required vocdoni components dependencies:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"yarn add @vocdoni/sdk @vocdoni/chakra-components react-markdown remark-gfm\n")),(0,a.kt)("h2",{id:"usage"},"Usage"),(0,a.kt)("p",null,"The very first step is to add the ",(0,a.kt)("inlineCode",{parentName:"p"},"")," as a wrapper of your\napplication or, at least, of your election:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"import { ClientProvider } from '@vocdoni/chakra-components'\n\nconst App = () => {\n const signer = /* any ethers based signer */\n return (\n \n {/* your actual app code */}\n \n )\n}\n")),(0,a.kt)("p",null,"Note ",(0,a.kt)("inlineCode",{parentName:"p"},"env")," can be any of the ",(0,a.kt)("a",{parentName:"p",href:"/sdk/integration-details#environment"},"SDK available environments"),",\neither in string format, or using the SDK ",(0,a.kt)("inlineCode",{parentName:"p"},"EnvOptions")," enum."),(0,a.kt)("p",null,"After that, the easiest way to integrate a voting would be to just import the\n",(0,a.kt)("inlineCode",{parentName:"p"},"Election")," component and specify it an id for your election:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"import { Election } from '@vocdoni/chakra-components'\n\nconst CustomVoteComponent = () => {\n return \n}\n")),(0,a.kt)("p",null,"This will automatically instance the Election Provider with all the available\nvoting components. You can style it following the ",(0,a.kt)("a",{parentName:"p",href:"#theming"},"instructions below"),",\nand/or you can also create your own vote view, based on the components used by\nthe ",(0,a.kt)("inlineCode",{parentName:"p"},"Election")," component, and style it directly with props:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"import {\n ElectionProvider,\n ElectionTitle,\n ElectionSchedule,\n ElectionStatusBadge,\n ElectionDescription,\n HR,\n ElectionQuestions,\n} from '@vocdoni/chakra-components'\n\nconst CustomVoteComponent = () => {\n return (\n \n \n \n \n \n \n
\n \n \n )\n}\n")),(0,a.kt)("p",null,"Take a look at section below on more examples of how to style the voting\ncomponents."),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"Note you won't see some required styles if you have not added the\nChakraProvider to your project, see below for more details on this.")),(0,a.kt)("h2",{id:"theming"},"Theming"),(0,a.kt)("p",null,"Since these components use chakra's theming system, the way to style these\nvoting components is\n",(0,a.kt)("a",{parentName:"p",href:"https://chakra-ui.com/docs/styled-system/customize-theme#customizing-component-styles"},"the same as described in their documentation"),", but using the\ncustom components we defined (see ",(0,a.kt)("a",{parentName:"p",href:"#theming-components"},"theming components")," for more details)."),(0,a.kt)("p",null,"In order to start styling the voting components, you should use the\n",(0,a.kt)("inlineCode",{parentName:"p"},"ChakraProvider"),", and customize the passed theme:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"// this can be imported from '@chakra-ui/react' too, but that's more generic\nimport { extendTheme } from '@chakra-ui/system'\nimport { theme } from '@vocdoni/chakra-components'\n\nexport const App = () => (\n \n {/* YOUR APP CONTENTS */}\n \n)\n")),(0,a.kt)("p",null,"As you can see, we're importing a custom defined theme from\n",(0,a.kt)("inlineCode",{parentName:"p"},"@vocdoni/chakra-components"),", but at the same time, we're using ",(0,a.kt)("inlineCode",{parentName:"p"},"extendTheme"),".\nThis is because we're not merging our styles with the base chakra theme, both to\navoid a bigger bundle size and to ensure we don't unexpectedly overwrite styles."),(0,a.kt)("p",null,"The above example is the easiest way to get all the default styles up and\nrunning, but you can always define your entire theme and ignore our base styles.\nSee how our components are grainly styled below, in ","[components structure]","."),(0,a.kt)("p",null,"In case you want to add the voting components to a page and ensure chakra-ui\nwill not affect your theme, you may need to pass ",(0,a.kt)("inlineCode",{parentName:"p"},"resetCSS={false}")," as a\ncomponent prop:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"import { extendTheme } from '@chakra-ui/system'\nimport { theme } from '@vocdoni/chakra-components'\n\nexport const App = () => (\n \n {/* YOUR APP CONTENTS */}\n \n)\n")),(0,a.kt)("p",null,"If you want to extend or change the theme, you can pass your changes as a second\nargument to ",(0,a.kt)("inlineCode",{parentName:"p"},"extendTheme"),":"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"import { extendTheme } from '@chakra-ui/react'\nimport { theme as vtheme } from '@vocdoni/chakra-components'\n\nconst theme = extendTheme(vtheme, {\n // any theme changes would go here\n components: {\n // [...]\n },\n})\n\nexport const App = () => (\n \n {/* YOUR APP CONTENTS */}\n \n)\n")),(0,a.kt)("p",null,"We have applied a few amount of styles, so you can perfectly ignore our styles\nand write them from the ground up."),(0,a.kt)("h3",{id:"theming-components"},"Theming components"),(0,a.kt)("p",null,"Since you have components for every part of an election process, you can follow\nthe official Chakra documentation on how to customize component styles, and just\nuse our components where required."),(0,a.kt)("p",null,"Here's a small example styling the title and image of elections:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { extendTheme, ComponentSingleStyleConfig } from '@chakra-ui/react'\nimport { theme as vtheme } from '@vocdoni/chakra-components'\n\nconst ElectionTitle : ComponentsStyleConfig = {\n baseStyle: {\n paddingTop: '.5em',\n position: 'relative',\n marginTop: '-2.5em',\n background: 'linear-gradient(180deg, rgba(0,0,0,0.50) 0%, rgba(255,255,255,0) 100%)',\n }\n}\n\nconst ElectionHeader : ComponentsStyleConfig = {\n baseStyle: {\n minHeight: '3em'\n }\n}\n\nconst theme = extendTheme(vtheme, {\n components: {\n ElectionTitle,\n ElectionHeader,\n },\n})\n\n// this theme would then be used directly in your ChakraProvider instance\nexport default theme\n")),(0,a.kt)("h4",{id:"styling-via-props"},"Styling via props"),(0,a.kt)("p",null,"All components have all the features you would expect from a chakra component,\nmeaning you can style all components via component props too:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"import { ElectionTitle, ElectionHeader } from '@vocdoni/chakra-components'\n\nconst App = () => (\n \n \n \n \n)\n")),(0,a.kt)("h4",{id:"theming-complex-multipart-components"},"Theming complex multipart components"),(0,a.kt)("p",null,"Some components, like ",(0,a.kt)("inlineCode",{parentName:"p"},"")," follow a multipart component\nstructure. Please refer to the\n",(0,a.kt)("a",{parentName:"p",href:"https://chakra-ui.com/docs/styled-system/component-style#styling-multipart-components"},"official chakra documentation")," for more info on how to\nstyle these type of components."),(0,a.kt)("p",null,"Here's a small example styling the ",(0,a.kt)("inlineCode",{parentName:"p"},"ElectionQuestions")," component:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { extendTheme, createMultiStyleConfigHelpers } from '@chakra-ui/react'\nimport { theme as vtheme, questionsAnatomy } from '@vocdoni/chakra-components'\n\nconst { defineMultiStyleConfig, definePartsStyle } = createMultiStyleConfigHelpers(questionsAnatomy)\n\nconst ElectionQuestions = defineMultiStyleConfig({\n baseStyle: definePartsStyle({\n title: {\n color: 'lightblue',\n },\n description: {\n color: 'lightgreen',\n }\n }),\n})\n\nconst theme = extendTheme(vtheme, {\n components: {\n ElectionQuestions,\n },\n})\n\n// this theme would then be used directly in your ChakraProvider instance\nexport default theme\n")),(0,a.kt)("p",null,"You can check out each component's anatomy by checking\n",(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/ui-components/tree/7e2f161be654b287ebc82d553c316164e20c8fd3/templates/chakra/src/theme"},"their theme files"),"."),(0,a.kt)("h3",{id:"i18n"},"i18n"),(0,a.kt)("p",null,"In order to change any of the texts contained in ",(0,a.kt)("inlineCode",{parentName:"p"},"@vocdoni/chakra-components"),",\nyou must specify the translations for each language in the ClientProvider:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"const translationsObject = {\n en: {\n // all english translations\n },\n ca: {\n // catalan translations\n }\n}\n\n")),(0,a.kt)("p",null,"Check out the ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/ui-components/blob/7e2f161be654b287ebc82d553c316164e20c8fd3/packages/react-providers/src/i18n/localize.tsx"},"translations file")," in order to see all the available keys."),(0,a.kt)("h2",{id:"license"},"LICENSE"),(0,a.kt)("p",null,"This components library is licensed under the ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/ui-components/blob/main/LICENSE"},"GNU Affero General Public License\nv3.0"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"Vocdoni UI React Components\nCopyright (C) 2023 Vocdoni Roots MCU\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program. If not, see .\n")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ea27d690.dab8903c.js b/assets/js/ea27d690.dab8903c.js deleted file mode 100644 index dbfe7c27f..000000000 --- a/assets/js/ea27d690.dab8903c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4108],{3905:(e,t,n)=>{n.d(t,{Zo:()=>k,kt:()=>c});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),o=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},k=function(e){var t=o(e.components);return a.createElement(p.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},s=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,k=d(e,["components","mdxType","originalType","parentName"]),s=o(n),c=r,f=s["".concat(p,".").concat(c)]||s[c]||m[c]||i;return n?a.createElement(f,l(l({ref:t},k),{},{components:n})):a.createElement(f,l({ref:t},k))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=s;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,d={unversionedId:"sdk/reference/interfaces/IChainBlockInfoResponse",id:"sdk/reference/interfaces/IChainBlockInfoResponse",title:"IChainBlockInfoResponse",description:"@vocdoni/sdk / Exports / IChainBlockInfoResponse",source:"@site/docs/sdk/reference/interfaces/IChainBlockInfoResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainBlockInfoResponse",permalink:"/sdk/reference/interfaces/IChainBlockInfoResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensusPublishResponse",permalink:"/sdk/reference/interfaces/ICensusPublishResponse"},next:{title:"IChainGetCircuitResponse",permalink:"/sdk/reference/interfaces/IChainGetCircuitResponse"}},p={},o=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"evidence",id:"evidence",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"hash",id:"hash",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"header",id:"header",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"lastCommit",id:"lastcommit",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-4",level:4}],k={toc:o};function m(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IChainBlockInfoResponse"),(0,r.kt)("h1",{id:"interface-ichainblockinforesponse"},"Interface: IChainBlockInfoResponse"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainBlockInfoResponse#data"},"data")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainBlockInfoResponse#evidence"},"evidence")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainBlockInfoResponse#hash"},"hash")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainBlockInfoResponse#header"},"header")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IChainBlockInfoResponse#lastcommit"},"lastCommit"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"data"},"data"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"txs")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L272"},"api/chain.ts:272")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"evidence"},"evidence"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"evidence"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"evidence")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")))),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L275"},"api/chain.ts:275")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hash"},"hash"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"hash"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L278"},"api/chain.ts:278")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"header"},"header"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"header"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"appHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"consensusHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dataHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"evidenceHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"height")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lastBlockId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"BlockID"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lastCommitHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lastResultsHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nextValidatorsHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"proposerAddress")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"time")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"validatorsHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"version")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{"," ",(0,r.kt)("inlineCode",{parentName:"td"},"app"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"block"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"number")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"version.app")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"version.block")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L279"},"api/chain.ts:279")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"lastcommit"},"lastCommit"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"lastCommit"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"BlockID"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"height")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"round")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signatures")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{"," ",(0,r.kt)("inlineCode",{parentName:"td"},"blockIdFlag"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"signature"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"timestamp"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"validatorAddress"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }[]")))),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain.ts#L298"},"api/chain.ts:298")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ea27d690.dd8c6fdc.js b/assets/js/ea27d690.dd8c6fdc.js new file mode 100644 index 000000000..9b830f2d8 --- /dev/null +++ b/assets/js/ea27d690.dd8c6fdc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4108],{3905:(e,t,n)=>{n.d(t,{Zo:()=>k,kt:()=>c});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),o=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},k=function(e){var t=o(e.components);return a.createElement(p.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},s=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,k=d(e,["components","mdxType","originalType","parentName"]),s=o(n),c=r,N=s["".concat(p,".").concat(c)]||s[c]||m[c]||i;return n?a.createElement(N,l(l({ref:t},k),{},{components:n})):a.createElement(N,l({ref:t},k))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=s;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var a=n(87462),r=(n(67294),n(3905));const i={},l=void 0,d={unversionedId:"sdk/reference/interfaces/IChainBlockInfoResponse",id:"sdk/reference/interfaces/IChainBlockInfoResponse",title:"IChainBlockInfoResponse",description:"@vocdoni/sdk / Exports / IChainBlockInfoResponse",source:"@site/docs/sdk/reference/interfaces/IChainBlockInfoResponse.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IChainBlockInfoResponse",permalink:"/sdk/reference/interfaces/IChainBlockInfoResponse",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensusPublishResponse",permalink:"/sdk/reference/interfaces/ICensusPublishResponse"},next:{title:"IChainGetCircuitResponse",permalink:"/sdk/reference/interfaces/IChainGetCircuitResponse"}},p={},o=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"evidence",id:"evidence",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"hash",id:"hash",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"header",id:"header",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"lastCommit",id:"lastcommit",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-4",level:4}],k={toc:o};function m(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IChainBlockInfoResponse"),(0,r.kt)("h1",{id:"interface-ichainblockinforesponse"},"Interface: IChainBlockInfoResponse"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IChainBlockInfoResponse#data"},"data")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IChainBlockInfoResponse#evidence"},"evidence")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IChainBlockInfoResponse#hash"},"hash")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IChainBlockInfoResponse#header"},"header")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IChainBlockInfoResponse#lastcommit"},"lastCommit"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"data"},"data"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"txs")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L272"},"api/chain.ts:272")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"evidence"},"evidence"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"evidence"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"evidence")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")))),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L275"},"api/chain.ts:275")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hash"},"hash"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"hash"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L278"},"api/chain.ts:278")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"header"},"header"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"header"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"appHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chainId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"consensusHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dataHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"evidenceHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"height")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lastBlockId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"BlockID"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lastCommitHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lastResultsHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nextValidatorsHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"proposerAddress")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"time")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"validatorsHash")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"version")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{"," ",(0,r.kt)("inlineCode",{parentName:"td"},"app"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"block"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"number")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"version.app")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"version.block")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L279"},"api/chain.ts:279")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"lastcommit"},"lastCommit"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"lastCommit"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"BlockID"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"height")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"round")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"signatures")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{"," ",(0,r.kt)("inlineCode",{parentName:"td"},"blockIdFlag"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"signature"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"timestamp"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"validatorAddress"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }[]")))),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain.ts#L298"},"api/chain.ts:298")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ea74a8a9.8cc467a4.js b/assets/js/ea74a8a9.2f2a0652.js similarity index 62% rename from assets/js/ea74a8a9.8cc467a4.js rename to assets/js/ea74a8a9.2f2a0652.js index 9d586ca74..e5a6430d3 100644 --- a/assets/js/ea74a8a9.8cc467a4.js +++ b/assets/js/ea74a8a9.2f2a0652.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2832],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function s(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),c=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},l=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,s=e.originalType,p=e.parentName,l=o(e,["components","mdxType","originalType","parentName"]),d=c(r),f=a,g=d["".concat(p,".").concat(f)]||d[f]||u[f]||s;return r?n.createElement(g,i(i({ref:t},l),{},{components:r})):n.createElement(g,i({ref:t},l))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var s=r.length,i=new Array(s);i[0]=d;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:a,i[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>u,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var n=r(87462),a=(r(67294),r(3905));const s={},i=void 0,o={unversionedId:"sdk/reference/interfaces/ICensus3StrategiesOperator",id:"sdk/reference/interfaces/ICensus3StrategiesOperator",title:"ICensus3StrategiesOperator",description:"@vocdoni/sdk / Exports / ICensus3StrategiesOperator",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategiesOperator.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategiesOperator",permalink:"/sdk/reference/interfaces/ICensus3StrategiesOperator",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategiesListResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated"},next:{title:"ICensus3StrategiesOperatorsResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"tag",id:"tag",level:3},{value:"Defined in",id:"defined-in-1",level:4}],l={toc:c};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ICensus3StrategiesOperator"),(0,a.kt)("h1",{id:"interface-icensus3strategiesoperator"},"Interface: ICensus3StrategiesOperator"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategiesOperator#description"},"description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/ICensus3StrategiesOperator#tag"},"tag"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The description of the operator"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L223"},"api/census3/strategy.ts:223")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"tag"},"tag"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"tag"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The tag of the operator"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/strategy.ts#L228"},"api/census3/strategy.ts:228")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2832],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),c=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},l=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,l=o(e,["components","mdxType","originalType","parentName"]),d=c(r),f=a,g=d["".concat(p,".").concat(f)]||d[f]||u[f]||i;return r?n.createElement(g,s(s({ref:t},l),{},{components:r})):n.createElement(g,s({ref:t},l))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,s=new Array(i);s[0]=d;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:a,s[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var n=r(87462),a=(r(67294),r(3905));const i={},s=void 0,o={unversionedId:"sdk/reference/interfaces/ICensus3StrategiesOperator",id:"sdk/reference/interfaces/ICensus3StrategiesOperator",title:"ICensus3StrategiesOperator",description:"@vocdoni/sdk / Exports / ICensus3StrategiesOperator",source:"@site/docs/sdk/reference/interfaces/ICensus3StrategiesOperator.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/ICensus3StrategiesOperator",permalink:"/sdk/reference/interfaces/ICensus3StrategiesOperator",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ICensus3StrategiesListResponsePaginated",permalink:"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated"},next:{title:"ICensus3StrategiesOperatorsResponse",permalink:"/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"tag",id:"tag",level:3},{value:"Defined in",id:"defined-in-1",level:4}],l={toc:c};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ICensus3StrategiesOperator"),(0,a.kt)("h1",{id:"interface-icensus3strategiesoperator"},"Interface: ICensus3StrategiesOperator"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3StrategiesOperator#description"},"description")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ICensus3StrategiesOperator#tag"},"tag"))),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The description of the operator"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L223"},"api/census3/strategy.ts:223")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"tag"},"tag"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"tag"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The tag of the operator"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/strategy.ts#L228"},"api/census3/strategy.ts:228")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ec0516f7.6f770ac4.js b/assets/js/ec0516f7.6f770ac4.js deleted file mode 100644 index 0c75fb6a1..000000000 --- a/assets/js/ec0516f7.6f770ac4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2050],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>k});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var i=r.createContext({}),p=function(e){var t=r.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(i.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,i=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),u=p(n),k=a,m=u["".concat(i,".").concat(k)]||u[k]||d[k]||o;return n?r.createElement(m,l(l({ref:t},c),{},{components:n})):r.createElement(m,l({ref:t},c))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,l=new Array(o);l[0]=u;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s.mdxType="string"==typeof e?e:a,l[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const o={},l=void 0,s={unversionedId:"sdk/reference/classes/Vote",id:"sdk/reference/classes/Vote",title:"Vote",description:"@vocdoni/sdk / Exports / Vote",source:"@site/docs/sdk/reference/classes/Vote.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Vote",permalink:"/sdk/reference/classes/Vote",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"VocdoniSDKClient",permalink:"/sdk/reference/classes/VocdoniSDKClient"},next:{title:"VoteAPI",permalink:"/sdk/reference/classes/VoteAPI"}},i={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_votes",id:"_votes",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"votes",id:"votes",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:p};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / Vote"),(0,a.kt)("h1",{id:"class-vote"},"Class: Vote"),(0,a.kt)("p",null,"Represents a vote"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Vote"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/AnonymousVote"},(0,a.kt)("inlineCode",{parentName:"a"},"AnonymousVote"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/CspVote"},(0,a.kt)("inlineCode",{parentName:"a"},"CspVote"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Vote#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Vote#_votes"},"_","votes"))),(0,a.kt)("h3",{id:"accessors"},"Accessors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Vote#votes"},"votes"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new Vote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"votes"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote"))),(0,a.kt)("p",null,"Constructs a vote"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"votes")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(",(0,a.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"bigint"),")[]"),(0,a.kt)("td",{parentName:"tr",align:"left"},"The list of votes values")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote"))),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/vote.ts#L12"},"types/vote/vote.ts:12")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"_votes"},"_","votes"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","votes"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint"),")[]"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/vote.ts#L5"},"types/vote/vote.ts:5")),(0,a.kt)("h2",{id:"accessors-1"},"Accessors"),(0,a.kt)("h3",{id:"votes"},"votes"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"votes"),"(): (",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint"),")[]"),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,"(",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint"),")[]"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/vote.ts#L16"},"types/vote/vote.ts:16")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"votes"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(",(0,a.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"bigint"),")[]")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/vote/vote.ts#L20"},"types/vote/vote.ts:20")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ec0516f7.d4158d9c.js b/assets/js/ec0516f7.d4158d9c.js new file mode 100644 index 000000000..fe269f29c --- /dev/null +++ b/assets/js/ec0516f7.d4158d9c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2050],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=p(n),k=a,m=u["".concat(s,".").concat(k)]||u[k]||c[k]||o;return n?r.createElement(m,i(i({ref:t},d),{},{components:n})):r.createElement(m,i({ref:t},d))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:a,i[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>c,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var r=n(87462),a=(n(67294),n(3905));const o={},i=void 0,l={unversionedId:"sdk/reference/classes/Vote",id:"sdk/reference/classes/Vote",title:"Vote",description:"@vocdoni/sdk / Exports / Vote",source:"@site/docs/sdk/reference/classes/Vote.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Vote",permalink:"/sdk/reference/classes/Vote",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"VocdoniSDKClient",permalink:"/sdk/reference/classes/VocdoniSDKClient"},next:{title:"VoteAPI",permalink:"/sdk/reference/classes/VoteAPI"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_votes",id:"_votes",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"votes",id:"votes",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:p};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / Vote"),(0,a.kt)("h1",{id:"class-vote"},"Class: Vote"),(0,a.kt)("p",null,"Represents a vote"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Vote"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"AnonymousVote"},(0,a.kt)("inlineCode",{parentName:"a"},"AnonymousVote"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"CspVote"},(0,a.kt)("inlineCode",{parentName:"a"},"CspVote"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Vote#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Vote#_votes"},"_","votes"))),(0,a.kt)("h3",{id:"accessors"},"Accessors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"Vote#votes"},"votes"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new Vote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"votes"),"): ",(0,a.kt)("a",{parentName:"p",href:"Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote"))),(0,a.kt)("p",null,"Constructs a vote"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"votes")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(",(0,a.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"bigint"),")[]"),(0,a.kt)("td",{parentName:"tr",align:"left"},"The list of votes values")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"Vote"},(0,a.kt)("inlineCode",{parentName:"a"},"Vote"))),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/vote.ts#L12"},"types/vote/vote.ts:12")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"_votes"},"_","votes"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"_","votes"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint"),")[]"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/vote.ts#L5"},"types/vote/vote.ts:5")),(0,a.kt)("h2",{id:"accessors-1"},"Accessors"),(0,a.kt)("h3",{id:"votes"},"votes"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"votes"),"(): (",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint"),")[]"),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,"(",(0,a.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"bigint"),")[]"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/vote.ts#L16"},"types/vote/vote.ts:16")),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"set")," ",(0,a.kt)("strong",{parentName:"p"},"votes"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"value"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"value")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(",(0,a.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"bigint"),")[]")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/vote/vote.ts#L20"},"types/vote/vote.ts:20")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ee2798c9.0492ad87.js b/assets/js/ee2798c9.0492ad87.js new file mode 100644 index 000000000..8c3ff146c --- /dev/null +++ b/assets/js/ee2798c9.0492ad87.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4635],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=p(n),f=i,m=u["".concat(s,".").concat(f)]||u[f]||c[f]||o;return n?r.createElement(m,a(a({ref:t},d),{},{components:n})):r.createElement(m,a({ref:t},d))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,a=new Array(o);a[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:i,a[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>c,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var r=n(87462),i=(n(67294),n(3905));const o={},a=void 0,l={unversionedId:"sdk/reference/enums/VoteSteps",id:"sdk/reference/enums/VoteSteps",title:"VoteSteps",description:"@vocdoni/sdk / Exports / VoteSteps",source:"@site/docs/sdk/reference/enums/VoteSteps.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/VoteSteps",permalink:"/sdk/reference/enums/VoteSteps",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"TxType",permalink:"/sdk/reference/enums/TxType"},next:{title:"AccountMetadata",permalink:"/sdk/reference/interfaces/AccountMetadata"}},s={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"CALC_ZK_PROOF",id:"calc_zk_proof",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"DONE",id:"done",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"GENERATE_TX",id:"generate_tx",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"GET_ELECTION",id:"get_election",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"GET_PROOF",id:"get_proof",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"GET_SIGNATURE",id:"get_signature",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"SIGN_TX",id:"sign_tx",level:3},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:p};function c(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / VoteSteps"),(0,i.kt)("h1",{id:"enumeration-votesteps"},"Enumeration: VoteSteps"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/VoteSteps#calc_zk_proof"},"CALC","_","ZK","_","PROOF")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"VoteSteps#done"},"DONE")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/VoteSteps#generate_tx"},"GENERATE","_","TX")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/VoteSteps#get_election"},"GET","_","ELECTION")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/VoteSteps#get_proof"},"GET","_","PROOF")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/VoteSteps#get_signature"},"GET","_","SIGNATURE")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/VoteSteps#sign_tx"},"SIGN","_","TX"))),(0,i.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,i.kt)("h3",{id:"calc_zk_proof"},"CALC","_","ZK","_","PROOF"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"CALC","_","ZK","_","PROOF")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"calc-zk-proof"')),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/vote.ts#L22"},"services/vote.ts:22")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"done"},"DONE"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"DONE")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"done"')),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/vote.ts#L25"},"services/vote.ts:25")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generate_tx"},"GENERATE","_","TX"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"GENERATE","_","TX")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"generate-tx"')),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/vote.ts#L23"},"services/vote.ts:23")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"get_election"},"GET","_","ELECTION"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"GET","_","ELECTION")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"get-election"')),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/vote.ts#L19"},"services/vote.ts:19")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"get_proof"},"GET","_","PROOF"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"GET","_","PROOF")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"get-proof"')),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/vote.ts#L20"},"services/vote.ts:20")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"get_signature"},"GET","_","SIGNATURE"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"GET","_","SIGNATURE")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"get-signature"')),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/vote.ts#L21"},"services/vote.ts:21")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sign_tx"},"SIGN","_","TX"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SIGN","_","TX")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"sign-tx"')),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/vote.ts#L24"},"services/vote.ts:24")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ee2798c9.2aaa9db6.js b/assets/js/ee2798c9.2aaa9db6.js deleted file mode 100644 index f6d70c55c..000000000 --- a/assets/js/ee2798c9.2aaa9db6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4635],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),u=p(n),f=i,m=u["".concat(s,".").concat(f)]||u[f]||d[f]||o;return n?r.createElement(m,a(a({ref:t},c),{},{components:n})):r.createElement(m,a({ref:t},c))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,a=new Array(o);a[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:i,a[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var r=n(87462),i=(n(67294),n(3905));const o={},a=void 0,l={unversionedId:"sdk/reference/enums/VoteSteps",id:"sdk/reference/enums/VoteSteps",title:"VoteSteps",description:"@vocdoni/sdk / Exports / VoteSteps",source:"@site/docs/sdk/reference/enums/VoteSteps.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/VoteSteps",permalink:"/sdk/reference/enums/VoteSteps",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"TxType",permalink:"/sdk/reference/enums/TxType"},next:{title:"AccountMetadata",permalink:"/sdk/reference/interfaces/AccountMetadata"}},s={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"CALC_ZK_PROOF",id:"calc_zk_proof",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"DONE",id:"done",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"GENERATE_TX",id:"generate_tx",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"GET_ELECTION",id:"get_election",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"GET_PROOF",id:"get_proof",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"GET_SIGNATURE",id:"get_signature",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"SIGN_TX",id:"sign_tx",level:3},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:p};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / VoteSteps"),(0,i.kt)("h1",{id:"enumeration-votesteps"},"Enumeration: VoteSteps"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/VoteSteps#calc_zk_proof"},"CALC","_","ZK","_","PROOF")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/VoteSteps#done"},"DONE")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/VoteSteps#generate_tx"},"GENERATE","_","TX")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/VoteSteps#get_election"},"GET","_","ELECTION")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/VoteSteps#get_proof"},"GET","_","PROOF")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/VoteSteps#get_signature"},"GET","_","SIGNATURE")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/enums/VoteSteps#sign_tx"},"SIGN","_","TX"))),(0,i.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,i.kt)("h3",{id:"calc_zk_proof"},"CALC","_","ZK","_","PROOF"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"CALC","_","ZK","_","PROOF")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"calc-zk-proof"')),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/vote.ts#L22"},"services/vote.ts:22")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"done"},"DONE"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"DONE")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"done"')),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/vote.ts#L25"},"services/vote.ts:25")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generate_tx"},"GENERATE","_","TX"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"GENERATE","_","TX")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"generate-tx"')),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/vote.ts#L23"},"services/vote.ts:23")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"get_election"},"GET","_","ELECTION"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"GET","_","ELECTION")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"get-election"')),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/vote.ts#L19"},"services/vote.ts:19")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"get_proof"},"GET","_","PROOF"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"GET","_","PROOF")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"get-proof"')),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/vote.ts#L20"},"services/vote.ts:20")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"get_signature"},"GET","_","SIGNATURE"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"GET","_","SIGNATURE")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"get-signature"')),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/vote.ts#L21"},"services/vote.ts:21")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sign_tx"},"SIGN","_","TX"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"SIGN","_","TX")," = ",(0,i.kt)("inlineCode",{parentName:"p"},'"sign-tx"')),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/vote.ts#L24"},"services/vote.ts:24")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/effdce5d.763f4786.js b/assets/js/effdce5d.763f4786.js new file mode 100644 index 000000000..39249416a --- /dev/null +++ b/assets/js/effdce5d.763f4786.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6483],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>k});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),d=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=d(e.components);return r.createElement(s.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,s=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),u=d(n),k=i,v=u["".concat(s,".").concat(k)]||u[k]||p[k]||a;return n?r.createElement(v,l(l({ref:t},c),{},{components:n})):r.createElement(v,l({ref:t},c))}));function k(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var d=2;d{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/classes/InvalidElection",id:"sdk/reference/classes/InvalidElection",title:"InvalidElection",description:"@vocdoni/sdk / Exports / InvalidElection",source:"@site/docs/sdk/reference/classes/InvalidElection.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/InvalidElection",permalink:"/sdk/reference/classes/InvalidElection",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"FileService",permalink:"/sdk/reference/classes/FileService"},next:{title:"MultiChoiceElection",permalink:"/sdk/reference/classes/MultiChoiceElection"}},s={},d=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_id",id:"_id",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"id",id:"id",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isValid",id:"isvalid",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:d};function p(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / InvalidElection"),(0,i.kt)("h1",{id:"class-invalidelection"},"Class: InvalidElection"),(0,i.kt)("p",null,"Represents an invalid election"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"constructors"},"Constructors"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"InvalidElection#constructor"},"constructor"))),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/InvalidElection#_id"},"_","id"))),(0,i.kt)("h3",{id:"accessors"},"Accessors"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"InvalidElection#id"},"id")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"InvalidElection#isvalid"},"isValid"))),(0,i.kt)("h2",{id:"constructors-1"},"Constructors"),(0,i.kt)("h3",{id:"constructor"},"constructor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"new InvalidElection"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,i.kt)("a",{parentName:"p",href:"InvalidElection"},(0,i.kt)("inlineCode",{parentName:"a"},"InvalidElection"))),(0,i.kt)("p",null,"Constructs an invalid election"),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"params")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"../interfaces/IInvalidElectionParameters"},(0,i.kt)("inlineCode",{parentName:"a"},"IInvalidElectionParameters"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"Election parameters")))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"InvalidElection"},(0,i.kt)("inlineCode",{parentName:"a"},"InvalidElection"))),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/invalid.ts#L16"},"types/election/invalid.ts:16")),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"_id"},"_","id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"_","id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/invalid.ts#L9"},"types/election/invalid.ts:9")),(0,i.kt)("h2",{id:"accessors-1"},"Accessors"),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"id"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/invalid.ts#L20"},"types/election/invalid.ts:20")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"isvalid"},"isValid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"isValid"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/invalid.ts#L24"},"types/election/invalid.ts:24")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/effdce5d.870bea03.js b/assets/js/effdce5d.870bea03.js deleted file mode 100644 index c7400275c..000000000 --- a/assets/js/effdce5d.870bea03.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6483],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=r.createContext({}),c=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=c(n),k=i,v=u["".concat(o,".").concat(k)]||u[k]||p[k]||a;return n?r.createElement(v,l(l({ref:t},d),{},{components:n})):r.createElement(v,l({ref:t},d))}));function k(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=u;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s.mdxType="string"==typeof e?e:i,l[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,s={unversionedId:"sdk/reference/classes/InvalidElection",id:"sdk/reference/classes/InvalidElection",title:"InvalidElection",description:"@vocdoni/sdk / Exports / InvalidElection",source:"@site/docs/sdk/reference/classes/InvalidElection.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/InvalidElection",permalink:"/sdk/reference/classes/InvalidElection",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"FileService",permalink:"/sdk/reference/classes/FileService"},next:{title:"MultiChoiceElection",permalink:"/sdk/reference/classes/MultiChoiceElection"}},o={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Accessors",id:"accessors",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"_id",id:"_id",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Accessors",id:"accessors-1",level:2},{value:"id",id:"id",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isValid",id:"isvalid",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:c};function p(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / InvalidElection"),(0,i.kt)("h1",{id:"class-invalidelection"},"Class: InvalidElection"),(0,i.kt)("p",null,"Represents an invalid election"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"constructors"},"Constructors"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/InvalidElection#constructor"},"constructor"))),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/InvalidElection#_id"},"_","id"))),(0,i.kt)("h3",{id:"accessors"},"Accessors"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/InvalidElection#id"},"id")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/classes/InvalidElection#isvalid"},"isValid"))),(0,i.kt)("h2",{id:"constructors-1"},"Constructors"),(0,i.kt)("h3",{id:"constructor"},"constructor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"new InvalidElection"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/InvalidElection"},(0,i.kt)("inlineCode",{parentName:"a"},"InvalidElection"))),(0,i.kt)("p",null,"Constructs an invalid election"),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"params")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/sdk/reference/interfaces/IInvalidElectionParameters"},(0,i.kt)("inlineCode",{parentName:"a"},"IInvalidElectionParameters"))),(0,i.kt)("td",{parentName:"tr",align:"left"},"Election parameters")))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/InvalidElection"},(0,i.kt)("inlineCode",{parentName:"a"},"InvalidElection"))),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/invalid.ts#L16"},"types/election/invalid.ts:16")),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"_id"},"_","id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"_","id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/invalid.ts#L9"},"types/election/invalid.ts:9")),(0,i.kt)("h2",{id:"accessors-1"},"Accessors"),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"id"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/invalid.ts#L20"},"types/election/invalid.ts:20")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"isvalid"},"isValid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"get")," ",(0,i.kt)("strong",{parentName:"p"},"isValid"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/invalid.ts#L24"},"types/election/invalid.ts:24")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f116289e.052a73b2.js b/assets/js/f116289e.052a73b2.js new file mode 100644 index 000000000..fcf1430a4 --- /dev/null +++ b/assets/js/f116289e.052a73b2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6349],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var i=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=i.createContext({}),s=function(e){var t=i.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=s(e.components);return i.createElement(d.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},c=i.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,d=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),c=s(n),m=r,f=c["".concat(d,".").concat(m)]||c[m]||u[m]||a;return n?i.createElement(f,l(l({ref:t},p),{},{components:n})):i.createElement(f,l({ref:t},p))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,l=new Array(a);l[0]=c;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:r,l[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>s});var i=n(87462),r=(n(67294),n(3905));const a={},l=void 0,o={unversionedId:"sdk/reference/interfaces/IBudgetElectionParametersWithBudget",id:"sdk/reference/interfaces/IBudgetElectionParametersWithBudget",title:"IBudgetElectionParametersWithBudget",description:"@vocdoni/sdk / Exports / IBudgetElectionParametersWithBudget",source:"@site/docs/sdk/reference/interfaces/IBudgetElectionParametersWithBudget.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IBudgetElectionParametersInfo",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},next:{title:"IBudgetElectionParametersWithCensusWeight",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight"}},d={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"census",id:"census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"endDate",id:"enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"forceFullBudget",id:"forcefullbudget",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"header",id:"header",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"maxBudget",id:"maxbudget",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"meta",id:"meta",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"minStep",id:"minstep",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"questions",id:"questions",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"startDate",id:"startdate",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"useCensusWeightAsBudget",id:"usecensusweightasbudget",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"voteType",id:"votetype",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-17",level:4}],p={toc:s};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,i.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IBudgetElectionParametersWithBudget"),(0,r.kt)("h1",{id:"interface-ibudgetelectionparameterswithbudget"},"Interface: IBudgetElectionParametersWithBudget"),(0,r.kt)("p",null,"Define election parameters."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo"},(0,r.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParametersInfo"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IBudgetElectionParametersWithBudget"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"properties"},"Properties"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#addsdkversion"},"addSDKVersion")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#census"},"census")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#description"},"description")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#electiontype"},"electionType")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#enddate"},"endDate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#forcefullbudget"},"forceFullBudget")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#header"},"header")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#maxbudget"},"maxBudget")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#maxcensussize"},"maxCensusSize")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#meta"},"meta")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#minstep"},"minStep")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#questions"},"questions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#startdate"},"startDate")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#streamuri"},"streamUri")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#temporarysecretidentity"},"temporarySecretIdentity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#title"},"title")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#usecensusweightasbudget"},"useCensusWeightAsBudget")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"IBudgetElectionParametersWithBudget#votetype"},"voteType"))),(0,r.kt)("h2",{id:"properties-1"},"Properties"),(0,r.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"addSDKVersion"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Used to add the SDK version to the election metadata"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#addsdkversion"},"addSDKVersion")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L155"},"types/election/election.ts:155")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"census"},"census"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"census"),": ",(0,r.kt)("a",{parentName:"p",href:"../classes/Census"},(0,r.kt)("inlineCode",{parentName:"a"},"Census"))),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#census"},"census")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L129"},"types/election/election.ts:129")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Election description"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#description"},"description")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L114"},"types/election/election.ts:114")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"electiontype"},"electionType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"electionType"),": ",(0,r.kt)("a",{parentName:"p",href:"IElectionType"},(0,r.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#electiontype"},"electionType")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L131"},"types/election/election.ts:131")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"enddate"},"endDate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"endDate"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#enddate"},"endDate")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L128"},"types/election/election.ts:128")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"forcefullbudget"},"forceFullBudget"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"forceFullBudget"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#forcefullbudget"},"forceFullBudget")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L9"},"types/election/budget.ts:9")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"header"},"header"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"header"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Election header image url."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#header"},"header")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L118"},"types/election/election.ts:118")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"maxbudget"},"maxBudget"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"maxBudget"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L18"},"types/election/budget.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Is used to limit the number of votes that can be registered for an election. This feature helps to prevent any\npotential overflow of the blockchain when the number of votes goes beyond the maximum limit."),(0,r.kt)("p",null,"In order to create an election, the creator is required to set the MaxCensusSize parameter to a proper value.\nTypically, this value should be equal to the size of the census. If the MaxCensusSize parameter is set to 0, an\nerror will occur and the election cannot be created."),(0,r.kt)("p",null,"If the number of votes exceeds this limit, will throw ",(0,r.kt)("inlineCode",{parentName:"p"},"Max census size for the election is greater than allowed\nsize")," error."),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#maxcensussize"},"maxCensusSize")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L145"},"types/election/election.ts:145")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Metadata (anything added by the election creator)"),(0,r.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#meta"},"meta")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L126"},"types/election/election.ts:126")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"minstep"},"minStep"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"minStep"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#minstep"},"minStep")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L8"},"types/election/budget.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"questions"},"questions"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"questions"),": ",(0,r.kt)("a",{parentName:"p",href:"IQuestion"},(0,r.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,r.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#questions"},"questions")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L132"},"types/election/election.ts:132")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"startdate"},"startDate"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"startDate"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#startdate"},"startDate")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L127"},"types/election/election.ts:127")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"streamuri"},"streamUri"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"streamUri"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Election stream Uri (ex: a video url)"),(0,r.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#streamuri"},"streamUri")),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L122"},"types/election/election.ts:122")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Is used to remove the secret identities of the voters once the process is done."),(0,r.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#temporarysecretidentity"},"temporarySecretIdentity")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L150"},"types/election/election.ts:150")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"title"},"title"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"title"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Election title"),(0,r.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#title"},"title")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L110"},"types/election/election.ts:110")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usecensusweightasbudget"},"useCensusWeightAsBudget"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"useCensusWeightAsBudget"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"false")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/budget.ts#L17"},"types/election/budget.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"votetype"},"voteType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"voteType"),": ",(0,r.kt)("a",{parentName:"p",href:"IVoteType"},(0,r.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,r.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,r.kt)("a",{parentName:"p",href:"IBudgetElectionParametersInfo#votetype"},"voteType")),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L130"},"types/election/election.ts:130")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f116289e.957cba4a.js b/assets/js/f116289e.957cba4a.js deleted file mode 100644 index 7789a8d56..000000000 --- a/assets/js/f116289e.957cba4a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[6349],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>u});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=r.createContext({}),s=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=s(e.components);return r.createElement(o.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,o=e.parentName,c=d(e,["components","mdxType","originalType","parentName"]),f=s(n),u=i,m=f["".concat(o,".").concat(u)]||f[u]||p[u]||a;return n?r.createElement(m,l(l({ref:t},c),{},{components:n})):r.createElement(m,l({ref:t},c))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=f;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d.mdxType="string"==typeof e?e:i,l[1]=d;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>p,frontMatter:()=>a,metadata:()=>d,toc:()=>s});var r=n(87462),i=(n(67294),n(3905));const a={},l=void 0,d={unversionedId:"sdk/reference/interfaces/IBudgetElectionParametersWithBudget",id:"sdk/reference/interfaces/IBudgetElectionParametersWithBudget",title:"IBudgetElectionParametersWithBudget",description:"@vocdoni/sdk / Exports / IBudgetElectionParametersWithBudget",source:"@site/docs/sdk/reference/interfaces/IBudgetElectionParametersWithBudget.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IBudgetElectionParametersInfo",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},next:{title:"IBudgetElectionParametersWithCensusWeight",permalink:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight"}},o={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"addSDKVersion",id:"addsdkversion",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"census",id:"census",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"electionType",id:"electiontype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"endDate",id:"enddate",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"forceFullBudget",id:"forcefullbudget",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"header",id:"header",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"maxBudget",id:"maxbudget",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"maxCensusSize",id:"maxcensussize",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"meta",id:"meta",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"minStep",id:"minstep",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"questions",id:"questions",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"startDate",id:"startdate",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"streamUri",id:"streamuri",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"temporarySecretIdentity",id:"temporarysecretidentity",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"useCensusWeightAsBudget",id:"usecensusweightasbudget",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"voteType",id:"votetype",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-17",level:4}],c={toc:s};function p(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IBudgetElectionParametersWithBudget"),(0,i.kt)("h1",{id:"interface-ibudgetelectionparameterswithbudget"},"Interface: IBudgetElectionParametersWithBudget"),(0,i.kt)("p",null,"Define election parameters."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},(0,i.kt)("inlineCode",{parentName:"a"},"IBudgetElectionParametersInfo"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"IBudgetElectionParametersWithBudget"))))),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#addsdkversion"},"addSDKVersion")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#census"},"census")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#description"},"description")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#electiontype"},"electionType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#enddate"},"endDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#forcefullbudget"},"forceFullBudget")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#header"},"header")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#maxbudget"},"maxBudget")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#maxcensussize"},"maxCensusSize")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#meta"},"meta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#minstep"},"minStep")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#questions"},"questions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#startdate"},"startDate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#streamuri"},"streamUri")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#title"},"title")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#usecensusweightasbudget"},"useCensusWeightAsBudget")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget#votetype"},"voteType"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"addsdkversion"},"addSDKVersion"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"addSDKVersion"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Used to add the SDK version to the election metadata"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#addsdkversion"},"addSDKVersion")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L155"},"types/election/election.ts:155")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"census"},"census"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"census"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census"},(0,i.kt)("inlineCode",{parentName:"a"},"Census"))),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#census"},"census")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L129"},"types/election/election.ts:129")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Election description"),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#description"},"description")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L114"},"types/election/election.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"electiontype"},"electionType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"electionType"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IElectionType"},(0,i.kt)("inlineCode",{parentName:"a"},"IElectionType"))),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#electiontype"},"electionType")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L131"},"types/election/election.ts:131")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"enddate"},"endDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"endDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#enddate"},"endDate")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L128"},"types/election/election.ts:128")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"forcefullbudget"},"forceFullBudget"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"forceFullBudget"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#forcefullbudget"},"forceFullBudget")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L9"},"types/election/budget.ts:9")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"header"},"header"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"header"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Election header image url."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#header"},"header")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L118"},"types/election/election.ts:118")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxbudget"},"maxBudget"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"maxBudget"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L18"},"types/election/budget.ts:18")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"maxcensussize"},"maxCensusSize"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"maxCensusSize"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Is used to limit the number of votes that can be registered for an election. This feature helps to prevent any\npotential overflow of the blockchain when the number of votes goes beyond the maximum limit."),(0,i.kt)("p",null,"In order to create an election, the creator is required to set the MaxCensusSize parameter to a proper value.\nTypically, this value should be equal to the size of the census. If the MaxCensusSize parameter is set to 0, an\nerror will occur and the election cannot be created."),(0,i.kt)("p",null,"If the number of votes exceeds this limit, will throw ",(0,i.kt)("inlineCode",{parentName:"p"},"Max census size for the election is greater than allowed\nsize")," error."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#maxcensussize"},"maxCensusSize")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L145"},"types/election/election.ts:145")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("p",null,"Metadata (anything added by the election creator)"),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#meta"},"meta")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L126"},"types/election/election.ts:126")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"minstep"},"minStep"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"minStep"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#minstep"},"minStep")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L8"},"types/election/budget.ts:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"questions"},"questions"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"questions"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IQuestion"},(0,i.kt)("inlineCode",{parentName:"a"},"IQuestion")),"[]"),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#questions"},"questions")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L132"},"types/election/election.ts:132")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"startdate"},"startDate"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"startDate"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Date")),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#startdate"},"startDate")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L127"},"types/election/election.ts:127")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"streamuri"},"streamUri"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"streamUri"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Election stream Uri (ex: a video url)"),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#streamuri"},"streamUri")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L122"},"types/election/election.ts:122")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"temporarysecretidentity"},"temporarySecretIdentity"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"temporarySecretIdentity"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Is used to remove the secret identities of the voters once the process is done."),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#temporarysecretidentity"},"temporarySecretIdentity")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L150"},"types/election/election.ts:150")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"MultiLanguage"),"\\<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("p",null,"Election title"),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#title"},"title")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L110"},"types/election/election.ts:110")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"usecensusweightasbudget"},"useCensusWeightAsBudget"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"useCensusWeightAsBudget"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"false")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/budget.ts#L17"},"types/election/budget.ts:17")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"votetype"},"voteType"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"voteType"),": ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteType"},(0,i.kt)("inlineCode",{parentName:"a"},"IVoteType"))),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo"},"IBudgetElectionParametersInfo"),".",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IBudgetElectionParametersInfo#votetype"},"voteType")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L130"},"types/election/election.ts:130")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f4a6fdc0.8d2d92f3.js b/assets/js/f4a6fdc0.8d2d92f3.js deleted file mode 100644 index 29a390b54..000000000 --- a/assets/js/f4a6fdc0.8d2d92f3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2707],{3905:(e,t,n)=>{n.d(t,{Zo:()=>h,kt:()=>u});var i=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function a(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var l=i.createContext({}),p=function(e){var t=i.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},h=function(e){var t=p(e.components);return i.createElement(l.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},d=i.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,l=e.parentName,h=s(e,["components","mdxType","originalType","parentName"]),d=p(n),u=o,g=d["".concat(l,".").concat(u)]||d[u]||c[u]||r;return n?i.createElement(g,a(a({ref:t},h),{},{components:n})):i.createElement(g,a({ref:t},h))}));function u(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,a=new Array(r);a[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:o,a[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>c,frontMatter:()=>r,metadata:()=>s,toc:()=>p});var i=n(87462),o=(n(67294),n(3905));const r={sidebar_position:5,slug:"weighted"},a="Weighted voting",s={unversionedId:"sdk/voting-types/weighted",id:"sdk/voting-types/weighted",title:"Weighted voting",description:"Weighted voting is a voting system where each voter is assigned a specific weight or value that reflects their relative influence or importance in the decision-making process.",source:"@site/docs/sdk/voting-types/weighted.md",sourceDirName:"sdk/voting-types",slug:"/sdk/voting-types/weighted",permalink:"/sdk/voting-types/weighted",draft:!1,tags:[],version:"current",sidebarPosition:5,frontMatter:{sidebar_position:5,slug:"weighted"},sidebar:"defaultSidebar",previous:{title:"Approval Voting (Multiple Choice)",permalink:"/sdk/voting-types/approval"},next:{title:"Quadratic voting",permalink:"/sdk/voting-types/quadratic"}},l={},p=[{value:"Setting up the election",id:"setting-up-the-election",level:2},{value:"Creating a WeightedCensus",id:"creating-a-weightedcensus",level:3},{value:"Casting a vote",id:"casting-a-vote",level:2},{value:"Results interpretation",id:"results-interpretation",level:2}],h={toc:p};function c(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,i.Z)({},h,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"weighted-voting"},"Weighted voting"),(0,o.kt)("p",null,"Weighted voting is a voting system where each voter is assigned a specific weight or value that reflects their relative influence or importance in the decision-making process."),(0,o.kt)("p",null,"When votes are cast, the value of each individual\u2019s vote is multiplied by their assigned weight, resulting in a weighted score. The sum of all the weighted scores determines the outcome of the vote. This system allows for a more nuanced\nrepresentation of voting power and can reflect the hierarchical structure or distribution of authority within the\norganization."),(0,o.kt)("h2",{id:"setting-up-the-election"},"Setting up the election"),(0,o.kt)("p",null,"The process creation and use of the ballot protocol is the same as on any other Election, the key difference is the\nuse of a ",(0,o.kt)("inlineCode",{parentName:"p"},"WeightedCensus")," instead of a ",(0,o.kt)("inlineCode",{parentName:"p"},"PlainCensus"),"."),(0,o.kt)("admonition",{title:"Where can I use a WeightedCensus?",type:"tip"},(0,o.kt)("p",{parentName:"admonition"},"Essentially, you can use the ",(0,o.kt)("inlineCode",{parentName:"p"},"WeightedCensus")," for any vote type except quadratic voting."),(0,o.kt)("p",{parentName:"admonition"},"Note that ",(0,o.kt)("inlineCode",{parentName:"p"},"quadratic voting")," already uses a ",(0,o.kt)("inlineCode",{parentName:"p"},"WeightedCensus")," but for other purposes. On a ",(0,o.kt)("inlineCode",{parentName:"p"},"quadratic election")," the\nweighted census are used to set the available credits for every voter when the option ",(0,o.kt)("inlineCode",{parentName:"p"},"costFromWeight")," is set to ",(0,o.kt)("inlineCode",{parentName:"p"},"true"),".")),(0,o.kt)("p",null,"The votes are stored on the blockchain with its weight like any other voting process. When the results are retrieved\nfrom the API, the indexer applies the weight to every vote, and this reflects in the results matrix."),(0,o.kt)("h3",{id:"creating-a-weightedcensus"},"Creating a ",(0,o.kt)("inlineCode",{parentName:"h3"},"WeightedCensus")),(0,o.kt)("p",null,"Following de above example, we are going to create a census where the weight is related to the position of the voter on\nthe participants array."),(0,o.kt)("p",null,"The process of generate a ",(0,o.kt)("inlineCode",{parentName:"p"},"WeightedCensus")," is similar to create a ",(0,o.kt)("inlineCode",{parentName:"p"},"PlainCensus")," with the difference that you have to\nadd the vote weight to every participant. As shown below, we are giving to each voter a weight associated to its\nposition on an array. For 4 voters, the first one will have a weight of 1, and the last will have 4."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"}," const census = new WeightedCensus();\n census.add(\n participants.map((participant, index) => ({\n key: participant.address,\n weight: BigInt(index + 1), // Give the weight to each participant\n }))\n );\n")),(0,o.kt)("h2",{id:"casting-a-vote"},"Casting a vote"),(0,o.kt)("p",null,'For instance, consider that 4 voters have to vote on the question: "Do you like chocolate?" with possible answers "yes" and "no".\nThe weight distribution and votes are as follows:'),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Voter 1: Weight = 1, Votes for option 0 (no), hence adds 1 vote."),(0,o.kt)("li",{parentName:"ul"},"Voter 2: Weight = 2, Votes for option 1 (yes), hence adds 2 votes."),(0,o.kt)("li",{parentName:"ul"},"Voter 3: Weight = 3, Votes for option 0 (no), hence adds 3 votes."),(0,o.kt)("li",{parentName:"ul"},"Voter 4: Weight = 4, Votes for option 1 (yes), hence adds 4 votes.")),(0,o.kt)("p",null,"The total census weight is ",(0,o.kt)("inlineCode",{parentName:"p"},"1 + 2 + 3 + 4 = 10")," and will be distributed among the choices."),(0,o.kt)("p",null,"The related code could be something like:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"client.submitVote(new Vote([participantIndex % 2]));\n")),(0,o.kt)("h2",{id:"results-interpretation"},"Results interpretation"),(0,o.kt)("p",null,"The results from a weighted voting process are returned by the API as an array, which encapsulates the sum of the\nweighted votes cast for each choice. In the given example, the API will return the following array:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"[ [ '4', '6' ] ]\n")),(0,o.kt)("p",null,"In this type of election, where there's only one question with two possible choices, the array represents the summed\nweights of votes for each option. Here, each index in the array corresponds to an option from the voting question."),(0,o.kt)("p",null,"The value at each index is the total of weighted votes that the corresponding option received. For the first option (no),\nthe total weighted votes are ",(0,o.kt)("inlineCode",{parentName:"p"},"1 (from voter 1) + 3 (from voter 3) = 4"),", hence '4' at the first index of the array."),(0,o.kt)("p",null,"For the second option (yes), the total weighted votes are ",(0,o.kt)("inlineCode",{parentName:"p"},"2 (from voter 2) + 4 (from voter 4) = 6"),", thus '6' at the\nsecond index."),(0,o.kt)("p",null,"The array ",(0,o.kt)("inlineCode",{parentName:"p"},"[ [ '4', '6' ] ]")," encapsulates this result, which can be interpreted as \"4 weighted votes for 'no' and 6\nweighted votes for 'yes'\"."))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f5100261.139ae809.js b/assets/js/f5100261.139ae809.js deleted file mode 100644 index 9701d225c..000000000 --- a/assets/js/f5100261.139ae809.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[8400],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>d});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),h=p(n),d=o,f=h["".concat(s,".").concat(d)]||h[d]||u[d]||i;return n?r.createElement(f,a(a({ref:t},c),{},{components:n})):r.createElement(f,a({ref:t},c))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=h;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:o,a[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var r=n(87462),o=(n(67294),n(3905));const i={},a="Voting Types",l={unversionedId:"sdk/voting-types/voting-types",id:"sdk/voting-types/voting-types",title:"Voting Types",description:"In this section, we will provide a brief overview of the different types of voting supported by the Vocdoni protocol and",source:"@site/docs/sdk/voting-types/voting-types.md",sourceDirName:"sdk/voting-types",slug:"/sdk/voting-types/",permalink:"/sdk/voting-types/",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"SDK Tutorial",permalink:"/sdk/tutorial"},next:{title:"Single Choice Voting",permalink:"/sdk/voting-types/single-choice"}},s={},p=[{value:"Election types",id:"election-types",level:2},{value:"Results interpretation",id:"results-interpretation",level:2}],c={toc:p};function u(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"voting-types"},"Voting Types"),(0,o.kt)("p",null,"In this section, we will provide a brief overview of the different types of voting supported by the Vocdoni protocol and\nhow it operates."),(0,o.kt)("h2",{id:"election-types"},"Election types"),(0,o.kt)("p",null,"The ",(0,o.kt)("a",{parentName:"p",href:"/protocol/ballot-protocol"},"Vocdoni Ballot protocol")," in its current implementation accommodates multiple ",(0,o.kt)("strong",{parentName:"p"},"elections types"),":"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"voting-types/single-choice"},"Single choice"),", each voter is typically allowed to cast only one vote for their preferred option. This\nvoting system is the only one that ",(0,o.kt)("strong",{parentName:"li"},"supports multiple questions"),". "),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"voting-types/ranked"},"Ranked voting"),", also known as preferential voting, is an electoral system where voters rank candidates in order of preference"),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"voting-types/approval"},"Approval voting"),", or multiple choice, here the voters are allowed to indicate their support for multiple\ncandidates or options."),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"voting-types/weighted"},"Weighted voting"),", each voter is assigned a specific weight or value that reflects their relative influence or\nimportance in the decision-making process."),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"voting-types/quadratic"},"Quadratic voting"),", voters can cast multiple votes for issues they prioritize, but the cost of casting\nadditional votes on the same issue rises exponentially.")),(0,o.kt)("p",null,"The configuration of these election types happens at the time of election creation using the SDK. Refer to the respective\ndocumentation for the parameter requirements for each election type."),(0,o.kt)("p",null,"A comprehensive explanation of the parameters used in the ballot protocol can be found ",(0,o.kt)("a",{parentName:"p",href:"/protocol/ballot-protocol"},"here"),"."),(0,o.kt)("h2",{id:"results-interpretation"},"Results interpretation"),(0,o.kt)("p",null,"The results are stored on the Vochain as a bi-dimensional array. Essentially, the ballot protocol is a system that\ntransforms a unidimensional array (a vote, e.g., ",(0,o.kt)("inlineCode",{parentName:"p"},"[1,4]"),") into a bi-dimensional array of results (e.g., ",(0,o.kt)("inlineCode",{parentName:"p"},"[[2,5]]"),")."),(0,o.kt)("p",null,"The interpretation of results is done on the user side, which receives the results from the SDK. The SDK provides\nmetadata about the election to facilitate understanding of the results. More details on interpreting results can be found,\n",(0,o.kt)("a",{parentName:"p",href:"/protocol/ballot#vocdoni-results-interpretation"},"here"),"."),(0,o.kt)("p",null,"Here's a simple example to demonstrate how the result array can be interpreted in different ways, depending on the\nelection type:"),(0,o.kt)("p",null,"Consider a question where 2 candidates are ranked by preference, which is an example of ",(0,o.kt)("inlineCode",{parentName:"p"},"ranked voting"),". The results\narray might look like this:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"[ \n [0, 0, 10], \n [0, 10, 0], \n [10, 0, 0] \n]\n")),(0,o.kt)("p",null,"In this scenario:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"10 voters select the first candidate as third option"),(0,o.kt)("li",{parentName:"ul"},"10 voters select the second candidate as second option"),(0,o.kt)("li",{parentName:"ul"},"10 voters select the third candidate as first option")),(0,o.kt)("p",null,'Now, let\'s examine another election type that can produce the same results array. For a question like "choose your 3\nfavorite colors out of 2", which is an example of ',(0,o.kt)("inlineCode",{parentName:"p"},"approval voting"),", the results array may look like that:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"[ \n [10, 0], \n [0, 10], \n [0, 10] \n]\n")),(0,o.kt)("p",null,"On this case, the results interpretation may vary:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"10 users give 0 points to first option"),(0,o.kt)("li",{parentName:"ul"},"10 users give 1 point to second and third options")),(0,o.kt)("p",null,"The examples above represent two methods for interpreting the results array. Additional examples are available for\ndifferent voting type result interpretations."),(0,o.kt)("admonition",{title:"Weighted results are calculated on the indexer",type:"note"},(0,o.kt)("p",{parentName:"admonition"},"In a weighted election, the Vochain stores the envelope without calculating the weight of each voter. However, when\nretrieving the results using the SDK, you will see the weights applied. The application of these weights is performed\nby the vocdoni-node indexer, which calculates the weights for you."),(0,o.kt)("p",{parentName:"admonition"},"The weights of each vote are stored in the envelope, which is saved on the Vochain.")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f77e462c.719a8b03.js b/assets/js/f77e462c.83e9a8cf.js similarity index 59% rename from assets/js/f77e462c.719a8b03.js rename to assets/js/f77e462c.83e9a8cf.js index 3a45e5d72..26183adf8 100644 --- a/assets/js/f77e462c.719a8b03.js +++ b/assets/js/f77e462c.83e9a8cf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2975],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>m});var r=t(67294);function s(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function a(e){for(var n=1;n=0||(s[t]=e[t]);return s}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(s[t]=e[t])}return s}var u=r.createContext({}),l=function(e){var n=r.useContext(u),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},p=function(e){var n=l(e.components);return r.createElement(u.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,s=e.mdxType,i=e.originalType,u=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),d=l(t),m=s,f=d["".concat(u,".").concat(m)]||d[m]||c[m]||i;return t?r.createElement(f,a(a({ref:n},p),{},{components:t})):r.createElement(f,a({ref:n},p))}));function m(e,n){var t=arguments,s=n&&n.mdxType;if("string"==typeof e||s){var i=t.length,a=new Array(i);a[0]=d;var o={};for(var u in n)hasOwnProperty.call(n,u)&&(o[u]=n[u]);o.originalType=e,o.mdxType="string"==typeof e?e:s,a[1]=o;for(var l=2;l{t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>a,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var r=t(87462),s=(t(67294),t(3905));const i={},a=void 0,o={unversionedId:"sdk/reference/enums/CensusType",id:"sdk/reference/enums/CensusType",title:"CensusType",description:"@vocdoni/sdk / Exports / CensusType",source:"@site/docs/sdk/reference/enums/CensusType.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/CensusType",permalink:"/sdk/reference/enums/CensusType",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CensusOrigin",permalink:"/sdk/reference/enums/CensusOrigin"},next:{title:"CensusTypeEnum",permalink:"/sdk/reference/enums/CensusTypeEnum"}},u={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"ANONYMOUS",id:"anonymous",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"CSP",id:"csp",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"UNKNOWN",id:"unknown",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"WEIGHTED",id:"weighted",level:3},{value:"Defined in",id:"defined-in-3",level:4}],p={toc:l};function c(e){let{components:n,...t}=e;return(0,s.kt)("wrapper",(0,r.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / CensusType"),(0,s.kt)("h1",{id:"enumeration-censustype"},"Enumeration: CensusType"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusType#anonymous"},"ANONYMOUS")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusType#csp"},"CSP")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusType#unknown"},"UNKNOWN")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusType#weighted"},"WEIGHTED"))),(0,s.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,s.kt)("h3",{id:"anonymous"},"ANONYMOUS"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"ANONYMOUS")," = ",(0,s.kt)("inlineCode",{parentName:"p"},'"zkweighted"')),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L3"},"types/census/census.ts:3")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"csp"},"CSP"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"CSP")," = ",(0,s.kt)("inlineCode",{parentName:"p"},'"csp"')),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L4"},"types/census/census.ts:4")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"unknown"},"UNKNOWN"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"UNKNOWN")," = ",(0,s.kt)("inlineCode",{parentName:"p"},'"unknown"')),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L5"},"types/census/census.ts:5")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"weighted"},"WEIGHTED"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"WEIGHTED")," = ",(0,s.kt)("inlineCode",{parentName:"p"},'"weighted"')),(0,s.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/census/census.ts#L2"},"types/census/census.ts:2")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2975],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>m});var r=t(67294);function s(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function a(e){for(var n=1;n=0||(s[t]=e[t]);return s}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(s[t]=e[t])}return s}var u=r.createContext({}),l=function(e){var n=r.useContext(u),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},p=function(e){var n=l(e.components);return r.createElement(u.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,s=e.mdxType,i=e.originalType,u=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),d=l(t),m=s,f=d["".concat(u,".").concat(m)]||d[m]||c[m]||i;return t?r.createElement(f,a(a({ref:n},p),{},{components:t})):r.createElement(f,a({ref:n},p))}));function m(e,n){var t=arguments,s=n&&n.mdxType;if("string"==typeof e||s){var i=t.length,a=new Array(i);a[0]=d;var o={};for(var u in n)hasOwnProperty.call(n,u)&&(o[u]=n[u]);o.originalType=e,o.mdxType="string"==typeof e?e:s,a[1]=o;for(var l=2;l{t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>a,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var r=t(87462),s=(t(67294),t(3905));const i={},a=void 0,o={unversionedId:"sdk/reference/enums/CensusType",id:"sdk/reference/enums/CensusType",title:"CensusType",description:"@vocdoni/sdk / Exports / CensusType",source:"@site/docs/sdk/reference/enums/CensusType.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/CensusType",permalink:"/sdk/reference/enums/CensusType",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"CensusOrigin",permalink:"/sdk/reference/enums/CensusOrigin"},next:{title:"CensusTypeEnum",permalink:"/sdk/reference/enums/CensusTypeEnum"}},u={},l=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"ANONYMOUS",id:"anonymous",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"CSP",id:"csp",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"UNKNOWN",id:"unknown",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"WEIGHTED",id:"weighted",level:3},{value:"Defined in",id:"defined-in-3",level:4}],p={toc:l};function c(e){let{components:n,...t}=e;return(0,s.kt)("wrapper",(0,r.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,s.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / CensusType"),(0,s.kt)("h1",{id:"enumeration-censustype"},"Enumeration: CensusType"),(0,s.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,s.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"CensusType#anonymous"},"ANONYMOUS")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"CensusType#csp"},"CSP")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"CensusType#unknown"},"UNKNOWN")),(0,s.kt)("li",{parentName:"ul"},(0,s.kt)("a",{parentName:"li",href:"CensusType#weighted"},"WEIGHTED"))),(0,s.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,s.kt)("h3",{id:"anonymous"},"ANONYMOUS"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"ANONYMOUS")," = ",(0,s.kt)("inlineCode",{parentName:"p"},'"zkweighted"')),(0,s.kt)("h4",{id:"defined-in"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L3"},"types/census/census.ts:3")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"csp"},"CSP"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"CSP")," = ",(0,s.kt)("inlineCode",{parentName:"p"},'"csp"')),(0,s.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L4"},"types/census/census.ts:4")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"unknown"},"UNKNOWN"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"UNKNOWN")," = ",(0,s.kt)("inlineCode",{parentName:"p"},'"unknown"')),(0,s.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L5"},"types/census/census.ts:5")),(0,s.kt)("hr",null),(0,s.kt)("h3",{id:"weighted"},"WEIGHTED"),(0,s.kt)("p",null,"\u2022 ",(0,s.kt)("strong",{parentName:"p"},"WEIGHTED")," = ",(0,s.kt)("inlineCode",{parentName:"p"},'"weighted"')),(0,s.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,s.kt)("p",null,(0,s.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/census/census.ts#L2"},"types/census/census.ts:2")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f9b740ff.1ee1645a.js b/assets/js/f9b740ff.e28883ea.js similarity index 78% rename from assets/js/f9b740ff.1ee1645a.js rename to assets/js/f9b740ff.e28883ea.js index 85dd0922b..0f3592f11 100644 --- a/assets/js/f9b740ff.1ee1645a.js +++ b/assets/js/f9b740ff.e28883ea.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4243],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),c=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},p=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),p=c(n),m=a,f=p["".concat(s,".").concat(m)]||p[m]||d[m]||o;return n?r.createElement(f,i(i({ref:t},u),{},{components:n})):r.createElement(f,i({ref:t},u))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=p;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:a,i[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var r=n(87462),a=(n(67294),n(3905));const o={},i=void 0,l={unversionedId:"sdk/reference/enums/ElectionStatusReady",id:"sdk/reference/enums/ElectionStatusReady",title:"ElectionStatusReady",description:"@vocdoni/sdk / Exports / ElectionStatusReady",source:"@site/docs/sdk/reference/enums/ElectionStatusReady.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/ElectionStatusReady",permalink:"/sdk/reference/enums/ElectionStatusReady",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ElectionStatus",permalink:"/sdk/reference/enums/ElectionStatus"},next:{title:"EnvOptions",permalink:"/sdk/reference/enums/EnvOptions"}},s={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"READY",id:"ready",level:3},{value:"Defined in",id:"defined-in",level:4}],u={toc:c};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / ElectionStatusReady"),(0,a.kt)("h1",{id:"enumeration-electionstatusready"},"Enumeration: ElectionStatusReady"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/enums/ElectionStatusReady#ready"},"READY"))),(0,a.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,a.kt)("h3",{id:"ready"},"READY"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"READY")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"READY"')),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/published.ts#L21"},"types/election/published.ts:21")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[4243],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),c=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},p=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),p=c(n),m=a,f=p["".concat(s,".").concat(m)]||p[m]||d[m]||o;return n?r.createElement(f,i(i({ref:t},u),{},{components:n})):r.createElement(f,i({ref:t},u))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=p;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:a,i[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var r=n(87462),a=(n(67294),n(3905));const o={},i=void 0,l={unversionedId:"sdk/reference/enums/ElectionStatusReady",id:"sdk/reference/enums/ElectionStatusReady",title:"ElectionStatusReady",description:"@vocdoni/sdk / Exports / ElectionStatusReady",source:"@site/docs/sdk/reference/enums/ElectionStatusReady.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/ElectionStatusReady",permalink:"/sdk/reference/enums/ElectionStatusReady",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"ElectionStatus",permalink:"/sdk/reference/enums/ElectionStatus"},next:{title:"EnvOptions",permalink:"/sdk/reference/enums/EnvOptions"}},s={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"READY",id:"ready",level:3},{value:"Defined in",id:"defined-in",level:4}],u={toc:c};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / ElectionStatusReady"),(0,a.kt)("h1",{id:"enumeration-electionstatusready"},"Enumeration: ElectionStatusReady"),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"ElectionStatusReady#ready"},"READY"))),(0,a.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,a.kt)("h3",{id:"ready"},"READY"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"READY")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"READY"')),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/published.ts#L21"},"types/election/published.ts:21")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/fc1a6383.7a8489a8.js b/assets/js/fc1a6383.7a8489a8.js deleted file mode 100644 index cd3628dfa..000000000 --- a/assets/js/fc1a6383.7a8489a8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5220],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=r.createContext({}),p=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},s=function(e){var t=p(e.components);return r.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,l=e.originalType,c=e.parentName,s=a(e,["components","mdxType","originalType","parentName"]),u=p(n),f=i,k=u["".concat(c,".").concat(f)]||u[f]||d[f]||l;return n?r.createElement(k,o(o({ref:t},s),{},{components:n})):r.createElement(k,o({ref:t},s))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=n.length,o=new Array(l);o[0]=u;var a={};for(var c in t)hasOwnProperty.call(t,c)&&(a[c]=t[c]);a.originalType=e,a.mdxType="string"==typeof e?e:i,o[1]=a;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>l,metadata:()=>a,toc:()=>p});var r=n(87462),i=(n(67294),n(3905));const l={},o=void 0,a={unversionedId:"sdk/reference/interfaces/IElectionType",id:"sdk/reference/interfaces/IElectionType",title:"IElectionType",description:"@vocdoni/sdk / Exports / IElectionType",source:"@site/docs/sdk/reference/interfaces/IElectionType.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionType",permalink:"/sdk/reference/interfaces/IElectionType",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionSummary",permalink:"/sdk/reference/interfaces/IElectionSummary"},next:{title:"IElectionVote",permalink:"/sdk/reference/interfaces/IElectionVote"}},c={},p=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"anonymous",id:"anonymous",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"autoStart",id:"autostart",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"dynamicCensus",id:"dynamiccensus",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"interruptible",id:"interruptible",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"secretUntilTheEnd",id:"secretuntiltheend",level:3},{value:"Defined in",id:"defined-in-4",level:4}],s={toc:p};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / IElectionType"),(0,i.kt)("h1",{id:"interface-ielectiontype"},"Interface: IElectionType"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionType#anonymous"},"anonymous")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionType#autostart"},"autoStart")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionType#dynamiccensus"},"dynamicCensus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionType#interruptible"},"interruptible")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/sdk/reference/interfaces/IElectionType#secretuntiltheend"},"secretUntilTheEnd"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"anonymous"},"anonymous"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"anonymous"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Enable anonymous voting."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L92"},"types/election/election.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"autostart"},"autoStart"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"autoStart"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"If false, election will start PAUSED and will have to be resumed manually."),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L76"},"types/election/election.ts:76")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"dynamiccensus"},"dynamicCensus"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"dynamicCensus"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Can add more voters to the census tree during the election."),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L84"},"types/election/election.ts:84")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"interruptible"},"interruptible"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"interruptible"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"The process can be paused and resumed."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L80"},"types/election/election.ts:80")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"secretuntiltheend"},"secretUntilTheEnd"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"secretUntilTheEnd"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Protect the results until the end of the process if true. It will show live results otherwise."),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/types/election/election.ts#L88"},"types/election/election.ts:88")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/fc1a6383.d30476b0.js b/assets/js/fc1a6383.d30476b0.js new file mode 100644 index 000000000..d93fd3307 --- /dev/null +++ b/assets/js/fc1a6383.d30476b0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[5220],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>f});var r=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var p=r.createContext({}),c=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},s=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,l=e.originalType,p=e.parentName,s=a(e,["components","mdxType","originalType","parentName"]),u=c(n),f=i,m=u["".concat(p,".").concat(f)]||u[f]||d[f]||l;return n?r.createElement(m,o(o({ref:t},s),{},{components:n})):r.createElement(m,o({ref:t},s))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=n.length,o=new Array(l);o[0]=u;var a={};for(var p in t)hasOwnProperty.call(t,p)&&(a[p]=t[p]);a.originalType=e,a.mdxType="string"==typeof e?e:i,o[1]=a;for(var c=2;c{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>l,metadata:()=>a,toc:()=>c});var r=n(87462),i=(n(67294),n(3905));const l={},o=void 0,a={unversionedId:"sdk/reference/interfaces/IElectionType",id:"sdk/reference/interfaces/IElectionType",title:"IElectionType",description:"@vocdoni/sdk / Exports / IElectionType",source:"@site/docs/sdk/reference/interfaces/IElectionType.md",sourceDirName:"sdk/reference/interfaces",slug:"/sdk/reference/interfaces/IElectionType",permalink:"/sdk/reference/interfaces/IElectionType",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"IElectionSummary",permalink:"/sdk/reference/interfaces/IElectionSummary"},next:{title:"IElectionVote",permalink:"/sdk/reference/interfaces/IElectionVote"}},p={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Properties",id:"properties",level:3},{value:"Properties",id:"properties-1",level:2},{value:"anonymous",id:"anonymous",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"autoStart",id:"autostart",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"dynamicCensus",id:"dynamiccensus",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"interruptible",id:"interruptible",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"secretUntilTheEnd",id:"secretuntiltheend",level:3},{value:"Defined in",id:"defined-in-4",level:4}],s={toc:c};function d(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,i.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / IElectionType"),(0,i.kt)("h1",{id:"interface-ielectiontype"},"Interface: IElectionType"),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"properties"},"Properties"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IElectionType#anonymous"},"anonymous")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IElectionType#autostart"},"autoStart")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IElectionType#dynamiccensus"},"dynamicCensus")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IElectionType#interruptible"},"interruptible")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"IElectionType#secretuntiltheend"},"secretUntilTheEnd"))),(0,i.kt)("h2",{id:"properties-1"},"Properties"),(0,i.kt)("h3",{id:"anonymous"},"anonymous"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"anonymous"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Enable anonymous voting."),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L92"},"types/election/election.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"autostart"},"autoStart"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"autoStart"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"If false, election will start PAUSED and will have to be resumed manually."),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L76"},"types/election/election.ts:76")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"dynamiccensus"},"dynamicCensus"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"dynamicCensus"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Can add more voters to the census tree during the election."),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L84"},"types/election/election.ts:84")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"interruptible"},"interruptible"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"interruptible"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"The process can be paused and resumed."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L80"},"types/election/election.ts:80")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"secretuntiltheend"},"secretUntilTheEnd"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"secretUntilTheEnd"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Protect the results until the end of the process if true. It will show live results otherwise."),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/election/election.ts#L88"},"types/election/election.ts:88")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/fc441bf1.06d0e204.js b/assets/js/fc441bf1.06d0e204.js new file mode 100644 index 000000000..dfd448c31 --- /dev/null +++ b/assets/js/fc441bf1.06d0e204.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9192],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>k});var i=t(67294);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function l(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var o=i.createContext({}),c=function(e){var n=i.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},d=function(e){var n=c(e.components);return i.createElement(o.Provider,{value:n},e.children)},p={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,r=e.mdxType,a=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=c(t),k=r,f=u["".concat(o,".").concat(k)]||u[k]||p[k]||a;return t?i.createElement(f,l(l({ref:n},d),{},{components:t})):i.createElement(f,l({ref:n},d))}));function k(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var a=t.length,l=new Array(a);l[0]=u;var s={};for(var o in n)hasOwnProperty.call(n,o)&&(s[o]=n[o]);s.originalType=e,s.mdxType="string"==typeof e?e:r,l[1]=s;for(var c=2;c{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>l,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var i=t(87462),r=(t(67294),t(3905));const a={},l=void 0,s={unversionedId:"sdk/reference/enums/CensusOrigin",id:"sdk/reference/enums/CensusOrigin",title:"CensusOrigin",description:"@vocdoni/sdk / Exports / CensusOrigin",source:"@site/docs/sdk/reference/enums/CensusOrigin.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/CensusOrigin",permalink:"/sdk/reference/enums/CensusOrigin",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"WeightedCensus",permalink:"/sdk/reference/classes/WeightedCensus"},next:{title:"CensusType",permalink:"/sdk/reference/enums/CensusType"}},o={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"CENSUS_UNKNOWN",id:"census_unknown",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ERC1155",id:"erc1155",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ERC20",id:"erc20",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"ERC721",id:"erc721",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"ERC777",id:"erc777",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"MINI_ME",id:"mini_me",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"OFF_CHAIN_CA",id:"off_chain_ca",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"OFF_CHAIN_TREE",id:"off_chain_tree",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"OFF_CHAIN_TREE_WEIGHTED",id:"off_chain_tree_weighted",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"UNRECOGNIZED",id:"unrecognized",level:3},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:c};function p(e){let{components:n,...t}=e;return(0,r.kt)("wrapper",(0,i.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / CensusOrigin"),(0,r.kt)("h1",{id:"enumeration-censusorigin"},"Enumeration: CensusOrigin"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusOrigin#census_unknown"},"CENSUS","_","UNKNOWN")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusOrigin#erc1155"},"ERC1155")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusOrigin#erc20"},"ERC20")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusOrigin#erc721"},"ERC721")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusOrigin#erc777"},"ERC777")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusOrigin#mini_me"},"MINI","_","ME")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusOrigin#off_chain_ca"},"OFF","_","CHAIN","_","CA")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusOrigin#off_chain_tree"},"OFF","_","CHAIN","_","TREE")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusOrigin#off_chain_tree_weighted"},"OFF","_","CHAIN","_","TREE","_","WEIGHTED")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"CensusOrigin#unrecognized"},"UNRECOGNIZED"))),(0,r.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,r.kt)("h3",{id:"census_unknown"},"CENSUS","_","UNKNOWN"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"CENSUS","_","UNKNOWN")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"0")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L234"},"api/chain/transactions.ts:234")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"erc1155"},"ERC1155"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ERC1155")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"13")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L240"},"api/chain/transactions.ts:240")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"erc20"},"ERC20"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ERC20")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"11")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L238"},"api/chain/transactions.ts:238")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"erc721"},"ERC721"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ERC721")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"12")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L239"},"api/chain/transactions.ts:239")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"erc777"},"ERC777"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ERC777")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"14")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L241"},"api/chain/transactions.ts:241")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"mini_me"},"MINI","_","ME"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"MINI","_","ME")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"15")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L242"},"api/chain/transactions.ts:242")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"off_chain_ca"},"OFF","_","CHAIN","_","CA"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"OFF","_","CHAIN","_","CA")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"3")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L237"},"api/chain/transactions.ts:237")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"off_chain_tree"},"OFF","_","CHAIN","_","TREE"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"OFF","_","CHAIN","_","TREE")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"1")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L235"},"api/chain/transactions.ts:235")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"off_chain_tree_weighted"},"OFF","_","CHAIN","_","TREE","_","WEIGHTED"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"OFF","_","CHAIN","_","TREE","_","WEIGHTED")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"2")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L236"},"api/chain/transactions.ts:236")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"unrecognized"},"UNRECOGNIZED"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"UNRECOGNIZED")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"-1")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/chain/transactions.ts#L243"},"api/chain/transactions.ts:243")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/fc441bf1.de50a0c3.js b/assets/js/fc441bf1.de50a0c3.js deleted file mode 100644 index e9d10d181..000000000 --- a/assets/js/fc441bf1.de50a0c3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[9192],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>k});var i=t(67294);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function s(e){for(var n=1;n=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var o=i.createContext({}),c=function(e){var n=i.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):s(s({},n),e)),t},d=function(e){var n=c(e.components);return i.createElement(o.Provider,{value:n},e.children)},p={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,r=e.mdxType,a=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=c(t),k=r,f=u["".concat(o,".").concat(k)]||u[k]||p[k]||a;return t?i.createElement(f,s(s({ref:n},d),{},{components:t})):i.createElement(f,s({ref:n},d))}));function k(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var a=t.length,s=new Array(a);s[0]=u;var l={};for(var o in n)hasOwnProperty.call(n,o)&&(l[o]=n[o]);l.originalType=e,l.mdxType="string"==typeof e?e:r,s[1]=l;for(var c=2;c{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var i=t(87462),r=(t(67294),t(3905));const a={},s=void 0,l={unversionedId:"sdk/reference/enums/CensusOrigin",id:"sdk/reference/enums/CensusOrigin",title:"CensusOrigin",description:"@vocdoni/sdk / Exports / CensusOrigin",source:"@site/docs/sdk/reference/enums/CensusOrigin.md",sourceDirName:"sdk/reference/enums",slug:"/sdk/reference/enums/CensusOrigin",permalink:"/sdk/reference/enums/CensusOrigin",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"WeightedCensus",permalink:"/sdk/reference/classes/WeightedCensus"},next:{title:"CensusType",permalink:"/sdk/reference/enums/CensusType"}},o={},c=[{value:"Table of contents",id:"table-of-contents",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"Enumeration Members",id:"enumeration-members-1",level:2},{value:"CENSUS_UNKNOWN",id:"census_unknown",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ERC1155",id:"erc1155",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ERC20",id:"erc20",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"ERC721",id:"erc721",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"ERC777",id:"erc777",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"MINI_ME",id:"mini_me",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"OFF_CHAIN_CA",id:"off_chain_ca",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"OFF_CHAIN_TREE",id:"off_chain_tree",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"OFF_CHAIN_TREE_WEIGHTED",id:"off_chain_tree_weighted",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"UNRECOGNIZED",id:"unrecognized",level:3},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:c};function p(e){let{components:n,...t}=e;return(0,r.kt)("wrapper",(0,i.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / CensusOrigin"),(0,r.kt)("h1",{id:"enumeration-censusorigin"},"Enumeration: CensusOrigin"),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"enumeration-members"},"Enumeration Members"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusOrigin#census_unknown"},"CENSUS","_","UNKNOWN")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusOrigin#erc1155"},"ERC1155")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusOrigin#erc20"},"ERC20")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusOrigin#erc721"},"ERC721")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusOrigin#erc777"},"ERC777")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusOrigin#mini_me"},"MINI","_","ME")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusOrigin#off_chain_ca"},"OFF","_","CHAIN","_","CA")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusOrigin#off_chain_tree"},"OFF","_","CHAIN","_","TREE")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusOrigin#off_chain_tree_weighted"},"OFF","_","CHAIN","_","TREE","_","WEIGHTED")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/enums/CensusOrigin#unrecognized"},"UNRECOGNIZED"))),(0,r.kt)("h2",{id:"enumeration-members-1"},"Enumeration Members"),(0,r.kt)("h3",{id:"census_unknown"},"CENSUS","_","UNKNOWN"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"CENSUS","_","UNKNOWN")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"0")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L234"},"api/chain/transactions.ts:234")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"erc1155"},"ERC1155"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ERC1155")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"13")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L240"},"api/chain/transactions.ts:240")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"erc20"},"ERC20"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ERC20")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"11")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L238"},"api/chain/transactions.ts:238")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"erc721"},"ERC721"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ERC721")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"12")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L239"},"api/chain/transactions.ts:239")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"erc777"},"ERC777"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"ERC777")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"14")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L241"},"api/chain/transactions.ts:241")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"mini_me"},"MINI","_","ME"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"MINI","_","ME")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"15")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L242"},"api/chain/transactions.ts:242")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"off_chain_ca"},"OFF","_","CHAIN","_","CA"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"OFF","_","CHAIN","_","CA")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"3")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L237"},"api/chain/transactions.ts:237")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"off_chain_tree"},"OFF","_","CHAIN","_","TREE"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"OFF","_","CHAIN","_","TREE")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"1")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L235"},"api/chain/transactions.ts:235")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"off_chain_tree_weighted"},"OFF","_","CHAIN","_","TREE","_","WEIGHTED"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"OFF","_","CHAIN","_","TREE","_","WEIGHTED")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"2")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L236"},"api/chain/transactions.ts:236")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"unrecognized"},"UNRECOGNIZED"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"UNRECOGNIZED")," = ",(0,r.kt)("inlineCode",{parentName:"p"},"-1")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/chain/transactions.ts#L243"},"api/chain/transactions.ts:243")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/fe008fee.5cb25b0f.js b/assets/js/fe008fee.5cb25b0f.js deleted file mode 100644 index dfbb84866..000000000 --- a/assets/js/fe008fee.5cb25b0f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2733],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>m});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),p=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},o=function(e){var t=p(e.components);return a.createElement(d.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),k=p(n),m=r,c=k["".concat(d,".").concat(m)]||k[m]||u[m]||i;return n?a.createElement(c,s(s({ref:t},o),{},{components:n})):a.createElement(c,s({ref:t},o))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,s=new Array(i);s[0]=k;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l.mdxType="string"==typeof e?e:r,s[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var a=n(87462),r=(n(67294),n(3905));const i={},s=void 0,l={unversionedId:"sdk/reference/classes/Census3CensusAPI",id:"sdk/reference/classes/Census3CensusAPI",title:"Census3CensusAPI",description:"@vocdoni/sdk / Exports / Census3CensusAPI",source:"@site/docs/sdk/reference/classes/Census3CensusAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Census3CensusAPI",permalink:"/sdk/reference/classes/Census3CensusAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Census",permalink:"/sdk/reference/classes/Census"},next:{title:"Census3ServiceAPI",permalink:"/sdk/reference/classes/Census3ServiceAPI"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"census",id:"census",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"list",id:"list",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"queue",id:"queue",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"serializePagination",id:"serializepagination",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-7",level:4}],o={toc:p};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / Census3CensusAPI"),(0,r.kt)("h1",{id:"class-census3censusapi"},"Class: Census3CensusAPI"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"Census3API")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Census3CensusAPI"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3CensusAPI#constructor"},"constructor"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3CensusAPI#census"},"census")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3CensusAPI#create"},"create")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3CensusAPI#isapierror"},"isApiError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3CensusAPI#isundefinederror"},"isUndefinedError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3CensusAPI#list"},"list")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3CensusAPI#queue"},"queue")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/sdk/reference/classes/Census3CensusAPI#serializepagination"},"serializePagination"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new Census3CensusAPI"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census3CensusAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3CensusAPI"))),(0,r.kt)("p",null,"Cannot be constructed."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Census3CensusAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3CensusAPI"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"Census3API.constructor"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L91"},"api/census3/census.ts:91")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"census"},"census"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"census"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),">"),(0,r.kt)("p",null,"Returns the information of the census"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the census")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L116"},"api/census3/census.ts:116")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"create"},"create"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"create"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"strategyId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensus3QueueResponse"),">"),(0,r.kt)("p",null,"Requests the creation of a new census with the strategy provided."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"strategyId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The strategy identifier")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the census has to be anonymous")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensus3QueueResponse"),">"),(0,r.kt)("p",null,"The queue identifier"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L145"},"api/census3/census.ts:145")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isapierror"},"isApiError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"Census3API.isApiError"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/api.ts#L101"},"api/census3/api.ts:101")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"Census3API.isUndefinedError"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L64"},"api/api.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"list"},"list"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"list"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"strategy"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3CensusListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusListResponse")),">"),(0,r.kt)("p",null,"Fetches list of census based on given strategy"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"strategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the strategy")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3CensusListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L102"},"api/census3/census.ts:102")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"queue"},"queue"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"queue"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3CensusQueueResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusQueueResponse")),">"),(0,r.kt)("p",null,"Returns the information of the census queue"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the census queue")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/ICensus3CensusQueueResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusQueueResponse")),">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/census.ts#L130"},"api/census3/census.ts:130")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"serializepagination"},"serializePagination"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"serializePagination"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"pagination?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pagination?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Census3Pagination"))))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,"Census3API.serializePagination"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/census3/api.ts#L92"},"api/census3/api.ts:92")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/fe008fee.f893e23a.js b/assets/js/fe008fee.f893e23a.js new file mode 100644 index 000000000..91536a989 --- /dev/null +++ b/assets/js/fe008fee.f893e23a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2733],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>m});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),d=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},o=function(e){var t=d(e.components);return a.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),k=d(n),m=r,c=k["".concat(p,".").concat(m)]||k[m]||u[m]||i;return n?a.createElement(c,s(s({ref:t},o),{},{components:n})):a.createElement(c,s({ref:t},o))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,s=new Array(i);s[0]=k;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:r,s[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var a=n(87462),r=(n(67294),n(3905));const i={},s=void 0,l={unversionedId:"sdk/reference/classes/Census3CensusAPI",id:"sdk/reference/classes/Census3CensusAPI",title:"Census3CensusAPI",description:"@vocdoni/sdk / Exports / Census3CensusAPI",source:"@site/docs/sdk/reference/classes/Census3CensusAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/Census3CensusAPI",permalink:"/sdk/reference/classes/Census3CensusAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Census",permalink:"/sdk/reference/classes/Census"},next:{title:"Census3ServiceAPI",permalink:"/sdk/reference/classes/Census3ServiceAPI"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"census",id:"census",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"create",id:"create",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"list",id:"list",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"queue",id:"queue",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"serializePagination",id:"serializepagination",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-7",level:4}],o={toc:d};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,r.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / Census3CensusAPI"),(0,r.kt)("h1",{id:"class-census3censusapi"},"Class: Census3CensusAPI"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"Census3API")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Census3CensusAPI"))))),(0,r.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,r.kt)("h3",{id:"constructors"},"Constructors"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3CensusAPI#constructor"},"constructor"))),(0,r.kt)("h3",{id:"methods"},"Methods"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3CensusAPI#census"},"census")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3CensusAPI#create"},"create")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3CensusAPI#isapierror"},"isApiError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3CensusAPI#isundefinederror"},"isUndefinedError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3CensusAPI#list"},"list")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3CensusAPI#queue"},"queue")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"Census3CensusAPI#serializepagination"},"serializePagination"))),(0,r.kt)("h2",{id:"constructors-1"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new Census3CensusAPI"),"(): ",(0,r.kt)("a",{parentName:"p",href:"Census3CensusAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3CensusAPI"))),(0,r.kt)("p",null,"Cannot be constructed."),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"Census3CensusAPI"},(0,r.kt)("inlineCode",{parentName:"a"},"Census3CensusAPI"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"Census3API.constructor"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L91"},"api/census3/census.ts:91")),(0,r.kt)("h2",{id:"methods-1"},"Methods"),(0,r.kt)("h3",{id:"census"},"census"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"census"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),">"),(0,r.kt)("p",null,"Returns the information of the census"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the census")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3CensusResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusResponse")),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L116"},"api/census3/census.ts:116")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"create"},"create"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"create"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"strategyId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"anonymous?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensus3QueueResponse"),">"),(0,r.kt)("p",null,"Requests the creation of a new census with the strategy provided."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"strategyId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The strategy identifier")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"anonymous")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the census has to be anonymous")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("inlineCode",{parentName:"p"},"ICensus3QueueResponse"),">"),(0,r.kt)("p",null,"The queue identifier"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L145"},"api/census3/census.ts:145")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isapierror"},"isApiError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"Census3API.isApiError"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/api.ts#L101"},"api/census3/api.ts:101")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"never")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"Census3API.isUndefinedError"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L64"},"api/api.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"list"},"list"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"list"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"strategy"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3CensusListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusListResponse")),">"),(0,r.kt)("p",null,"Fetches list of census based on given strategy"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"strategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the strategy")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3CensusListResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusListResponse")),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L102"},"api/census3/census.ts:102")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"queue"},"queue"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"queue"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3CensusQueueResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusQueueResponse")),">"),(0,r.kt)("p",null,"Returns the information of the census queue"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"API endpoint URL")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The identifier of the census queue")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,r.kt)("a",{parentName:"p",href:"../interfaces/ICensus3CensusQueueResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"ICensus3CensusQueueResponse")),">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/census.ts#L130"},"api/census3/census.ts:130")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"serializepagination"},"serializePagination"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"serializePagination"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"pagination?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pagination?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Census3Pagination"))))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,"Census3API.serializePagination"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/census3/api.ts#L92"},"api/census3/api.ts:92")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/fe9260cd.0f8e982a.js b/assets/js/fe9260cd.0f8e982a.js new file mode 100644 index 000000000..f3922ff27 --- /dev/null +++ b/assets/js/fe9260cd.0f8e982a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1132],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>p});var i=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function d(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var r=i.createContext({}),u=function(e){var t=i.useContext(r),n=t;return e&&(n="function"==typeof e?e(t):d(d({},t),e)),n},s=function(e){var t=u(e.components);return i.createElement(r.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,r=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),k=u(n),p=a,h=k["".concat(r,".").concat(p)]||k[p]||c[p]||l;return n?i.createElement(h,d(d({ref:t},s),{},{components:n})):i.createElement(h,d({ref:t},s))}));function p(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,d=new Array(l);d[0]=k;var o={};for(var r in t)hasOwnProperty.call(t,r)&&(o[r]=t[r]);o.originalType=e,o.mdxType="string"==typeof e?e:a,d[1]=o;for(var u=2;u{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>d,default:()=>c,frontMatter:()=>l,metadata:()=>o,toc:()=>u});var i=n(87462),a=(n(67294),n(3905));const l={},d="Changelog",o={unversionedId:"sdk/reference/changelog",id:"sdk/reference/changelog",title:"Changelog",description:"All notable changes to this project will be documented in this file.",source:"@site/docs/sdk/reference/changelog.md",sourceDirName:"sdk/reference",slug:"/sdk/reference/changelog",permalink:"/sdk/reference/changelog",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"modules",permalink:"/sdk/reference/modules"},next:{title:"UI Components",permalink:"/ui-components/"}},r={},u=[{value:"0.7.5 - 2024-02-15",id:"075---2024-02-15",level:2},{value:"Added",id:"added",level:3},{value:"Fixed",id:"fixed",level:3},{value:"0.7.4 - 2024-02-06",id:"074---2024-02-06",level:2},{value:"Added",id:"added-1",level:3},{value:"0.7.3 - 2024-01-23",id:"073---2024-01-23",level:2},{value:"Added",id:"added-2",level:3},{value:"Fixed",id:"fixed-1",level:3},{value:"0.7.2 - 2024-01-17",id:"072---2024-01-17",level:2},{value:"Added",id:"added-3",level:3},{value:"Fixed",id:"fixed-2",level:3},{value:"0.7.1 - 2024-01-11",id:"071---2024-01-11",level:2},{value:"Changed",id:"changed",level:3},{value:"Fixed",id:"fixed-3",level:3},{value:"Added",id:"added-4",level:3},{value:"0.7.0 - 2023-12-13",id:"070---2023-12-13",level:2},{value:"Changed",id:"changed-1",level:3},{value:"0.6.1 - 2023-11-29",id:"061---2023-11-29",level:2},{value:"Added",id:"added-5",level:3},{value:"Fixed",id:"fixed-4",level:3},{value:"0.6.0 - 2023-11-28",id:"060---2023-11-28",level:2},{value:"Added",id:"added-6",level:3},{value:"Changed",id:"changed-2",level:3},{value:"0.5.3 - 2023-11-28",id:"053---2023-11-28",level:2},{value:"Added",id:"added-7",level:3},{value:"Fixed",id:"fixed-5",level:3},{value:"Changed",id:"changed-3",level:3},{value:"0.5.2 - 2023-11-16",id:"052---2023-11-16",level:2},{value:"Fixed",id:"fixed-6",level:3},{value:"0.5.1 - 2023-11-15",id:"051---2023-11-15",level:2},{value:"Fixed",id:"fixed-7",level:3},{value:"0.5.0 - 2023-11-14",id:"050---2023-11-14",level:2},{value:"Changed",id:"changed-4",level:3},{value:"0.4.3 - 2023-11-09",id:"043---2023-11-09",level:2},{value:"Added",id:"added-8",level:3},{value:"0.4.2 - 2023-11-06",id:"042---2023-11-06",level:2},{value:"Changed",id:"changed-5",level:3},{value:"Added",id:"added-9",level:3},{value:"Fixed",id:"fixed-8",level:3},{value:"0.4.1 - 2023-10-24",id:"041---2023-10-24",level:2},{value:"Changed",id:"changed-6",level:3},{value:"0.4.0 - 2023-10-10",id:"040---2023-10-10",level:2},{value:"Changed",id:"changed-7",level:3},{value:"0.3.2 - 2023-10-10",id:"032---2023-10-10",level:2},{value:"Added",id:"added-10",level:3},{value:"Fixed",id:"fixed-9",level:3},{value:"0.3.1 - 2023-09-20",id:"031---2023-09-20",level:2},{value:"Added",id:"added-11",level:3},{value:"Changed",id:"changed-8",level:3},{value:"Fixed",id:"fixed-10",level:3},{value:"0.3.0 - 2023-09-13",id:"030---2023-09-13",level:2},{value:"Fixed",id:"fixed-11",level:3},{value:"Changed",id:"changed-9",level:3},{value:"Added",id:"added-12",level:3},{value:"0.2.0 - 2023-09-04",id:"020---2023-09-04",level:2},{value:"Fixed",id:"fixed-12",level:3},{value:"Changed",id:"changed-10",level:3},{value:"Added",id:"added-13",level:3},{value:"0.1.1 - 2023-08-14",id:"011---2023-08-14",level:2},{value:"Fixed",id:"fixed-13",level:3},{value:"0.1.0 - 2023-08-11",id:"010---2023-08-11",level:2},{value:"Added",id:"added-14",level:3},{value:"Fixed",id:"fixed-14",level:3},{value:"0.0.18 - 2023-08-01",id:"0018---2023-08-01",level:2},{value:"Added",id:"added-15",level:3},{value:"Fixed",id:"fixed-15",level:3},{value:"0.0.17 - 2023-07-21",id:"0017---2023-07-21",level:2},{value:"Added",id:"added-16",level:3},{value:"Changed",id:"changed-11",level:3},{value:"0.0.16 - 2023-07-04",id:"0016---2023-07-04",level:2},{value:"Added",id:"added-17",level:3},{value:"Changed",id:"changed-12",level:3},{value:"Fixed",id:"fixed-16",level:3},{value:"0.0.15 - 2023-06-20",id:"0015---2023-06-20",level:2},{value:"Added",id:"added-18",level:3},{value:"Changed",id:"changed-13",level:3},{value:"Fixed",id:"fixed-17",level:3},{value:"0.0.14 - 2023-06-12",id:"0014---2023-06-12",level:2},{value:"Added",id:"added-19",level:3},{value:"0.0.13 - 2023-06-06",id:"0013---2023-06-06",level:2},{value:"Added",id:"added-20",level:3},{value:"Changed",id:"changed-14",level:3},{value:"Fixed",id:"fixed-18",level:3},{value:"0.0.12 - 2023-05-09",id:"0012---2023-05-09",level:2},{value:"Fixed",id:"fixed-19",level:3},{value:"0.0.11 - 2023-04-25",id:"0011---2023-04-25",level:2},{value:"Fixed",id:"fixed-20",level:3},{value:"0.0.10 - 2023-04-25",id:"0010---2023-04-25",level:2},{value:"Fixed",id:"fixed-21",level:3},{value:"0.0.9 - 2023-04-25",id:"009---2023-04-25",level:2},{value:"Added",id:"added-21",level:3},{value:"Changed",id:"changed-15",level:3},{value:"Removed",id:"removed",level:3},{value:"0.0.8 - 2023-04-05",id:"008---2023-04-05",level:2},{value:"Added",id:"added-22",level:3},{value:"Changed",id:"changed-16",level:3},{value:"Fixed",id:"fixed-22",level:3},{value:"0.0.7 - 2023-03-29",id:"007---2023-03-29",level:2},{value:"Changed",id:"changed-17",level:3},{value:"0.0.6 - 2023-03-22",id:"006---2023-03-22",level:2},{value:"Changed",id:"changed-18",level:3},{value:"0.0.5 - 2023-03-08",id:"005---2023-03-08",level:2},{value:"Added",id:"added-23",level:3},{value:"Changed",id:"changed-19",level:3},{value:"0.0.4-alpha - 2023-03-01",id:"004-alpha---2023-03-01",level:2},{value:"Added",id:"added-24",level:3},{value:"Changed",id:"changed-20",level:3},{value:"Fixed",id:"fixed-23",level:3},{value:"0.0.3-alpha - 2023-01-31",id:"003-alpha---2023-01-31",level:2},{value:"Added",id:"added-25",level:3},{value:"Fixed",id:"fixed-24",level:3},{value:"Changed",id:"changed-21",level:3},{value:"0.0.2-alpha - 2022-12-20",id:"002-alpha---2022-12-20",level:2},{value:"Added",id:"added-26",level:3},{value:"Fixed",id:"fixed-25",level:3},{value:"Changed",id:"changed-22",level:3},{value:"0.0.1-alpha - 2022-12-01",id:"001-alpha---2022-12-01",level:2},{value:"Added",id:"added-27",level:3}],s={toc:u};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"changelog"},"Changelog"),(0,a.kt)("p",null,"All notable changes to this project will be documented in this file."),(0,a.kt)("p",null,"The format is based on ",(0,a.kt)("a",{parentName:"p",href:"https://keepachangelog.com/en/1.0.0/"},"Keep a Changelog"),",\nand this project adheres to ",(0,a.kt)("a",{parentName:"p",href:"https://semver.org/spec/v2.0.0.html"},"Semantic Versioning"),"."),(0,a.kt)("h2",{id:"075---2024-02-15"},"[0.7.5]"," - 2024-02-15"),(0,a.kt)("h3",{id:"added"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added support for getting token holder balance in Census3 using ",(0,a.kt)("inlineCode",{parentName:"li"},"tokenHolderBalance"),"."),(0,a.kt)("li",{parentName:"ul"},"Added support for getting token holders based on strategy using ",(0,a.kt)("inlineCode",{parentName:"li"},"getStrategyHolders"),".")),(0,a.kt)("h3",{id:"fixed"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Fixed ",(0,a.kt)("inlineCode",{parentName:"li"},"CensusOrigin")," when election is using CSP census and anonymous."),(0,a.kt)("li",{parentName:"ul"},"Fixed bad generation of ",(0,a.kt)("inlineCode",{parentName:"li"},"dist")," bundles in previous version.")),(0,a.kt)("h2",{id:"074---2024-02-06"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.7.4"},"0.7.4")," - 2024-02-06"),(0,a.kt)("h3",{id:"added-1"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added new ",(0,a.kt)("inlineCode",{parentName:"li"},"CspProofType")," type when voting in a CSP based election to choose the encryption type.")),(0,a.kt)("h2",{id:"073---2024-01-23"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.7.3"},"0.7.3")," - 2024-01-23"),(0,a.kt)("h3",{id:"added-2"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added new ",(0,a.kt)("inlineCode",{parentName:"li"},"ApprovalElection")," election type for creating approval elections easily.")),(0,a.kt)("h3",{id:"fixed-1"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Fixed ",(0,a.kt)("inlineCode",{parentName:"li"},"costExponent")," to 1."),(0,a.kt)("li",{parentName:"ul"},"Fixed error when election has no metadata."),(0,a.kt)("li",{parentName:"ul"},"Fixed error with questions results for elections with no new type metadata.")),(0,a.kt)("h2",{id:"072---2024-01-17"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.7.2"},"0.7.2")," - 2024-01-17"),(0,a.kt)("h3",{id:"added-3"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added new ",(0,a.kt)("inlineCode",{parentName:"li"},"MultiChoiceElection")," election type for creating multi-choice elections easily."),(0,a.kt)("li",{parentName:"ul"},"Added new ",(0,a.kt)("inlineCode",{parentName:"li"},"BudgetElection")," election type for creating budget elections easily.")),(0,a.kt)("h3",{id:"fixed-2"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Results in published elections are now correctly returned for each type of election.")),(0,a.kt)("h2",{id:"071---2024-01-11"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.7.1"},"0.7.1")," - 2024-01-11"),(0,a.kt)("h3",{id:"changed"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Supported tokens from Census3 using ",(0,a.kt)("inlineCode",{parentName:"li"},"getSupportedTokens()")," returns now a token summary."),(0,a.kt)("li",{parentName:"ul"},"Census3 ",(0,a.kt)("inlineCode",{parentName:"li"},"getStrategyEstimation")," accepts ",(0,a.kt)("inlineCode",{parentName:"li"},"anonymous")," flag and returns ",(0,a.kt)("inlineCode",{parentName:"li"},"accuracy")," for anonymous censuses.")),(0,a.kt)("h3",{id:"fixed-3"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Removed ",(0,a.kt)("inlineCode",{parentName:"li"},"nullifier")," from vote package."),(0,a.kt)("li",{parentName:"ul"},"Returning census from type ",(0,a.kt)("inlineCode",{parentName:"li"},"CspCensus")," when election is for CSP.")),(0,a.kt)("h3",{id:"added-4"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"ArchivedAccountData")," for dealing with archived accounts and new ",(0,a.kt)("inlineCode",{parentName:"li"},"fetchAccount")," function in client."),(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"ErrFaucetAlreadyFunded")," for faucet limit requests."),(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"ErrElectionFinished")," for doing actions when election is finished."),(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"submitVoteSteps")," for voting using async generator steps.")),(0,a.kt)("h2",{id:"070---2023-12-13"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.7.0"},"0.7.0")," - 2023-12-13"),(0,a.kt)("h3",{id:"changed-1"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Changed sha256 library from ",(0,a.kt)("inlineCode",{parentName:"li"},"@ethersproject/sha2")," to ",(0,a.kt)("inlineCode",{parentName:"li"},"js-sha256")," for web workers."),(0,a.kt)("li",{parentName:"ul"},"Using API endpoint for estimating blocks from dates when creating an election."),(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," Census3 ",(0,a.kt)("inlineCode",{parentName:"li"},"getStrategySize")," function changed to ",(0,a.kt)("inlineCode",{parentName:"li"},"getStrategyEstimation")," giving estimated time and size for the given strategy.")),(0,a.kt)("h2",{id:"061---2023-11-29"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.6.1"},"0.6.1")," - 2023-11-29"),(0,a.kt)("h3",{id:"added-5"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"New anonymous function ",(0,a.kt)("inlineCode",{parentName:"li"},"hasRegisteredSIK")," for checking if a user has registered a SIK.")),(0,a.kt)("h3",{id:"fixed-4"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Removed outliers from block times for avoiding block estimation issues.")),(0,a.kt)("h2",{id:"060---2023-11-28"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.6.0"},"0.6.0")," - 2023-11-28"),(0,a.kt)("h3",{id:"added-6"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"New election service functions ",(0,a.kt)("inlineCode",{parentName:"li"},"nextElectionId")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"getElectionSalt"),".")),(0,a.kt)("h3",{id:"changed-2"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," Refactored options for ",(0,a.kt)("inlineCode",{parentName:"li"},"isInCensus"),", ",(0,a.kt)("inlineCode",{parentName:"li"},"hasAlreadyVoted"),", ",(0,a.kt)("inlineCode",{parentName:"li"},"isAbleToVote")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"votesLeftCount"),"."),(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," New options for ",(0,a.kt)("inlineCode",{parentName:"li"},"AnonymousVote")," which enable to add the user's signature."),(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," New internal anonymous flow when signature is given by the consumer.")),(0,a.kt)("h2",{id:"053---2023-11-28"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.5.3"},"0.5.3")," - 2023-11-28"),(0,a.kt)("h3",{id:"added-7"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"New account methods supported for listing, counting and checking account transfers in ",(0,a.kt)("inlineCode",{parentName:"li"},"AccountAPI"),".")),(0,a.kt)("h3",{id:"fixed-5"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Archived elections without census URI are now accepted.")),(0,a.kt)("h3",{id:"changed-3"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Faucet options don't require ",(0,a.kt)("inlineCode",{parentName:"li"},"token_limit")," anymore.")),(0,a.kt)("h2",{id:"052---2023-11-16"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.5.2"},"0.5.2")," - 2023-11-16"),(0,a.kt)("h3",{id:"fixed-6"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Anonymous vote packages are no longer signed.")),(0,a.kt)("h2",{id:"051---2023-11-15"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.5.1"},"0.5.1")," - 2023-11-15"),(0,a.kt)("h3",{id:"fixed-7"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Missing exported election type ",(0,a.kt)("inlineCode",{parentName:"li"},"ArchivedElection"),"."),(0,a.kt)("li",{parentName:"ul"},"Faucet errors correctly shown with message.")),(0,a.kt)("h2",{id:"050---2023-11-14"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.5.0"},"0.5.0")," - 2023-11-14"),(0,a.kt)("h3",{id:"changed-4"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," New full integration for Census3 v2, using tokens, strategies and censuses.")),(0,a.kt)("h2",{id:"043---2023-11-09"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.4.3"},"0.4.3")," - 2023-11-09"),(0,a.kt)("h3",{id:"added-8"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Support for archived elections with new election type ",(0,a.kt)("inlineCode",{parentName:"li"},"ArchivedElection")," and with new census with type ",(0,a.kt)("inlineCode",{parentName:"li"},"ArchivedCensus"),".")),(0,a.kt)("h2",{id:"042---2023-11-06"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.4.2"},"0.4.2")," - 2023-11-06"),(0,a.kt)("h3",{id:"changed-5"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Removed faucet path from default URLs."),(0,a.kt)("li",{parentName:"ul"},"Updated ",(0,a.kt)("inlineCode",{parentName:"li"},"@vocdoni/proto")," dependency to ",(0,a.kt)("inlineCode",{parentName:"li"},"1.15.4"),".")),(0,a.kt)("h3",{id:"added-9"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Import, export and delete census functionality in census service."),(0,a.kt)("li",{parentName:"ul"},"Added new election parameter ",(0,a.kt)("inlineCode",{parentName:"li"},"temporarySecretIdentity")," for deleting temporary SIKs once election is finished.")),(0,a.kt)("h3",{id:"fixed-8"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Fixed ",(0,a.kt)("inlineCode",{parentName:"li"},"ffjavascript")," dependency to ",(0,a.kt)("inlineCode",{parentName:"li"},"0.2.59"),".")),(0,a.kt)("h2",{id:"041---2023-10-24"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.4.1"},"0.4.1")," - 2023-10-24"),(0,a.kt)("h3",{id:"changed-6"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Modified ",(0,a.kt)("inlineCode",{parentName:"li"},"dev"),", ",(0,a.kt)("inlineCode",{parentName:"li"},"stg")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"prod")," default URLs for all services."),(0,a.kt)("li",{parentName:"ul"},"Upgraded to new faucet.")),(0,a.kt)("h2",{id:"040---2023-10-10"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.4.0"},"0.4.0")," - 2023-10-10"),(0,a.kt)("h3",{id:"changed-7"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," New signatures for chain transactions.")),(0,a.kt)("h2",{id:"032---2023-10-10"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.3.2"},"0.3.2")," - 2023-10-10"),(0,a.kt)("h3",{id:"added-10"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added support for uploading big censuses in chunks.")),(0,a.kt)("h3",{id:"fixed-9"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"assert")," as embedded in rollup configuration.")),(0,a.kt)("h2",{id:"031---2023-09-20"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.3.1"},"0.3.1")," - 2023-09-20"),(0,a.kt)("h3",{id:"added-11"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"New ",(0,a.kt)("inlineCode",{parentName:"li"},"createElectionSteps")," function in client for using async generators and control creation flow."),(0,a.kt)("li",{parentName:"ul"},"New ",(0,a.kt)("inlineCode",{parentName:"li"},"sendTokens")," function in client for transferring tokens between accounts.")),(0,a.kt)("h3",{id:"changed-8"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"New user-friendly text for SIK payload signing.")),(0,a.kt)("h3",{id:"fixed-10"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"ethers")," as embedded in rollup configuration for ",(0,a.kt)("inlineCode",{parentName:"li"},"circomlibjs")," dependencies.")),(0,a.kt)("h2",{id:"030---2023-09-13"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.3.0"},"0.3.0")," - 2023-09-13"),(0,a.kt)("h3",{id:"fixed-11"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Ensuring proof ",(0,a.kt)("inlineCode",{parentName:"li"},"value")," handled as hex for anonymous circuits inputs.")),(0,a.kt)("h3",{id:"changed-9"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," Removed some (probably not used) client properties for future refactor."),(0,a.kt)("li",{parentName:"ul"},"Added services as mid-layer between pure SDK client and API wrappers.")),(0,a.kt)("h3",{id:"added-12"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Census3 supported chains information.")),(0,a.kt)("h2",{id:"020---2023-09-04"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.2.0"},"0.2.0")," - 2023-09-04"),(0,a.kt)("h3",{id:"fixed-12"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"dotobject")," helper returns null when key is not found.")),(0,a.kt)("h3",{id:"changed-10"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"collectFaucetTokens")," function accepts raw faucet package payload.")),(0,a.kt)("h3",{id:"added-13"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Census3 error typings."),(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," Census3 anonymous censuses.")),(0,a.kt)("h2",{id:"011---2023-08-14"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.1.1"},"0.1.1")," - 2023-08-14"),(0,a.kt)("h3",{id:"fixed-13"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added missing dependency ",(0,a.kt)("inlineCode",{parentName:"li"},"readable-stream"),".")),(0,a.kt)("h2",{id:"010---2023-08-11"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.1.0"},"0.1.0")," - 2023-08-11"),(0,a.kt)("h3",{id:"added-14"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," Anonymous integration")),(0,a.kt)("h3",{id:"fixed-14"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added missing ",(0,a.kt)("inlineCode",{parentName:"li"},"maxCensusSize")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"manuallyEnded")," in ",(0,a.kt)("inlineCode",{parentName:"li"},"fetchElection"),".")),(0,a.kt)("h2",{id:"0018---2023-08-01"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.18"},"0.0.18")," - 2023-08-01"),(0,a.kt)("h3",{id:"added-15"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Election ",(0,a.kt)("inlineCode",{parentName:"li"},"get")," function to fetch metadata values using ",(0,a.kt)("inlineCode",{parentName:"li"},"dotobject"))),(0,a.kt)("h3",{id:"fixed-15"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added missing dependencies")),(0,a.kt)("h2",{id:"0017---2023-07-21"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.17"},"0.0.17")," - 2023-07-21"),(0,a.kt)("h3",{id:"added-16"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Anonymous support using zkSNARK.")),(0,a.kt)("h3",{id:"changed-11"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Election ",(0,a.kt)("inlineCode",{parentName:"li"},"meta")," field has a more lax typing.")),(0,a.kt)("h2",{id:"0016---2023-07-04"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.16"},"0.0.16")," - 2023-07-04"),(0,a.kt)("h3",{id:"added-17"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"SDK version added to election metadata."),(0,a.kt)("li",{parentName:"ul"},"Added new function ",(0,a.kt)("inlineCode",{parentName:"li"},"changeElectionCensus")," to change the election census dynamically."),(0,a.kt)("li",{parentName:"ul"},"Added new helper function ",(0,a.kt)("inlineCode",{parentName:"li"},"formatUnits")," for formatting big decimals values.")),(0,a.kt)("h3",{id:"changed-12"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"New types defined in ",(0,a.kt)("inlineCode",{parentName:"li"},"VocdoniCensus3Client")," with some additional documentation."),(0,a.kt)("li",{parentName:"ul"},"Added new field ",(0,a.kt)("inlineCode",{parentName:"li"},"symbol")," to summary token list in Census3."),(0,a.kt)("li",{parentName:"ul"},"Added new field ",(0,a.kt)("inlineCode",{parentName:"li"},"size")," to token information in Census3 as number of token holders.")),(0,a.kt)("h3",{id:"fixed-16"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Error codes coming from the API.")),(0,a.kt)("h2",{id:"0015---2023-06-20"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.15"},"0.0.15")," - 2023-06-20"),(0,a.kt)("h3",{id:"added-18"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"New ",(0,a.kt)("inlineCode",{parentName:"li"},"InvalidElection")," type for invalid elections."),(0,a.kt)("li",{parentName:"ul"},"New ",(0,a.kt)("inlineCode",{parentName:"li"},"estimateElectionCost")," function in client for estimating election cost."),(0,a.kt)("li",{parentName:"ul"},"New ",(0,a.kt)("inlineCode",{parentName:"li"},"calculateElectionCost")," function in client for calculating the exact election cost."),(0,a.kt)("li",{parentName:"ul"},"New API wrappers for general chain information.")),(0,a.kt)("h3",{id:"changed-13"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"fetchElections")," returns new ",(0,a.kt)("inlineCode",{parentName:"li"},"InvalidElection")," type instead of throwing.")),(0,a.kt)("h3",{id:"fixed-17"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"CSP elections use the URI and public key from the election census defined at creation.")),(0,a.kt)("h2",{id:"0014---2023-06-12"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.14"},"0.0.14")," - 2023-06-12"),(0,a.kt)("h3",{id:"added-19"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"maxValue"),", ",(0,a.kt)("inlineCode",{parentName:"li"},"maxCount")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"maxTotalCost")," properties in ",(0,a.kt)("inlineCode",{parentName:"li"},"IVoteType")," in an election for creating\nquadratic, approval and ranked elections.")),(0,a.kt)("h2",{id:"0013---2023-06-06"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.13"},"0.0.13")," - 2023-06-06"),(0,a.kt)("h3",{id:"added-20"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/census3/"},"Census3")," integration"),(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"meta")," parameters to election metadata"),(0,a.kt)("li",{parentName:"ul"},"Minor helper functions")),(0,a.kt)("h3",{id:"changed-14"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added some new information to API endpoints")),(0,a.kt)("h3",{id:"fixed-18"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Unlocked rollup version")),(0,a.kt)("h2",{id:"0012---2023-05-09"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.12"},"0.0.12")," - 2023-05-09"),(0,a.kt)("h3",{id:"fixed-19"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Fixed ",(0,a.kt)("inlineCode",{parentName:"li"},"personal_sign")," provider call bug for certain environments")),(0,a.kt)("h2",{id:"0011---2023-04-25"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.11"},"0.0.11")," - 2023-04-25"),(0,a.kt)("h3",{id:"fixed-20"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Fix type error in ",(0,a.kt)("inlineCode",{parentName:"li"},"fetchAccountInfo"))),(0,a.kt)("h2",{id:"0010---2023-04-25"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.10"},"0.0.10")," - 2023-04-25"),(0,a.kt)("h3",{id:"fixed-21"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Fixed internal ",(0,a.kt)("inlineCode",{parentName:"li"},"SetAccountTx")," nonce when creating transactions")),(0,a.kt)("h2",{id:"009---2023-04-25"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.9"},"0.0.9")," - 2023-04-25"),(0,a.kt)("h3",{id:"added-21"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"generateRandomWallet")," function for assigning a random Wallet to the client")),(0,a.kt)("h3",{id:"changed-15"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"isInCensus")," doesn't accept census type because censuses with public keys are removed"),(0,a.kt)("li",{parentName:"ul"},"Refactored account methods to return new ",(0,a.kt)("inlineCode",{parentName:"li"},"AccountData")," definition with ",(0,a.kt)("inlineCode",{parentName:"li"},"Account")," field")),(0,a.kt)("h3",{id:"removed"},"Removed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Ability to create censuses using public keys")),(0,a.kt)("h2",{id:"008---2023-04-05"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.8"},"0.0.8")," - 2023-04-05"),(0,a.kt)("h3",{id:"added-22"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Custom error handling (WIP)")),(0,a.kt)("h3",{id:"changed-16"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"votesLeftCount")," checks if user is in census."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"hasAlreadyVoted()")," returns the vote id or null if the account hasn't voted.")),(0,a.kt)("h3",{id:"fixed-22"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Increased time for transaction confirmation due to block time increase.")),(0,a.kt)("h2",{id:"007---2023-03-29"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.7"},"0.0.7")," - 2023-03-29"),(0,a.kt)("h3",{id:"changed-17"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Updated ",(0,a.kt)("inlineCode",{parentName:"li"},"vocdoni/proto")," library to version ",(0,a.kt)("inlineCode",{parentName:"li"},"1.14.1"),"."),(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"maxCensusSize")," to the election creation.")),(0,a.kt)("h2",{id:"006---2023-03-22"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.6"},"0.0.6")," - 2023-03-22"),(0,a.kt)("h3",{id:"changed-18"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"ElectionStatus")," includes new values ",(0,a.kt)("inlineCode",{parentName:"li"},"ONGOING")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"UPCOMING"),". ",(0,a.kt)("inlineCode",{parentName:"li"},"READY")," is removed an only used internally."),(0,a.kt)("li",{parentName:"ul"},"Election description changed from mandatory to optional."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"fetchElections")," accepts no account and returns all elections in the chain."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"fetchAccountInfo")," accepts arbitrary account to retrieve information.")),(0,a.kt)("h2",{id:"005---2023-03-08"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.5"},"0.0.5")," - 2023-03-08"),(0,a.kt)("h3",{id:"added-23"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"fetchElections")," function to fetch all elections based on a given account"),(0,a.kt)("li",{parentName:"ul"},"New ",(0,a.kt)("inlineCode",{parentName:"li"},"organizationId")," property in ",(0,a.kt)("inlineCode",{parentName:"li"},"PublishedElection"))),(0,a.kt)("h3",{id:"changed-19"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"PublishedCensus")," has ",(0,a.kt)("inlineCode",{parentName:"li"},"size")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"weight")," fields for offchain census.")),(0,a.kt)("h2",{id:"004-alpha---2023-03-01"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.4-alpha"},"0.0.4-alpha")," - 2023-03-01"),(0,a.kt)("h3",{id:"added-24"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Credential service provider integrated"),(0,a.kt)("li",{parentName:"ul"},"Custom retry attempts and time for transactions waiting functionality"),(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"votesLeftCount")," function for checking how many times a user can submit a vote"),(0,a.kt)("li",{parentName:"ul"},"New API requests added for chain information")),(0,a.kt)("h3",{id:"changed-20"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"header")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"streamUri")," are no longer mandatory when creating an election.")),(0,a.kt)("h3",{id:"fixed-23"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"No more 400 error status HTTP requests when asking for a non-confirmed transaction"),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"maxValue")," property fixed in election data")),(0,a.kt)("h2",{id:"003-alpha---2023-01-31"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.3-alpha"},"0.0.3-alpha")," - 2023-01-31"),(0,a.kt)("h3",{id:"added-25"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Functionality to check if a user is in census ",(0,a.kt)("inlineCode",{parentName:"li"},"isInCensus")),(0,a.kt)("li",{parentName:"ul"},"Functionality to check if a user has already voted ",(0,a.kt)("inlineCode",{parentName:"li"},"hasAlreadyVoted")),(0,a.kt)("li",{parentName:"ul"},"Functionality to check if a user is able to vote ",(0,a.kt)("inlineCode",{parentName:"li"},"isAbleToVote")),(0,a.kt)("li",{parentName:"ul"},"Export UMD version via ",(0,a.kt)("inlineCode",{parentName:"li"},"@vocdoni/sdk/umd")),(0,a.kt)("li",{parentName:"ul"},"Deterministic Wallet generation from arbitrary data")),(0,a.kt)("h3",{id:"fixed-24"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Return ",(0,a.kt)("inlineCode",{parentName:"li"},"voteId")," when submitting vote instead of the transaction hash."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"Buffer")," imports for bundle"),(0,a.kt)("li",{parentName:"ul"},"Bundling & export issues")),(0,a.kt)("h3",{id:"changed-21"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Removed ",(0,a.kt)("inlineCode",{parentName:"li"},"dvote-solidity")," dependency.")),(0,a.kt)("h2",{id:"002-alpha---2022-12-20"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.2-alpha"},"0.0.2-alpha")," - 2022-12-20"),(0,a.kt)("h3",{id:"added-26"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Staging environment options for API and Faucet"),(0,a.kt)("li",{parentName:"ul"},"Functionality to end, pause, cancel and continue an election")),(0,a.kt)("h3",{id:"fixed-25"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Fixed proof check using public key when signer is from type ",(0,a.kt)("inlineCode",{parentName:"li"},"Wallet"))),(0,a.kt)("h3",{id:"changed-22"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Use voting endpoint instead of generic submitTx."),(0,a.kt)("li",{parentName:"ul"},"Naming for client initialization options changed."),(0,a.kt)("li",{parentName:"ul"},"There are now the new ",(0,a.kt)("inlineCode",{parentName:"li"},"UnpublishedElection")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"PublishedElection")," classes\nwhich extend from the abstract ",(0,a.kt)("inlineCode",{parentName:"li"},"Election")," class."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"fetchElection")," accepts an election id.")),(0,a.kt)("h2",{id:"001-alpha---2022-12-01"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.1-alpha"},"0.0.1-alpha")," - 2022-12-01"),(0,a.kt)("h3",{id:"added-27"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"First unstable version of the SDK for testing purposes")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/fe9260cd.f9537a27.js b/assets/js/fe9260cd.f9537a27.js deleted file mode 100644 index fc966d92b..000000000 --- a/assets/js/fe9260cd.f9537a27.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[1132],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>p});var i=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function d(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var r=i.createContext({}),u=function(e){var t=i.useContext(r),n=t;return e&&(n="function"==typeof e?e(t):d(d({},t),e)),n},s=function(e){var t=u(e.components);return i.createElement(r.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,r=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),k=u(n),p=a,h=k["".concat(r,".").concat(p)]||k[p]||c[p]||l;return n?i.createElement(h,d(d({ref:t},s),{},{components:n})):i.createElement(h,d({ref:t},s))}));function p(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,d=new Array(l);d[0]=k;var o={};for(var r in t)hasOwnProperty.call(t,r)&&(o[r]=t[r]);o.originalType=e,o.mdxType="string"==typeof e?e:a,d[1]=o;for(var u=2;u{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>d,default:()=>c,frontMatter:()=>l,metadata:()=>o,toc:()=>u});var i=n(87462),a=(n(67294),n(3905));const l={},d="Changelog",o={unversionedId:"sdk/reference/changelog",id:"sdk/reference/changelog",title:"Changelog",description:"All notable changes to this project will be documented in this file.",source:"@site/docs/sdk/reference/changelog.md",sourceDirName:"sdk/reference",slug:"/sdk/reference/changelog",permalink:"/sdk/reference/changelog",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"SDK Integration Details",permalink:"/sdk/integration-details"},next:{title:"Account",permalink:"/sdk/reference/classes/Account"}},r={},u=[{value:"0.7.5 - 2024-02-15",id:"075---2024-02-15",level:2},{value:"Added",id:"added",level:3},{value:"Fixed",id:"fixed",level:3},{value:"0.7.4 - 2024-02-06",id:"074---2024-02-06",level:2},{value:"Added",id:"added-1",level:3},{value:"0.7.3 - 2024-01-23",id:"073---2024-01-23",level:2},{value:"Added",id:"added-2",level:3},{value:"Fixed",id:"fixed-1",level:3},{value:"0.7.2 - 2024-01-17",id:"072---2024-01-17",level:2},{value:"Added",id:"added-3",level:3},{value:"Fixed",id:"fixed-2",level:3},{value:"0.7.1 - 2024-01-11",id:"071---2024-01-11",level:2},{value:"Changed",id:"changed",level:3},{value:"Fixed",id:"fixed-3",level:3},{value:"Added",id:"added-4",level:3},{value:"0.7.0 - 2023-12-13",id:"070---2023-12-13",level:2},{value:"Changed",id:"changed-1",level:3},{value:"0.6.1 - 2023-11-29",id:"061---2023-11-29",level:2},{value:"Added",id:"added-5",level:3},{value:"Fixed",id:"fixed-4",level:3},{value:"0.6.0 - 2023-11-28",id:"060---2023-11-28",level:2},{value:"Added",id:"added-6",level:3},{value:"Changed",id:"changed-2",level:3},{value:"0.5.3 - 2023-11-28",id:"053---2023-11-28",level:2},{value:"Added",id:"added-7",level:3},{value:"Fixed",id:"fixed-5",level:3},{value:"Changed",id:"changed-3",level:3},{value:"0.5.2 - 2023-11-16",id:"052---2023-11-16",level:2},{value:"Fixed",id:"fixed-6",level:3},{value:"0.5.1 - 2023-11-15",id:"051---2023-11-15",level:2},{value:"Fixed",id:"fixed-7",level:3},{value:"0.5.0 - 2023-11-14",id:"050---2023-11-14",level:2},{value:"Changed",id:"changed-4",level:3},{value:"0.4.3 - 2023-11-09",id:"043---2023-11-09",level:2},{value:"Added",id:"added-8",level:3},{value:"0.4.2 - 2023-11-06",id:"042---2023-11-06",level:2},{value:"Changed",id:"changed-5",level:3},{value:"Added",id:"added-9",level:3},{value:"Fixed",id:"fixed-8",level:3},{value:"0.4.1 - 2023-10-24",id:"041---2023-10-24",level:2},{value:"Changed",id:"changed-6",level:3},{value:"0.4.0 - 2023-10-10",id:"040---2023-10-10",level:2},{value:"Changed",id:"changed-7",level:3},{value:"0.3.2 - 2023-10-10",id:"032---2023-10-10",level:2},{value:"Added",id:"added-10",level:3},{value:"Fixed",id:"fixed-9",level:3},{value:"0.3.1 - 2023-09-20",id:"031---2023-09-20",level:2},{value:"Added",id:"added-11",level:3},{value:"Changed",id:"changed-8",level:3},{value:"Fixed",id:"fixed-10",level:3},{value:"0.3.0 - 2023-09-13",id:"030---2023-09-13",level:2},{value:"Fixed",id:"fixed-11",level:3},{value:"Changed",id:"changed-9",level:3},{value:"Added",id:"added-12",level:3},{value:"0.2.0 - 2023-09-04",id:"020---2023-09-04",level:2},{value:"Fixed",id:"fixed-12",level:3},{value:"Changed",id:"changed-10",level:3},{value:"Added",id:"added-13",level:3},{value:"0.1.1 - 2023-08-14",id:"011---2023-08-14",level:2},{value:"Fixed",id:"fixed-13",level:3},{value:"0.1.0 - 2023-08-11",id:"010---2023-08-11",level:2},{value:"Added",id:"added-14",level:3},{value:"Fixed",id:"fixed-14",level:3},{value:"0.0.18 - 2023-08-01",id:"0018---2023-08-01",level:2},{value:"Added",id:"added-15",level:3},{value:"Fixed",id:"fixed-15",level:3},{value:"0.0.17 - 2023-07-21",id:"0017---2023-07-21",level:2},{value:"Added",id:"added-16",level:3},{value:"Changed",id:"changed-11",level:3},{value:"0.0.16 - 2023-07-04",id:"0016---2023-07-04",level:2},{value:"Added",id:"added-17",level:3},{value:"Changed",id:"changed-12",level:3},{value:"Fixed",id:"fixed-16",level:3},{value:"0.0.15 - 2023-06-20",id:"0015---2023-06-20",level:2},{value:"Added",id:"added-18",level:3},{value:"Changed",id:"changed-13",level:3},{value:"Fixed",id:"fixed-17",level:3},{value:"0.0.14 - 2023-06-12",id:"0014---2023-06-12",level:2},{value:"Added",id:"added-19",level:3},{value:"0.0.13 - 2023-06-06",id:"0013---2023-06-06",level:2},{value:"Added",id:"added-20",level:3},{value:"Changed",id:"changed-14",level:3},{value:"Fixed",id:"fixed-18",level:3},{value:"0.0.12 - 2023-05-09",id:"0012---2023-05-09",level:2},{value:"Fixed",id:"fixed-19",level:3},{value:"0.0.11 - 2023-04-25",id:"0011---2023-04-25",level:2},{value:"Fixed",id:"fixed-20",level:3},{value:"0.0.10 - 2023-04-25",id:"0010---2023-04-25",level:2},{value:"Fixed",id:"fixed-21",level:3},{value:"0.0.9 - 2023-04-25",id:"009---2023-04-25",level:2},{value:"Added",id:"added-21",level:3},{value:"Changed",id:"changed-15",level:3},{value:"Removed",id:"removed",level:3},{value:"0.0.8 - 2023-04-05",id:"008---2023-04-05",level:2},{value:"Added",id:"added-22",level:3},{value:"Changed",id:"changed-16",level:3},{value:"Fixed",id:"fixed-22",level:3},{value:"0.0.7 - 2023-03-29",id:"007---2023-03-29",level:2},{value:"Changed",id:"changed-17",level:3},{value:"0.0.6 - 2023-03-22",id:"006---2023-03-22",level:2},{value:"Changed",id:"changed-18",level:3},{value:"0.0.5 - 2023-03-08",id:"005---2023-03-08",level:2},{value:"Added",id:"added-23",level:3},{value:"Changed",id:"changed-19",level:3},{value:"0.0.4-alpha - 2023-03-01",id:"004-alpha---2023-03-01",level:2},{value:"Added",id:"added-24",level:3},{value:"Changed",id:"changed-20",level:3},{value:"Fixed",id:"fixed-23",level:3},{value:"0.0.3-alpha - 2023-01-31",id:"003-alpha---2023-01-31",level:2},{value:"Added",id:"added-25",level:3},{value:"Fixed",id:"fixed-24",level:3},{value:"Changed",id:"changed-21",level:3},{value:"0.0.2-alpha - 2022-12-20",id:"002-alpha---2022-12-20",level:2},{value:"Added",id:"added-26",level:3},{value:"Fixed",id:"fixed-25",level:3},{value:"Changed",id:"changed-22",level:3},{value:"0.0.1-alpha - 2022-12-01",id:"001-alpha---2022-12-01",level:2},{value:"Added",id:"added-27",level:3}],s={toc:u};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"changelog"},"Changelog"),(0,a.kt)("p",null,"All notable changes to this project will be documented in this file."),(0,a.kt)("p",null,"The format is based on ",(0,a.kt)("a",{parentName:"p",href:"https://keepachangelog.com/en/1.0.0/"},"Keep a Changelog"),",\nand this project adheres to ",(0,a.kt)("a",{parentName:"p",href:"https://semver.org/spec/v2.0.0.html"},"Semantic Versioning"),"."),(0,a.kt)("h2",{id:"075---2024-02-15"},"[0.7.5]"," - 2024-02-15"),(0,a.kt)("h3",{id:"added"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added support for getting token holder balance in Census3 using ",(0,a.kt)("inlineCode",{parentName:"li"},"tokenHolderBalance"),"."),(0,a.kt)("li",{parentName:"ul"},"Added support for getting token holders based on strategy using ",(0,a.kt)("inlineCode",{parentName:"li"},"getStrategyHolders"),".")),(0,a.kt)("h3",{id:"fixed"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Fixed ",(0,a.kt)("inlineCode",{parentName:"li"},"CensusOrigin")," when election is using CSP census and anonymous."),(0,a.kt)("li",{parentName:"ul"},"Fixed bad generation of ",(0,a.kt)("inlineCode",{parentName:"li"},"dist")," bundles in previous version.")),(0,a.kt)("h2",{id:"074---2024-02-06"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.7.4"},"0.7.4")," - 2024-02-06"),(0,a.kt)("h3",{id:"added-1"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added new ",(0,a.kt)("inlineCode",{parentName:"li"},"CspProofType")," type when voting in a CSP based election to choose the encryption type.")),(0,a.kt)("h2",{id:"073---2024-01-23"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.7.3"},"0.7.3")," - 2024-01-23"),(0,a.kt)("h3",{id:"added-2"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added new ",(0,a.kt)("inlineCode",{parentName:"li"},"ApprovalElection")," election type for creating approval elections easily.")),(0,a.kt)("h3",{id:"fixed-1"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Fixed ",(0,a.kt)("inlineCode",{parentName:"li"},"costExponent")," to 1."),(0,a.kt)("li",{parentName:"ul"},"Fixed error when election has no metadata."),(0,a.kt)("li",{parentName:"ul"},"Fixed error with questions results for elections with no new type metadata.")),(0,a.kt)("h2",{id:"072---2024-01-17"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.7.2"},"0.7.2")," - 2024-01-17"),(0,a.kt)("h3",{id:"added-3"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added new ",(0,a.kt)("inlineCode",{parentName:"li"},"MultiChoiceElection")," election type for creating multi-choice elections easily."),(0,a.kt)("li",{parentName:"ul"},"Added new ",(0,a.kt)("inlineCode",{parentName:"li"},"BudgetElection")," election type for creating budget elections easily.")),(0,a.kt)("h3",{id:"fixed-2"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Results in published elections are now correctly returned for each type of election.")),(0,a.kt)("h2",{id:"071---2024-01-11"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.7.1"},"0.7.1")," - 2024-01-11"),(0,a.kt)("h3",{id:"changed"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Supported tokens from Census3 using ",(0,a.kt)("inlineCode",{parentName:"li"},"getSupportedTokens()")," returns now a token summary."),(0,a.kt)("li",{parentName:"ul"},"Census3 ",(0,a.kt)("inlineCode",{parentName:"li"},"getStrategyEstimation")," accepts ",(0,a.kt)("inlineCode",{parentName:"li"},"anonymous")," flag and returns ",(0,a.kt)("inlineCode",{parentName:"li"},"accuracy")," for anonymous censuses.")),(0,a.kt)("h3",{id:"fixed-3"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Removed ",(0,a.kt)("inlineCode",{parentName:"li"},"nullifier")," from vote package."),(0,a.kt)("li",{parentName:"ul"},"Returning census from type ",(0,a.kt)("inlineCode",{parentName:"li"},"CspCensus")," when election is for CSP.")),(0,a.kt)("h3",{id:"added-4"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"ArchivedAccountData")," for dealing with archived accounts and new ",(0,a.kt)("inlineCode",{parentName:"li"},"fetchAccount")," function in client."),(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"ErrFaucetAlreadyFunded")," for faucet limit requests."),(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"ErrElectionFinished")," for doing actions when election is finished."),(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"submitVoteSteps")," for voting using async generator steps.")),(0,a.kt)("h2",{id:"070---2023-12-13"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.7.0"},"0.7.0")," - 2023-12-13"),(0,a.kt)("h3",{id:"changed-1"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Changed sha256 library from ",(0,a.kt)("inlineCode",{parentName:"li"},"@ethersproject/sha2")," to ",(0,a.kt)("inlineCode",{parentName:"li"},"js-sha256")," for web workers."),(0,a.kt)("li",{parentName:"ul"},"Using API endpoint for estimating blocks from dates when creating an election."),(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," Census3 ",(0,a.kt)("inlineCode",{parentName:"li"},"getStrategySize")," function changed to ",(0,a.kt)("inlineCode",{parentName:"li"},"getStrategyEstimation")," giving estimated time and size for the given strategy.")),(0,a.kt)("h2",{id:"061---2023-11-29"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.6.1"},"0.6.1")," - 2023-11-29"),(0,a.kt)("h3",{id:"added-5"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"New anonymous function ",(0,a.kt)("inlineCode",{parentName:"li"},"hasRegisteredSIK")," for checking if a user has registered a SIK.")),(0,a.kt)("h3",{id:"fixed-4"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Removed outliers from block times for avoiding block estimation issues.")),(0,a.kt)("h2",{id:"060---2023-11-28"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.6.0"},"0.6.0")," - 2023-11-28"),(0,a.kt)("h3",{id:"added-6"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"New election service functions ",(0,a.kt)("inlineCode",{parentName:"li"},"nextElectionId")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"getElectionSalt"),".")),(0,a.kt)("h3",{id:"changed-2"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," Refactored options for ",(0,a.kt)("inlineCode",{parentName:"li"},"isInCensus"),", ",(0,a.kt)("inlineCode",{parentName:"li"},"hasAlreadyVoted"),", ",(0,a.kt)("inlineCode",{parentName:"li"},"isAbleToVote")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"votesLeftCount"),"."),(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," New options for ",(0,a.kt)("inlineCode",{parentName:"li"},"AnonymousVote")," which enable to add the user's signature."),(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," New internal anonymous flow when signature is given by the consumer.")),(0,a.kt)("h2",{id:"053---2023-11-28"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.5.3"},"0.5.3")," - 2023-11-28"),(0,a.kt)("h3",{id:"added-7"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"New account methods supported for listing, counting and checking account transfers in ",(0,a.kt)("inlineCode",{parentName:"li"},"AccountAPI"),".")),(0,a.kt)("h3",{id:"fixed-5"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Archived elections without census URI are now accepted.")),(0,a.kt)("h3",{id:"changed-3"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Faucet options don't require ",(0,a.kt)("inlineCode",{parentName:"li"},"token_limit")," anymore.")),(0,a.kt)("h2",{id:"052---2023-11-16"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.5.2"},"0.5.2")," - 2023-11-16"),(0,a.kt)("h3",{id:"fixed-6"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Anonymous vote packages are no longer signed.")),(0,a.kt)("h2",{id:"051---2023-11-15"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.5.1"},"0.5.1")," - 2023-11-15"),(0,a.kt)("h3",{id:"fixed-7"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Missing exported election type ",(0,a.kt)("inlineCode",{parentName:"li"},"ArchivedElection"),"."),(0,a.kt)("li",{parentName:"ul"},"Faucet errors correctly shown with message.")),(0,a.kt)("h2",{id:"050---2023-11-14"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.5.0"},"0.5.0")," - 2023-11-14"),(0,a.kt)("h3",{id:"changed-4"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," New full integration for Census3 v2, using tokens, strategies and censuses.")),(0,a.kt)("h2",{id:"043---2023-11-09"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.4.3"},"0.4.3")," - 2023-11-09"),(0,a.kt)("h3",{id:"added-8"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Support for archived elections with new election type ",(0,a.kt)("inlineCode",{parentName:"li"},"ArchivedElection")," and with new census with type ",(0,a.kt)("inlineCode",{parentName:"li"},"ArchivedCensus"),".")),(0,a.kt)("h2",{id:"042---2023-11-06"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.4.2"},"0.4.2")," - 2023-11-06"),(0,a.kt)("h3",{id:"changed-5"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Removed faucet path from default URLs."),(0,a.kt)("li",{parentName:"ul"},"Updated ",(0,a.kt)("inlineCode",{parentName:"li"},"@vocdoni/proto")," dependency to ",(0,a.kt)("inlineCode",{parentName:"li"},"1.15.4"),".")),(0,a.kt)("h3",{id:"added-9"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Import, export and delete census functionality in census service."),(0,a.kt)("li",{parentName:"ul"},"Added new election parameter ",(0,a.kt)("inlineCode",{parentName:"li"},"temporarySecretIdentity")," for deleting temporary SIKs once election is finished.")),(0,a.kt)("h3",{id:"fixed-8"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Fixed ",(0,a.kt)("inlineCode",{parentName:"li"},"ffjavascript")," dependency to ",(0,a.kt)("inlineCode",{parentName:"li"},"0.2.59"),".")),(0,a.kt)("h2",{id:"041---2023-10-24"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.4.1"},"0.4.1")," - 2023-10-24"),(0,a.kt)("h3",{id:"changed-6"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Modified ",(0,a.kt)("inlineCode",{parentName:"li"},"dev"),", ",(0,a.kt)("inlineCode",{parentName:"li"},"stg")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"prod")," default URLs for all services."),(0,a.kt)("li",{parentName:"ul"},"Upgraded to new faucet.")),(0,a.kt)("h2",{id:"040---2023-10-10"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.4.0"},"0.4.0")," - 2023-10-10"),(0,a.kt)("h3",{id:"changed-7"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," New signatures for chain transactions.")),(0,a.kt)("h2",{id:"032---2023-10-10"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.3.2"},"0.3.2")," - 2023-10-10"),(0,a.kt)("h3",{id:"added-10"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added support for uploading big censuses in chunks.")),(0,a.kt)("h3",{id:"fixed-9"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"assert")," as embedded in rollup configuration.")),(0,a.kt)("h2",{id:"031---2023-09-20"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.3.1"},"0.3.1")," - 2023-09-20"),(0,a.kt)("h3",{id:"added-11"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"New ",(0,a.kt)("inlineCode",{parentName:"li"},"createElectionSteps")," function in client for using async generators and control creation flow."),(0,a.kt)("li",{parentName:"ul"},"New ",(0,a.kt)("inlineCode",{parentName:"li"},"sendTokens")," function in client for transferring tokens between accounts.")),(0,a.kt)("h3",{id:"changed-8"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"New user-friendly text for SIK payload signing.")),(0,a.kt)("h3",{id:"fixed-10"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"ethers")," as embedded in rollup configuration for ",(0,a.kt)("inlineCode",{parentName:"li"},"circomlibjs")," dependencies.")),(0,a.kt)("h2",{id:"030---2023-09-13"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.3.0"},"0.3.0")," - 2023-09-13"),(0,a.kt)("h3",{id:"fixed-11"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Ensuring proof ",(0,a.kt)("inlineCode",{parentName:"li"},"value")," handled as hex for anonymous circuits inputs.")),(0,a.kt)("h3",{id:"changed-9"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," Removed some (probably not used) client properties for future refactor."),(0,a.kt)("li",{parentName:"ul"},"Added services as mid-layer between pure SDK client and API wrappers.")),(0,a.kt)("h3",{id:"added-12"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Census3 supported chains information.")),(0,a.kt)("h2",{id:"020---2023-09-04"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.2.0"},"0.2.0")," - 2023-09-04"),(0,a.kt)("h3",{id:"fixed-12"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"dotobject")," helper returns null when key is not found.")),(0,a.kt)("h3",{id:"changed-10"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"collectFaucetTokens")," function accepts raw faucet package payload.")),(0,a.kt)("h3",{id:"added-13"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Census3 error typings."),(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," Census3 anonymous censuses.")),(0,a.kt)("h2",{id:"011---2023-08-14"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.1.1"},"0.1.1")," - 2023-08-14"),(0,a.kt)("h3",{id:"fixed-13"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added missing dependency ",(0,a.kt)("inlineCode",{parentName:"li"},"readable-stream"),".")),(0,a.kt)("h2",{id:"010---2023-08-11"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.1.0"},"0.1.0")," - 2023-08-11"),(0,a.kt)("h3",{id:"added-14"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"[",(0,a.kt)("strong",{parentName:"li"},"BREAKING"),"]"," Anonymous integration")),(0,a.kt)("h3",{id:"fixed-14"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added missing ",(0,a.kt)("inlineCode",{parentName:"li"},"maxCensusSize")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"manuallyEnded")," in ",(0,a.kt)("inlineCode",{parentName:"li"},"fetchElection"),".")),(0,a.kt)("h2",{id:"0018---2023-08-01"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.18"},"0.0.18")," - 2023-08-01"),(0,a.kt)("h3",{id:"added-15"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Election ",(0,a.kt)("inlineCode",{parentName:"li"},"get")," function to fetch metadata values using ",(0,a.kt)("inlineCode",{parentName:"li"},"dotobject"))),(0,a.kt)("h3",{id:"fixed-15"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added missing dependencies")),(0,a.kt)("h2",{id:"0017---2023-07-21"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.17"},"0.0.17")," - 2023-07-21"),(0,a.kt)("h3",{id:"added-16"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Anonymous support using zkSNARK.")),(0,a.kt)("h3",{id:"changed-11"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Election ",(0,a.kt)("inlineCode",{parentName:"li"},"meta")," field has a more lax typing.")),(0,a.kt)("h2",{id:"0016---2023-07-04"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.16"},"0.0.16")," - 2023-07-04"),(0,a.kt)("h3",{id:"added-17"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"SDK version added to election metadata."),(0,a.kt)("li",{parentName:"ul"},"Added new function ",(0,a.kt)("inlineCode",{parentName:"li"},"changeElectionCensus")," to change the election census dynamically."),(0,a.kt)("li",{parentName:"ul"},"Added new helper function ",(0,a.kt)("inlineCode",{parentName:"li"},"formatUnits")," for formatting big decimals values.")),(0,a.kt)("h3",{id:"changed-12"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"New types defined in ",(0,a.kt)("inlineCode",{parentName:"li"},"VocdoniCensus3Client")," with some additional documentation."),(0,a.kt)("li",{parentName:"ul"},"Added new field ",(0,a.kt)("inlineCode",{parentName:"li"},"symbol")," to summary token list in Census3."),(0,a.kt)("li",{parentName:"ul"},"Added new field ",(0,a.kt)("inlineCode",{parentName:"li"},"size")," to token information in Census3 as number of token holders.")),(0,a.kt)("h3",{id:"fixed-16"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Error codes coming from the API.")),(0,a.kt)("h2",{id:"0015---2023-06-20"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.15"},"0.0.15")," - 2023-06-20"),(0,a.kt)("h3",{id:"added-18"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"New ",(0,a.kt)("inlineCode",{parentName:"li"},"InvalidElection")," type for invalid elections."),(0,a.kt)("li",{parentName:"ul"},"New ",(0,a.kt)("inlineCode",{parentName:"li"},"estimateElectionCost")," function in client for estimating election cost."),(0,a.kt)("li",{parentName:"ul"},"New ",(0,a.kt)("inlineCode",{parentName:"li"},"calculateElectionCost")," function in client for calculating the exact election cost."),(0,a.kt)("li",{parentName:"ul"},"New API wrappers for general chain information.")),(0,a.kt)("h3",{id:"changed-13"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"fetchElections")," returns new ",(0,a.kt)("inlineCode",{parentName:"li"},"InvalidElection")," type instead of throwing.")),(0,a.kt)("h3",{id:"fixed-17"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"CSP elections use the URI and public key from the election census defined at creation.")),(0,a.kt)("h2",{id:"0014---2023-06-12"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.14"},"0.0.14")," - 2023-06-12"),(0,a.kt)("h3",{id:"added-19"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"maxValue"),", ",(0,a.kt)("inlineCode",{parentName:"li"},"maxCount")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"maxTotalCost")," properties in ",(0,a.kt)("inlineCode",{parentName:"li"},"IVoteType")," in an election for creating\nquadratic, approval and ranked elections.")),(0,a.kt)("h2",{id:"0013---2023-06-06"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.13"},"0.0.13")," - 2023-06-06"),(0,a.kt)("h3",{id:"added-20"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://github.com/vocdoni/census3/"},"Census3")," integration"),(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"meta")," parameters to election metadata"),(0,a.kt)("li",{parentName:"ul"},"Minor helper functions")),(0,a.kt)("h3",{id:"changed-14"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added some new information to API endpoints")),(0,a.kt)("h3",{id:"fixed-18"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Unlocked rollup version")),(0,a.kt)("h2",{id:"0012---2023-05-09"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.12"},"0.0.12")," - 2023-05-09"),(0,a.kt)("h3",{id:"fixed-19"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Fixed ",(0,a.kt)("inlineCode",{parentName:"li"},"personal_sign")," provider call bug for certain environments")),(0,a.kt)("h2",{id:"0011---2023-04-25"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.11"},"0.0.11")," - 2023-04-25"),(0,a.kt)("h3",{id:"fixed-20"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Fix type error in ",(0,a.kt)("inlineCode",{parentName:"li"},"fetchAccountInfo"))),(0,a.kt)("h2",{id:"0010---2023-04-25"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.10"},"0.0.10")," - 2023-04-25"),(0,a.kt)("h3",{id:"fixed-21"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Fixed internal ",(0,a.kt)("inlineCode",{parentName:"li"},"SetAccountTx")," nonce when creating transactions")),(0,a.kt)("h2",{id:"009---2023-04-25"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.9"},"0.0.9")," - 2023-04-25"),(0,a.kt)("h3",{id:"added-21"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"generateRandomWallet")," function for assigning a random Wallet to the client")),(0,a.kt)("h3",{id:"changed-15"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"isInCensus")," doesn't accept census type because censuses with public keys are removed"),(0,a.kt)("li",{parentName:"ul"},"Refactored account methods to return new ",(0,a.kt)("inlineCode",{parentName:"li"},"AccountData")," definition with ",(0,a.kt)("inlineCode",{parentName:"li"},"Account")," field")),(0,a.kt)("h3",{id:"removed"},"Removed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Ability to create censuses using public keys")),(0,a.kt)("h2",{id:"008---2023-04-05"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.8"},"0.0.8")," - 2023-04-05"),(0,a.kt)("h3",{id:"added-22"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Custom error handling (WIP)")),(0,a.kt)("h3",{id:"changed-16"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"votesLeftCount")," checks if user is in census."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"hasAlreadyVoted()")," returns the vote id or null if the account hasn't voted.")),(0,a.kt)("h3",{id:"fixed-22"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Increased time for transaction confirmation due to block time increase.")),(0,a.kt)("h2",{id:"007---2023-03-29"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.7"},"0.0.7")," - 2023-03-29"),(0,a.kt)("h3",{id:"changed-17"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Updated ",(0,a.kt)("inlineCode",{parentName:"li"},"vocdoni/proto")," library to version ",(0,a.kt)("inlineCode",{parentName:"li"},"1.14.1"),"."),(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"maxCensusSize")," to the election creation.")),(0,a.kt)("h2",{id:"006---2023-03-22"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.6"},"0.0.6")," - 2023-03-22"),(0,a.kt)("h3",{id:"changed-18"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"ElectionStatus")," includes new values ",(0,a.kt)("inlineCode",{parentName:"li"},"ONGOING")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"UPCOMING"),". ",(0,a.kt)("inlineCode",{parentName:"li"},"READY")," is removed an only used internally."),(0,a.kt)("li",{parentName:"ul"},"Election description changed from mandatory to optional."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"fetchElections")," accepts no account and returns all elections in the chain."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"fetchAccountInfo")," accepts arbitrary account to retrieve information.")),(0,a.kt)("h2",{id:"005---2023-03-08"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.5"},"0.0.5")," - 2023-03-08"),(0,a.kt)("h3",{id:"added-23"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"fetchElections")," function to fetch all elections based on a given account"),(0,a.kt)("li",{parentName:"ul"},"New ",(0,a.kt)("inlineCode",{parentName:"li"},"organizationId")," property in ",(0,a.kt)("inlineCode",{parentName:"li"},"PublishedElection"))),(0,a.kt)("h3",{id:"changed-19"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"PublishedCensus")," has ",(0,a.kt)("inlineCode",{parentName:"li"},"size")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"weight")," fields for offchain census.")),(0,a.kt)("h2",{id:"004-alpha---2023-03-01"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.4-alpha"},"0.0.4-alpha")," - 2023-03-01"),(0,a.kt)("h3",{id:"added-24"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Credential service provider integrated"),(0,a.kt)("li",{parentName:"ul"},"Custom retry attempts and time for transactions waiting functionality"),(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"votesLeftCount")," function for checking how many times a user can submit a vote"),(0,a.kt)("li",{parentName:"ul"},"New API requests added for chain information")),(0,a.kt)("h3",{id:"changed-20"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"header")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"streamUri")," are no longer mandatory when creating an election.")),(0,a.kt)("h3",{id:"fixed-23"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"No more 400 error status HTTP requests when asking for a non-confirmed transaction"),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"maxValue")," property fixed in election data")),(0,a.kt)("h2",{id:"003-alpha---2023-01-31"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.3-alpha"},"0.0.3-alpha")," - 2023-01-31"),(0,a.kt)("h3",{id:"added-25"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Functionality to check if a user is in census ",(0,a.kt)("inlineCode",{parentName:"li"},"isInCensus")),(0,a.kt)("li",{parentName:"ul"},"Functionality to check if a user has already voted ",(0,a.kt)("inlineCode",{parentName:"li"},"hasAlreadyVoted")),(0,a.kt)("li",{parentName:"ul"},"Functionality to check if a user is able to vote ",(0,a.kt)("inlineCode",{parentName:"li"},"isAbleToVote")),(0,a.kt)("li",{parentName:"ul"},"Export UMD version via ",(0,a.kt)("inlineCode",{parentName:"li"},"@vocdoni/sdk/umd")),(0,a.kt)("li",{parentName:"ul"},"Deterministic Wallet generation from arbitrary data")),(0,a.kt)("h3",{id:"fixed-24"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Return ",(0,a.kt)("inlineCode",{parentName:"li"},"voteId")," when submitting vote instead of the transaction hash."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"Buffer")," imports for bundle"),(0,a.kt)("li",{parentName:"ul"},"Bundling & export issues")),(0,a.kt)("h3",{id:"changed-21"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Removed ",(0,a.kt)("inlineCode",{parentName:"li"},"dvote-solidity")," dependency.")),(0,a.kt)("h2",{id:"002-alpha---2022-12-20"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.2-alpha"},"0.0.2-alpha")," - 2022-12-20"),(0,a.kt)("h3",{id:"added-26"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Staging environment options for API and Faucet"),(0,a.kt)("li",{parentName:"ul"},"Functionality to end, pause, cancel and continue an election")),(0,a.kt)("h3",{id:"fixed-25"},"Fixed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Fixed proof check using public key when signer is from type ",(0,a.kt)("inlineCode",{parentName:"li"},"Wallet"))),(0,a.kt)("h3",{id:"changed-22"},"Changed"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Use voting endpoint instead of generic submitTx."),(0,a.kt)("li",{parentName:"ul"},"Naming for client initialization options changed."),(0,a.kt)("li",{parentName:"ul"},"There are now the new ",(0,a.kt)("inlineCode",{parentName:"li"},"UnpublishedElection")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"PublishedElection")," classes\nwhich extend from the abstract ",(0,a.kt)("inlineCode",{parentName:"li"},"Election")," class."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"fetchElection")," accepts an election id.")),(0,a.kt)("h2",{id:"001-alpha---2022-12-01"},(0,a.kt)("a",{parentName:"h2",href:"https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.0.1-alpha"},"0.0.1-alpha")," - 2022-12-01"),(0,a.kt)("h3",{id:"added-27"},"Added"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"First unstable version of the SDK for testing purposes")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ff7cb792.9b08808a.js b/assets/js/ff7cb792.9b08808a.js deleted file mode 100644 index 620becf7d..000000000 --- a/assets/js/ff7cb792.9b08808a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2241],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>m});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var o=n.createContext({}),s=function(e){var t=n.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},p=function(e){var t=s(e.components);return n.createElement(o.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,l=e.originalType,o=e.parentName,p=d(e,["components","mdxType","originalType","parentName"]),c=s(r),m=a,u=c["".concat(o,".").concat(m)]||c[m]||k[m]||l;return r?n.createElement(u,i(i({ref:t},p),{},{components:r})):n.createElement(u,i({ref:t},p))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=r.length,i=new Array(l);i[0]=c;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d.mdxType="string"==typeof e?e:a,i[1]=d;for(var s=2;s{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>k,frontMatter:()=>l,metadata:()=>d,toc:()=>s});var n=r(87462),a=(r(67294),r(3905));const l={},i=void 0,d={unversionedId:"sdk/reference/classes/WalletAPI",id:"sdk/reference/classes/WalletAPI",title:"WalletAPI",description:"@vocdoni/sdk / Exports / WalletAPI",source:"@site/docs/sdk/reference/classes/WalletAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/WalletAPI",permalink:"/sdk/reference/classes/WalletAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"VoteService",permalink:"/sdk/reference/classes/VoteService"},next:{title:"WeightedCensus",permalink:"/sdk/reference/classes/WeightedCensus"}},o={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"add",id:"add",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4}],p={toc:s};function k(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / WalletAPI"),(0,a.kt)("h1",{id:"class-walletapi"},"Class: WalletAPI"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"API")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"WalletAPI"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WalletAPI#constructor"},"constructor"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WalletAPI#add"},"add")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WalletAPI#isapierror"},"isApiError")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/WalletAPI#isundefinederror"},"isUndefinedError"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new WalletAPI"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/WalletAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"WalletAPI"))),(0,a.kt)("p",null,"Cannot be constructed."),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/WalletAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"WalletAPI"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"API.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/wallet.ts#L25"},"api/wallet.ts:25")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"add"},"add"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"add"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"privateKey"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"IWalletAddResponse"),">"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"url")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"privateKey")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"IWalletAddResponse"),">"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/wallet.ts#L29"},"api/wallet.ts:29")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isapierror"},"isApiError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"API.isApiError"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L21"},"api/api.ts:21")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"API.isUndefinedError"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/api/api.ts#L64"},"api/api.ts:64")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ff7cb792.c9f454df.js b/assets/js/ff7cb792.c9f454df.js new file mode 100644 index 000000000..fabb486cd --- /dev/null +++ b/assets/js/ff7cb792.c9f454df.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[2241],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var o=n.createContext({}),p=function(e){var t=n.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(o.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,l=e.originalType,o=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),m=p(r),u=a,c=m["".concat(o,".").concat(u)]||m[u]||k[u]||l;return r?n.createElement(c,i(i({ref:t},s),{},{components:r})):n.createElement(c,i({ref:t},s))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=r.length,i=new Array(l);i[0]=m;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d.mdxType="string"==typeof e?e:a,i[1]=d;for(var p=2;p{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>k,frontMatter:()=>l,metadata:()=>d,toc:()=>p});var n=r(87462),a=(r(67294),r(3905));const l={},i=void 0,d={unversionedId:"sdk/reference/classes/WalletAPI",id:"sdk/reference/classes/WalletAPI",title:"WalletAPI",description:"@vocdoni/sdk / Exports / WalletAPI",source:"@site/docs/sdk/reference/classes/WalletAPI.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/WalletAPI",permalink:"/sdk/reference/classes/WalletAPI",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"VoteService",permalink:"/sdk/reference/classes/VoteService"},next:{title:"WeightedCensus",permalink:"/sdk/reference/classes/WeightedCensus"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods-1",level:2},{value:"add",id:"add",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isApiError",id:"isapierror",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isUndefinedError",id:"isundefinederror",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4}],s={toc:p};function k(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / WalletAPI"),(0,a.kt)("h1",{id:"class-walletapi"},"Class: WalletAPI"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"API")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"WalletAPI"))))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"WalletAPI#constructor"},"constructor"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"WalletAPI#add"},"add")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"WalletAPI#isapierror"},"isApiError")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"WalletAPI#isundefinederror"},"isUndefinedError"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new WalletAPI"),"(): ",(0,a.kt)("a",{parentName:"p",href:"WalletAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"WalletAPI"))),(0,a.kt)("p",null,"Cannot be constructed."),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"WalletAPI"},(0,a.kt)("inlineCode",{parentName:"a"},"WalletAPI"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"API.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/wallet.ts#L25"},"api/wallet.ts:25")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"add"},"add"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"add"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"privateKey"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"IWalletAddResponse"),">"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"url")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"privateKey")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"IWalletAddResponse"),">"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/wallet.ts#L29"},"api/wallet.ts:29")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isapierror"},"isApiError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isApiError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"API.isApiError"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L21"},"api/api.ts:21")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isundefinederror"},"isUndefinedError"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isUndefinedError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AxiosError"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),", ",(0,a.kt)("inlineCode",{parentName:"td"},"any"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"API.isUndefinedError"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L64"},"api/api.ts:64")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ffeeb722.96ab602a.js b/assets/js/ffeeb722.96ab602a.js new file mode 100644 index 000000000..ddcd5ef7a --- /dev/null +++ b/assets/js/ffeeb722.96ab602a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[992],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),s=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=s(e.components);return r.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),m=s(n),k=a,v=m["".concat(p,".").concat(k)]||m[k]||c[k]||i;return n?r.createElement(v,l(l({ref:t},d),{},{components:n})):r.createElement(v,l({ref:t},d))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>s});var r=n(87462),a=(n(67294),n(3905));const i={},l=void 0,o={unversionedId:"sdk/reference/classes/VoteService",id:"sdk/reference/classes/VoteService",title:"VoteService",description:"@vocdoni/sdk / Exports / VoteService",source:"@site/docs/sdk/reference/classes/VoteService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/VoteService",permalink:"/sdk/reference/classes/VoteService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"VoteAPI",permalink:"/sdk/reference/classes/VoteAPI"},next:{title:"WalletAPI",permalink:"/sdk/reference/classes/WalletAPI"}},p={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"chainService",id:"chainservice",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods-1",level:2},{value:"encodeTransaction",id:"encodetransaction",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"info",id:"info",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"signTransaction",id:"signtransaction",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"vote",id:"vote",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:s};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"../modules"},"Exports")," / VoteService"),(0,a.kt)("h1",{id:"class-voteservice"},"Class: VoteService"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"Service"},(0,a.kt)("inlineCode",{parentName:"a"},"Service"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"VoteService"))))),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"VoteServiceProperties"))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"VoteService#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"VoteService#chainservice"},"chainService")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"VoteService#url"},"url"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"VoteService#encodetransaction"},"encodeTransaction")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"VoteService#info"},"info")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"VoteService#signtransaction"},"signTransaction")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"VoteService#vote"},"vote"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new VoteService"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"VoteService"},(0,a.kt)("inlineCode",{parentName:"a"},"VoteService"))),(0,a.kt)("p",null,"Instantiate the election service."),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"VoteServiceParameters"),">"),(0,a.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"VoteService"},(0,a.kt)("inlineCode",{parentName:"a"},"VoteService"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,a.kt)("a",{parentName:"p",href:"Service#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/vote.ts#L45"},"services/vote.ts:45")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"chainservice"},"chainService"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"chainService"),": ",(0,a.kt)("a",{parentName:"p",href:"ChainService"},(0,a.kt)("inlineCode",{parentName:"a"},"ChainService"))),(0,a.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,a.kt)("p",null,"VoteServiceProperties.chainService"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/vote.ts#L38"},"services/vote.ts:38")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"url"},"url"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"url"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,a.kt)("a",{parentName:"p",href:"Service#url"},"url")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/service.ts#L6"},"services/service.ts:6")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"encodetransaction"},"encodeTransaction"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"encodeTransaction"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"tx"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"tx")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Uint8Array"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/vote.ts#L58"},"services/vote.ts:58")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"info"},"info"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"info"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"voteId"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteInfoResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteInfoResponse")),">"),(0,a.kt)("p",null,"Get the vote information"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"voteId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The identifier of the vote")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteInfoResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteInfoResponse")),">"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/vote.ts#L69"},"services/vote.ts:69")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"signtransaction"},"signTransaction"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"signTransaction"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"tx"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"message"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"walletOrSigner"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"tx")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Uint8Array"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"walletOrSigner")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"Signer"))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/vote.ts#L50"},"services/vote.ts:50")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"vote"},"vote"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"vote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteSubmitResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteSubmitResponse")),">"),(0,a.kt)("p",null,"Submit the vote to the chain"),(0,a.kt)("h4",{id:"parameters-4"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"payload")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The base64 encoded vote transaction")))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"../interfaces/IVoteSubmitResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteSubmitResponse")),">"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/vote.ts#L81"},"services/vote.ts:81")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ffeeb722.d4b952b7.js b/assets/js/ffeeb722.d4b952b7.js deleted file mode 100644 index 4339aff7f..000000000 --- a/assets/js/ffeeb722.d4b952b7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[992],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),p=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},d=function(e){var t=p(e.components);return n.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),k=p(r),m=a,v=k["".concat(s,".").concat(m)]||k[m]||c[m]||i;return r?n.createElement(v,l(l({ref:t},d),{},{components:r})):n.createElement(v,l({ref:t},d))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=k;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var p=2;p{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var n=r(87462),a=(r(67294),r(3905));const i={},l=void 0,o={unversionedId:"sdk/reference/classes/VoteService",id:"sdk/reference/classes/VoteService",title:"VoteService",description:"@vocdoni/sdk / Exports / VoteService",source:"@site/docs/sdk/reference/classes/VoteService.md",sourceDirName:"sdk/reference/classes",slug:"/sdk/reference/classes/VoteService",permalink:"/sdk/reference/classes/VoteService",draft:!1,tags:[],version:"current",frontMatter:{},sidebar:"defaultSidebar",previous:{title:"VoteAPI",permalink:"/sdk/reference/classes/VoteAPI"},next:{title:"WalletAPI",permalink:"/sdk/reference/classes/WalletAPI"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Implements",id:"implements",level:2},{value:"Table of contents",id:"table-of-contents",level:2},{value:"Constructors",id:"constructors",level:3},{value:"Properties",id:"properties",level:3},{value:"Methods",id:"methods",level:3},{value:"Constructors",id:"constructors-1",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties-1",level:2},{value:"chainService",id:"chainservice",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods-1",level:2},{value:"encodeTransaction",id:"encodetransaction",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"info",id:"info",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"signTransaction",id:"signtransaction",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"vote",id:"vote",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk"},"@vocdoni/sdk")," / ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/modules"},"Exports")," / VoteService"),(0,a.kt)("h1",{id:"class-voteservice"},"Class: VoteService"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},(0,a.kt)("inlineCode",{parentName:"a"},"Service"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"VoteService"))))),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"VoteServiceProperties"))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VoteService#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VoteService#chainservice"},"chainService")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VoteService#url"},"url"))),(0,a.kt)("h3",{id:"methods"},"Methods"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VoteService#encodetransaction"},"encodeTransaction")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VoteService#info"},"info")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VoteService#signtransaction"},"signTransaction")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/sdk/reference/classes/VoteService#vote"},"vote"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new VoteService"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VoteService"},(0,a.kt)("inlineCode",{parentName:"a"},"VoteService"))),(0,a.kt)("p",null,"Instantiate the election service."),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"params")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Partial"),"\\<",(0,a.kt)("inlineCode",{parentName:"td"},"VoteServiceParameters"),">"),(0,a.kt)("td",{parentName:"tr",align:"left"},"The service parameters")))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/VoteService"},(0,a.kt)("inlineCode",{parentName:"a"},"VoteService"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#constructor"},"constructor")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/vote.ts#L45"},"services/vote.ts:45")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"chainservice"},"chainService"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"chainService"),": ",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/ChainService"},(0,a.kt)("inlineCode",{parentName:"a"},"ChainService"))),(0,a.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,a.kt)("p",null,"VoteServiceProperties.chainService"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/vote.ts#L38"},"services/vote.ts:38")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"url"},"url"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"url"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service"},"Service"),".",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/classes/Service#url"},"url")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/service.ts#L6"},"services/service.ts:6")),(0,a.kt)("h2",{id:"methods-1"},"Methods"),(0,a.kt)("h3",{id:"encodetransaction"},"encodeTransaction"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"encodeTransaction"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"tx"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"tx")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Uint8Array"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/vote.ts#L58"},"services/vote.ts:58")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"info"},"info"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"info"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"voteId"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteInfoResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteInfoResponse")),">"),(0,a.kt)("p",null,"Get the vote information"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"voteId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The identifier of the vote")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteInfoResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteInfoResponse")),">"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/vote.ts#L69"},"services/vote.ts:69")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"signtransaction"},"signTransaction"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"signTransaction"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"tx"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"message"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"walletOrSigner"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"parameters-3"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"tx")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Uint8Array"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"walletOrSigner")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Wallet")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"Signer"))))),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/vote.ts#L50"},"services/vote.ts:50")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"vote"},"vote"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"vote"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteSubmitResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteSubmitResponse")),">"),(0,a.kt)("p",null,"Submit the vote to the chain"),(0,a.kt)("h4",{id:"parameters-4"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"payload")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string")),(0,a.kt)("td",{parentName:"tr",align:"left"},"The base64 encoded vote transaction")))),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"\\<",(0,a.kt)("a",{parentName:"p",href:"/sdk/reference/interfaces/IVoteSubmitResponse"},(0,a.kt)("inlineCode",{parentName:"a"},"IVoteSubmitResponse")),">"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/vocdoni/vocdoni-sdk/blob/2c8c18a/src/services/vote.ts#L81"},"services/vote.ts:81")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/main.d150b023.js b/assets/js/main.d150b023.js deleted file mode 100644 index 429345381..000000000 --- a/assets/js/main.d150b023.js +++ /dev/null @@ -1,8 +0,0 @@ -/*! For license information please see main.d150b023.js.LICENSE.txt */ -(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[179],{20830:(e,t,n)=>{"use strict";n.d(t,{W:()=>a});var r=n(67294);function a(){return r.createElement("svg",{width:"20",height:"20",className:"DocSearch-Search-Icon",viewBox:"0 0 20 20"},r.createElement("path",{d:"M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z",stroke:"currentColor",fill:"none",fillRule:"evenodd",strokeLinecap:"round",strokeLinejoin:"round"}))}},723:(e,t,n)=>{"use strict";n.d(t,{Z:()=>p});var r=n(67294),a=n(87462),o=n(68356),i=n.n(o),s=n(16887);const c={"0032f96f":[()=>n.e(100).then(n.bind(n,71659)),"@site/docs/sdk/reference/enums/EnvOptions.md",71659],"00ff508f":[()=>n.e(6811).then(n.bind(n,49589)),"@site/docs/protocol/data-schemes/vote.md",49589],"0128e05f":[()=>n.e(2636).then(n.bind(n,58146)),"@site/docs/sdk/reference/classes/FileAPI.md",58146],"01f4109f":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(6781)]).then(n.bind(n,84522)),"@site/docs/vocdoni-api/list-account-received-and-sent-token-transfers.api.mdx",84522],"03c6674d":[()=>n.e(4720).then(n.bind(n,56675)),"@site/docs/sdk/reference/classes/MultiChoiceElection.md",56675],"03d8c746":[()=>n.e(9967).then(n.bind(n,69109)),"@site/docs/sdk/reference/classes/FileService.md",69109],"080a9ee7":[()=>n.e(3913).then(n.bind(n,62998)),"@site/docs/sdk/reference/enums/CensusTypeEnum.md",62998],"08636a24":[()=>n.e(374).then(n.bind(n,21054)),"@site/docs/sdk/reference/classes/ElectionService.md",21054],"09cca914":[()=>n.e(9410).then(n.bind(n,94455)),"@site/docs/sdk/reference/interfaces/ITallyMode.md",94455],"0a3f3d31":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(5122)]).then(n.bind(n,61890)),"@site/docs/vocdoni-api/list-election-votes.api.mdx",61890],"0bcfcae9":[()=>n.e(6891).then(n.bind(n,36502)),"@site/docs/sdk/reference/classes/Election.md",36502],"0e384e19":[()=>n.e(9671).then(n.bind(n,59881)),"@site/docs/intro.md",59881],"0f556ffa":[()=>n.e(2467).then(n.bind(n,8207)),"@site/docs/sdk/reference/interfaces/ICensus3TokenTypesResponse.md",8207],"0fa69d70":[()=>n.e(1371).then(n.bind(n,13302)),"@site/docs/sdk/reference/interfaces/ICensusPublishResponse.md",13302],"0fc92a72":[()=>n.e(5253).then(n.bind(n,27084)),"@site/docs/sdk/reference/interfaces/ICensus3ValidatePredicateChild.md",27084],"109756a8":[()=>n.e(2870).then(n.bind(n,88064)),"@site/docs/sdk/reference/classes/ApprovalElection.md",88064],"10dce6d4":[()=>n.e(7493).then(n.bind(n,71333)),"@site/docs/sdk/reference/interfaces/IAccountsListResponse.md",71333],"11667d91":[()=>n.e(1425).then(n.bind(n,50052)),"@site/docs/sdk/reference/interfaces/IMultiChoiceElectionParameters.md",50052],"11d03c56":[()=>n.e(8759).then(n.bind(n,78989)),"@site/docs/protocol/anonymity/on-chain.md",78989],"123fab3b":[()=>Promise.all([n.e(532),n.e(2284),n.e(1739)]).then(n.bind(n,9003)),"@site/docs/vocdoni-api/votes.tag.mdx",9003],"134f4ebc":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(738)]).then(n.bind(n,6002)),"@site/docs/vocdoni-api/set-wallet-account.api.mdx",6002],"13df6360":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(6499)]).then(n.bind(n,11349)),"@site/docs/vocdoni-api/price-factors-information.api.mdx",11349],"15bb616c":[()=>n.e(830).then(n.bind(n,92234)),"@site/docs/protocol/data-schemes/election.md",92234],"16c4bb07":[()=>n.e(7533).then(n.bind(n,21852)),"@site/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponse.md",21852],"16e8ae75":[()=>n.e(6418).then(n.bind(n,61593)),"@site/docs/sdk/reference/interfaces/IElectionListFilter.md",61593],"1821d9d7":[()=>n.e(1510).then(n.bind(n,3253)),"@site/docs/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse.md",3253],"1a4e3797":[()=>Promise.all([n.e(532),n.e(7920)]).then(n.bind(n,39172)),"@theme/SearchPage",39172],"1be78505":[()=>Promise.all([n.e(532),n.e(9514)]).then(n.bind(n,40683)),"@theme/DocPage",40683],"1c3bce93":[()=>n.e(1414).then(n.bind(n,89396)),"@site/docs/sdk/reference/classes/PublishedCensus.md",89396],"1cd58b57":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(8545)]).then(n.bind(n,9594)),"@site/docs/vocdoni-api/import-census-database.api.mdx",9594],"1df93b7f":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(3750),n.e(3237)]).then(n.bind(n,39884)),"@site/src/pages/index.tsx",39884],"1e6527e1":[()=>n.e(4719).then(n.bind(n,7490)),"@site/docs/sdk/reference/interfaces/Tx.md",7490],"1e8e5e9a":[()=>n.e(4881).then(n.bind(n,94067)),"@site/docs/sdk/reference/classes/ElectionAPI.md",94067],"1ed63671":[()=>n.e(7998).then(n.bind(n,92064)),"@site/docs/sdk/reference/enums/TransactionType.md",92064],"1edcfddb":[()=>n.e(5288).then(n.bind(n,88593)),"@site/docs/sdk/reference/interfaces/ServiceProperties.md",88593],"204645f9":[()=>n.e(8312).then(n.bind(n,58080)),"@site/docs/sdk/voting-types/quadratic.md",58080],22155637:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(5268)]).then(n.bind(n,95321)),"@site/docs/vocdoni-api/list-validators.api.mdx",95321],"2340828a":[()=>n.e(4376).then(n.bind(n,20137)),"@site/docs/sdk/reference/classes/FaucetService.md",20137],"23e9e137":[()=>n.e(8016).then(n.bind(n,59841)),"@site/docs/sdk/reference/interfaces/ICensusExportResponse.md",59841],"24ee6be4":[()=>n.e(5326).then(n.bind(n,72109)),"@site/docs/sdk/reference/interfaces/ICensusParticipant.md",72109],"260b3d09":[()=>n.e(5214).then(n.bind(n,8077)),"@site/docs/sdk/reference/classes/Service.md",8077],"2730d8e4":[()=>n.e(8597).then(n.bind(n,81169)),"@site/docs/sdk/reference/interfaces/SetProcessTx.md",81169],29694922:[()=>n.e(6178).then(n.bind(n,89571)),"@site/docs/ui-components/02-Organization.mdx",89571],"29c8ca5d":[()=>n.e(4463).then(n.bind(n,84677)),"@site/docs/sdk/reference/classes/VoteAPI.md",84677],"2dbb09aa":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(5378)]).then(n.bind(n,14010)),"@site/docs/vocdoni-api/count-election-votes.api.mdx",14010],"2eb5a7fb":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(2360)]).then(n.bind(n,17728)),"@site/docs/vocdoni-api/census-merkle-root.api.mdx",17728],"2f59b2ef":[()=>n.e(274).then(n.bind(n,14386)),"@site/docs/sdk/reference/interfaces/ICensus3ValidatePredicateResponse.md",14386],"335f69d6":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(4540)]).then(n.bind(n,37888)),"@site/docs/vocdoni-api/census-total-weight.api.mdx",37888],"377fc202":[()=>n.e(3516).then(n.bind(n,40552)),"@site/docs/sdk/reference/classes/AccountService.md",40552],"388546f3":[()=>Promise.all([n.e(532),n.e(2284),n.e(8999)]).then(n.bind(n,31545)),"@site/docs/vocdoni-api/elections.tag.mdx",31545],"3930cc8a":[()=>Promise.all([n.e(532),n.e(2284),n.e(3168)]).then(n.bind(n,99098)),"@site/docs/vocdoni-api/sik.tag.mdx",99098],"39a96d3a":[()=>n.e(306).then(n.bind(n,66038)),"@site/docs/sdk/reference/interfaces/ElectionMetadata.md",66038],"3aefc2b6":[()=>n.e(3868).then(n.bind(n,43924)),"@site/docs/sdk/reference/classes/TokenCensus.md",43924],"3b56eb8e":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(5978)]).then(n.bind(n,20863)),"@site/docs/vocdoni-api/create-a-new-census.api.mdx",20863],"3b8a1714":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(8740)]).then(n.bind(n,42045)),"@site/docs/vocdoni-api/create-election-for-wallet.api.mdx",42045],"3c152c78":[()=>n.e(3625).then(n.bind(n,30194)),"@site/docs/sdk/reference/interfaces/ICensus3ValidatePredicateToken.md",30194],"3da0b0fe":[()=>Promise.all([n.e(532),n.e(2284),n.e(656)]).then(n.bind(n,47215)),"@site/docs/vocdoni-api/accounts.tag.mdx",47215],"3fa72254":[()=>n.e(9217).then(n.bind(n,3553)),"@site/docs/sdk/reference/interfaces/IChainOrganizationResponse.md",3553],"427be892":[()=>n.e(8913).then(n.bind(n,28068)),"@site/docs/protocol/data-schemes/data-schemes.md",28068],"437ed742":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(3796)]).then(n.bind(n,7786)),"@site/docs/vocdoni-api/transaction-by-hash.api.mdx",7786],"445f6f2d":[()=>n.e(7456).then(n.bind(n,67006)),"@site/docs/sdk/reference/interfaces/SetAccountTx.md",67006],"467b2519":[()=>n.e(3158).then(n.bind(n,33391)),"@site/docs/sdk/reference/classes/CensusAPI.md",33391],"47d20a96":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(1591)]).then(n.bind(n,53190)),"@site/docs/vocdoni-api/compute-ipfs-ci-dv-1-of-file.api.mdx",53190],"47d37469":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(4013)]).then(n.bind(n,44768)),"@site/docs/vocdoni-api/census-size.api.mdx",44768],"491af8ad":[()=>n.e(135).then(n.bind(n,13471)),"@site/docs/sdk/reference/interfaces/IVoteMode.md",13471],"49b14676":[()=>n.e(7583).then(n.bind(n,43127)),"@site/docs/sdk/reference/classes/CspService.md",43127],"4adb919a":[()=>n.e(8033).then(n.bind(n,89541)),"@site/docs/sdk/reference/enums/TxType.md",89541],"4b742bf9":[()=>n.e(5882).then(n.bind(n,94266)),"@site/docs/sdk/reference/interfaces/VoteEnvelope.md",94266],"4bef2fb3":[()=>n.e(5277).then(n.bind(n,19662)),"@site/docs/sdk/reference/interfaces/IVoteInfoResponse.md",19662],"4c5e977b":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(3849),n.e(1893)]).then(n.bind(n,46261)),"@theme/ApiItem",46261],"4d61d27d":[()=>n.e(4253).then(n.bind(n,18672)),"@site/docs/sdk/reference/interfaces/ICensus3ServiceInfoResponse.md",18672],"4d66e9ad":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(9202)]).then(n.bind(n,24401)),"@site/docs/vocdoni-api/delete-census.api.mdx",24401],"4e2de210":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(9057)]).then(n.bind(n,13366)),"@site/docs/vocdoni-api/create-election.api.mdx",13366],"4f32f676":[()=>n.e(1187).then(n.bind(n,27888)),"@site/docs/protocol/ballot-protocol.md",27888],"5125b704":[()=>n.e(1205).then(n.bind(n,72906)),"@site/docs/sdk/reference/interfaces/MintTokensTx.md",72906],"515de0d7":[()=>n.e(7136).then(n.bind(n,65073)),"@site/docs/sdk/reference/interfaces/CollectFaucetTx.md",65073],"518b90c0":[()=>n.e(7037).then(n.bind(n,21993)),"@site/docs/protocol/data-schemes/organization.md",21993],"5344dd0e":[()=>n.e(4519).then(n.bind(n,12726)),"@site/docs/sdk/reference/interfaces/IChainOrganizationListResponse.md",12726],"5383e2bf":[()=>n.e(2323).then(n.bind(n,11550)),"@site/docs/sdk/reference/interfaces/SendTokensTx.md",11550],"545dbd82":[()=>n.e(8119).then(n.bind(n,23087)),"@site/docs/sdk/reference/classes/Census.md",23087],"54a4f78f":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(2116)]).then(n.bind(n,20249)),"@site/docs/vocdoni-api/submit-a-vote.api.mdx",20249],"5708b463":[()=>n.e(5861).then(n.bind(n,97041)),"@site/docs/sdk/reference/interfaces/IChainGetCircuitResponse.md",97041],57136864:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(2192)]).then(n.bind(n,24856)),"@site/docs/vocdoni-api/transactions-count.api.mdx",24856],"576aa68d":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(891)]).then(n.bind(n,32133)),"@site/docs/vocdoni-api/add-participants-to-census.api.mdx",32133],"58053ccf":[()=>n.e(473).then(n.bind(n,38339)),"@site/docs/sdk/voting-types/ranked.md",38339],"5945b6f4":[()=>n.e(689).then(n.t.bind(n,83769,19)),"/home/runner/work/developer-portal/developer-portal/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json",83769],"5954c450":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(4539)]).then(n.bind(n,51077)),"@site/docs/vocdoni-api/get-vote.api.mdx",51077],"5977a97c":[()=>n.e(9209).then(n.bind(n,8970)),"@site/docs/sdk/reference/interfaces/ICensus3CensusQueueResponse.md",8970],"59d5b983":[()=>n.e(1557).then(n.bind(n,23791)),"@site/docs/sdk/reference/classes/Account.md",23791],"59e232ee":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(6204)]).then(n.bind(n,50443)),"@site/docs/vocdoni-api/total-number-of-accounts.api.mdx",50443],"5a8bd590":[()=>n.e(9090).then(n.bind(n,38385)),"@site/docs/protocol/census/on-chain.md",38385],"5c4d0554":[()=>n.e(3204).then(n.bind(n,67221)),"@site/docs/ui-components/03-Election.mdx",67221],"5c98d4ea":[()=>n.e(4182).then(n.bind(n,60218)),"@site/docs/sdk/reference/interfaces/IVoteType.md",60218],"5ddc4d53":[()=>n.e(6990).then(n.bind(n,72552)),"@site/docs/sdk/reference/classes/FaucetAPI.md",72552],"5e9f5e1a":[()=>Promise.resolve().then(n.bind(n,36809)),"@generated/docusaurus.config",36809],"5f8415ed":[()=>n.e(9347).then(n.bind(n,76123)),"@site/docs/protocol/anonymity/anonymity.md",76123],"63e7154e":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(2609)]).then(n.bind(n,47852)),"@site/docs/vocdoni-api/list-organizations-filtered.api.mdx",47852],"64aa0b9a":[()=>n.e(3038).then(n.bind(n,73543)),"@site/docs/sdk/reference/interfaces/IChainGetCostsResponse.md",73543],"64c2e320":[()=>n.e(4246).then(n.bind(n,35534)),"@site/docs/sdk/reference/classes/AnonymousService.md",35534],"65d7ebf2":[()=>n.e(3802).then(n.bind(n,76482)),"@site/docs/sdk/reference/interfaces/ICensus3TokenListResponse.md",76482],"65e31fed":[()=>n.e(1871).then(n.t.bind(n,15745,19)),"/home/runner/work/developer-portal/developer-portal/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json",15745],"68ce4a42":[()=>n.e(887).then(n.bind(n,80509)),"@site/docs/sdk/tutorial.md",80509],"6a011cfc":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(6956)]).then(n.bind(n,35091)),"@site/docs/vocdoni-api/list-all-census-references.api.mdx",35091],"6a02f24e":[()=>n.e(5596).then(n.bind(n,85509)),"@site/docs/sdk/reference/interfaces/IChainTxCountResponse.md",85509],"6aeb5732":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(2277)]).then(n.bind(n,69102)),"@site/docs/vocdoni-api/total-number-of-sent-and-received-transactions.api.mdx",69102],"6b41ffc9":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(6563)]).then(n.bind(n,14701)),"@site/docs/vocdoni-api/compute-election-price.api.mdx",14701],"6b697fd9":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(7813)]).then(n.bind(n,82643)),"@site/docs/vocdoni-api/submit-transaction.api.mdx",82643],"6b74149a":[()=>n.e(9470).then(n.bind(n,47527)),"@site/docs/sdk/reference/interfaces/Process.md",47527],"6b798853":[()=>n.e(8168).then(n.bind(n,38382)),"@site/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated.md",38382],"6bf5cd43":[()=>n.e(6906).then(n.bind(n,81311)),"@site/docs/sdk/reference/interfaces/IElectionCreateResponse.md",81311],"6d3dfbcd":[()=>n.e(7082).then(n.bind(n,29021)),"@site/docs/sdk/reference/interfaces/IChainGetInfoResponse.md",29021],"705711d3":[()=>n.e(8883).then(n.bind(n,85533)),"@site/docs/sdk/reference/interfaces/IAccountTransfersCountResponse.md",85533],"70e3ad0d":[()=>n.e(8930).then(n.bind(n,18157)),"@site/docs/sdk/reference/interfaces/IChainSubmitTxResponse.md",18157],"71f8faad":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(1655)]).then(n.bind(n,9242)),"@site/docs/vocdoni-api/election-information.api.mdx",9242],"725284f7":[()=>n.e(9942).then(n.bind(n,27947)),"@site/docs/sdk/reference/interfaces/FetchElectionsParameters.md",27947],"7365c198":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(2079)]).then(n.bind(n,10797)),"@site/docs/vocdoni-api/transaction-by-index.api.mdx",10797],"74b5ba26":[()=>n.e(3773).then(n.bind(n,55317)),"@site/docs/protocol/anonymity/blind-signatures.md",55317],"7644a8b6":[()=>n.e(5421).then(n.bind(n,52077)),"@site/docs/sdk/reference/interfaces/IElectionListResponse.md",52077],"783013b2":[()=>n.e(7374).then(n.bind(n,46269)),"@site/docs/sdk/reference/classes/CensusService.md",46269],"787465aa":[()=>n.e(7673).then(n.bind(n,96659)),"@site/docs/sdk/reference/classes/AccountAPI.md",96659],"79e28b2f":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(9184)]).then(n.bind(n,1903)),"@site/docs/vocdoni-api/count-organizations.api.mdx",1903],"7acd0d27":[()=>n.e(522).then(n.bind(n,84546)),"@site/docs/sdk/reference/interfaces/CircuitInputs.md",84546],"7b4f5a52":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(8389)]).then(n.bind(n,1175)),"@site/docs/vocdoni-api/transaction-by-block-height-and-index.api.mdx",1175],"7c0d6738":[()=>n.e(1573).then(n.bind(n,40202)),"@site/docs/sdk/reference/classes/Census3StrategyAPI.md",40202],"7ccdd76e":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(2956)]).then(n.bind(n,77437)),"@site/docs/vocdoni-api/publish-census.api.mdx",77437],"80975cc5":[()=>n.e(8004).then(n.t.bind(n,7085,19)),"/home/runner/work/developer-portal/developer-portal/.docusaurus/docusaurus-theme-search-algolia/default/plugin-route-context-module-100.json",7085],"87d0da39":[()=>n.e(1719).then(n.bind(n,82595)),"@site/docs/sdk/reference/modules.md",82595],"8a23d602":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(2551)]).then(n.bind(n,47241)),"@site/docs/vocdoni-api/export-census-database.api.mdx",47241],"8a92166d":[()=>n.e(6689).then(n.bind(n,61287)),"@site/docs/sdk/reference/interfaces/IEncryptionKey.md",61287],"8b196d05":[()=>n.e(1806).then(n.bind(n,90210)),"@site/docs/sdk/reference/interfaces/ICensus3CensusResponse.md",90210],"8b5652a7":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(2184)]).then(n.bind(n,40765)),"@site/docs/vocdoni-api/list-of-valid-sik-roots.api.mdx",40765],"8d68bc4a":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(8976)]).then(n.bind(n,65697)),"@site/docs/vocdoni-api/transaction-costs.api.mdx",65697],"8d8eb18d":[()=>n.e(5487).then(n.bind(n,24288)),"@site/docs/protocol/census/census.md",24288],"8e01bad3":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(6135)]).then(n.bind(n,24895)),"@site/docs/vocdoni-api/election-results.api.mdx",24895],"8ec8cf1f":[()=>n.e(8399).then(n.bind(n,6274)),"@site/docs/sdk/reference/interfaces/ICensusImportResponse.md",6274],"8ed7db60":[()=>n.e(2931).then(n.bind(n,39979)),"@site/docs/sdk/reference/interfaces/NewProcessTx.md",39979],"900ced3f":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(5469)]).then(n.bind(n,57285)),"@site/docs/vocdoni-api/get-next-election-id.api.mdx",57285],"9029ef47":[()=>n.e(1126).then(n.bind(n,61400)),"@site/docs/sdk/reference/interfaces/IElectionKeysResponse.md",61400],92348782:[()=>n.e(9940).then(n.bind(n,52437)),"@site/docs/sdk/reference/interfaces/ICensus3TokenListResponsePaginated.md",52437],"925c0bed":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(6354)]).then(n.bind(n,41216)),"@site/docs/vocdoni-api/publish-census-at-root.api.mdx",41216],"935f2afb":[()=>n.e(53).then(n.t.bind(n,1109,19)),"~docs/default/version-current-metadata-prop-751.json",1109],93908748:[()=>n.e(4805).then(n.bind(n,20951)),"@site/docs/sdk/reference/interfaces/ICensus3TokenHolderResponse.md",20951],"94050a54":[()=>n.e(8180).then(n.bind(n,18967)),"@site/docs/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse.md",18967],"945f0be5":[()=>n.e(5104).then(n.bind(n,57462)),"@site/docs/sdk/reference/classes/Census3TokenAPI.md",57462],"9611c1ba":[()=>n.e(6567).then(n.bind(n,36543)),"@site/docs/sdk/reference/enums/ElectionResultsTypeNames.md",36543],"999cbc12":[()=>n.e(2600).then(n.bind(n,93106)),"@site/docs/sdk/reference/interfaces/IElectionVote.md",93106],"99a9ad46":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(1290)]).then(n.bind(n,3762)),"@site/docs/vocdoni-api/verify-merkle-proof.api.mdx",3762],"99ffa32d":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(5698)]).then(n.bind(n,69667)),"@site/docs/vocdoni-api/verify-vote.api.mdx",69667],"9e4ccdce":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(9128)]).then(n.bind(n,18918)),"@site/docs/vocdoni-api/estimate-block-to-date.api.mdx",18918],"9ea3e4a5":[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(4820)]).then(n.bind(n,94369)),"@site/docs/vocdoni-api/export-census.api.mdx",94369],"9f384d53":[()=>n.e(5058).then(n.bind(n,56697)),"@site/docs/sdk/reference/interfaces/IChainValidator.md",56697],"9f9eec24":[()=>n.e(1094).then(n.bind(n,55218)),"@site/docs/sdk/reference/interfaces/IChainValidatorsListResponse.md",55218],a21738db:[()=>n.e(3334).then(n.bind(n,90591)),"@site/docs/protocol/index.md",90591],a217fb3c:[()=>n.e(6386).then(n.bind(n,15079)),"@site/docs/sdk/reference/classes/WeightedCensus.md",15079],a2cbb706:[()=>n.e(1966).then(n.bind(n,5130)),"@site/docs/sdk/reference/classes/ChainService.md",5130],a674c74b:[()=>n.e(6412).then(n.bind(n,22006)),"@site/docs/sdk/reference/classes/PlainCensus.md",22006],a7835d3e:[()=>n.e(6723).then(n.bind(n,46887)),"@site/docs/sdk/reference/classes/AnonymousVote.md",46887],a87232fc:[()=>n.e(7347).then(n.bind(n,43556)),"@site/docs/sdk/reference/interfaces/ICensus3SupportedChain.md",43556],aab6ad66:[()=>n.e(260).then(n.bind(n,9034)),"@site/docs/sdk/reference/classes/ArchivedElection.md",9034],ac57e32f:[()=>n.e(848).then(n.bind(n,25280)),"@site/docs/sdk/reference/enums/CspProofType.md",25280],ace89945:[()=>n.e(7612).then(n.bind(n,45613)),"@site/docs/sdk/reference/interfaces/IAccount.md",45613],ad99c2e7:[()=>n.e(4600).then(n.bind(n,28794)),"@site/docs/sdk/reference/interfaces/AdminTx.md",28794],ae74964d:[()=>n.e(297).then(n.bind(n,887)),"@site/docs/sdk/reference/classes/CspVote.md",887],ae785ce1:[()=>n.e(3496).then(n.bind(n,85877)),"@site/docs/sdk/reference/interfaces/IPublishedElectionParameters.md",85877],af3402af:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(6425)]).then(n.bind(n,23761)),"@site/docs/vocdoni-api/circuit-info.api.mdx",23761],af55f10e:[()=>n.e(5580).then(n.bind(n,26224)),"@site/docs/sdk/reference/classes/VocdoniCensus3Client.md",26224],af663d33:[()=>n.e(4721).then(n.bind(n,14063)),"@site/docs/sdk/reference/interfaces/IAccountsCountResponse.md",14063],af6efd74:[()=>n.e(4458).then(n.bind(n,9)),"@site/docs/sdk/integration-details.md",9],b0b03425:[()=>Promise.all([n.e(532),n.e(2284),n.e(3023)]).then(n.bind(n,40062)),"@site/docs/vocdoni-api/chain.tag.mdx",40062],b0d01e95:[()=>n.e(1968).then(n.bind(n,29542)),"@site/docs/sdk/reference/interfaces/IElectionInfoResponse.md",29542],b2b5a0c0:[()=>n.e(1270).then(n.bind(n,90002)),"@site/docs/sdk/reference/interfaces/IChainOrganizationCountResponse.md",90002],b3153972:[()=>n.e(7631).then(n.bind(n,28493)),"@site/docs/sdk/reference/interfaces/ICensus3StrategiesListResponse.md",28493],b491e6b8:[()=>n.e(2859).then(n.bind(n,77122)),"@site/docs/sdk/reference/interfaces/IChoice.md",77122],b5881b04:[()=>n.e(9589).then(n.bind(n,27382)),"@site/docs/sdk/reference/interfaces/IElectionMode.md",27382],b7cc9ed0:[()=>n.e(9097).then(n.bind(n,31233)),"@site/docs/sdk/reference/enums/ElectionStatus.md",31233],b80cad64:[()=>n.e(8149).then(n.bind(n,38254)),"@site/docs/sdk/reference/interfaces/IBlockTransactionsResponse.md",38254],b83e4bd7:[()=>n.e(9229).then(n.bind(n,14484)),"@site/docs/sdk/reference/interfaces/IVoteSubmitResponse.md",14484],b862b811:[()=>n.e(9756).then(n.bind(n,7453)),"@site/docs/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated.md",7453],b8b370b8:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(7592)]).then(n.bind(n,56721)),"@site/docs/vocdoni-api/list-account-token-fees.api.mdx",56721],bddc6002:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(47)]).then(n.bind(n,53982)),"@site/docs/vocdoni-api/transactions-in-a-block.api.mdx",53982],bec6d9ae:[()=>n.e(211).then(n.bind(n,64793)),"@site/docs/sdk/reference/interfaces/AccountMetadata.md",64793],bfbab14f:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(7799)]).then(n.bind(n,52438)),"@site/docs/vocdoni-api/prove-key-to-census.api.mdx",52438],c121c8d5:[()=>n.e(3195).then(n.bind(n,73535)),"@site/docs/sdk/reference/interfaces/Proof.md",73535],c12940ed:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(182)]).then(n.bind(n,46275)),"@site/docs/vocdoni-api/list-encryption-keys.api.mdx",46275],c2c73492:[()=>n.e(1865).then(n.bind(n,20788)),"@site/docs/sdk/reference/interfaces/IElectionVoteListResponse.md",20788],c4573554:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(4259)]).then(n.bind(n,15980)),"@site/docs/vocdoni-api/list-organization-elections.api.mdx",15980],c5434c58:[()=>n.e(7694).then(n.bind(n,19216)),"@site/docs/sdk/reference/interfaces/RegisterKeyTx.md",19216],c626f2cc:[()=>n.e(422).then(n.bind(n,41300)),"@site/docs/sdk/reference/classes/VocdoniSDKClient.md",41300],c84aae18:[()=>n.e(4324).then(n.bind(n,13083)),"@site/docs/sdk/reference/classes/BudgetElection.md",13083],c87cc133:[()=>n.e(4674).then(n.bind(n,33392)),"@site/docs/sdk/reference/classes/Census3ServiceAPI.md",33392],c8cd88a5:[()=>Promise.all([n.e(532),n.e(1597)]).then(n.bind(n,51910)),"@site/docs/vocdoni-api/vocdoni-api.info.mdx",51910],caece487:[()=>n.e(8161).then(n.bind(n,72227)),"@site/docs/sdk/reference/interfaces/SetTransactionCostsTx.md",72227],cce83bc5:[()=>n.e(6686).then(n.bind(n,49466)),"@site/docs/sdk/reference/interfaces/IElectionSummary.md",49466],d077d113:[()=>n.e(9436).then(n.bind(n,29257)),"@site/docs/sdk/voting-types/single-choice.md",29257],d234883f:[()=>n.e(8277).then(n.bind(n,19574)),"@site/docs/protocol/anonymity/zk-census-proof.md",19574],d250e750:[()=>n.e(5677).then(n.bind(n,96405)),"@site/docs/sdk/reference/interfaces/IQuestion.md",96405],d28adde9:[()=>n.e(4201).then(n.bind(n,92701)),"@site/docs/sdk/reference/interfaces/ICensus.md",92701],d2ab4b32:[()=>n.e(1935).then(n.bind(n,86894)),"@site/docs/sdk/reference/enums/ElectionCreationSteps.md",86894],d46fdf20:[()=>n.e(3044).then(n.bind(n,11260)),"@site/docs/sdk/reference/interfaces/IBudgetElectionParametersInfo.md",11260],d4ce7faf:[()=>n.e(3754).then(n.bind(n,49993)),"@site/docs/sdk/reference/classes/PublishedElection.md",49993],d4d2d783:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(7071)]).then(n.bind(n,48652)),"@site/docs/vocdoni-api/get-block-by-hash.api.mdx",48652],d5851cb1:[()=>n.e(3013).then(n.bind(n,39768)),"@site/docs/sdk/reference/interfaces/ICensusProofResponse.md",39768],d6b477f2:[()=>n.e(1378).then(n.bind(n,16193)),"@site/docs/sdk/reference/interfaces/IElectionParameters.md",16193],d6e648af:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(3086)]).then(n.bind(n,76676)),"@site/docs/vocdoni-api/transfer-tokens.api.mdx",76676],d71b54cc:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(1786)]).then(n.bind(n,71824)),"@site/docs/vocdoni-api/get-type-of-census.api.mdx",71824],d79e07b2:[()=>n.e(1054).then(n.bind(n,79581)),"@site/docs/sdk/reference/interfaces/ICensus3StrategyToken.md",79581],d7d13fd1:[()=>n.e(2005).then(n.bind(n,56065)),"@site/docs/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight.md",56065],d8c91af8:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(1528)]).then(n.bind(n,76382)),"@site/docs/vocdoni-api/returns-if-the-address-provided-has-a-valid-sik.api.mdx",76382],d8c992a6:[()=>n.e(2175).then(n.bind(n,87512)),"@site/docs/sdk/reference/interfaces/ICensus3CensusListResponse.md",87512],d94ccd67:[()=>n.e(67).then(n.bind(n,11021)),"@site/docs/sdk/reference/classes/ChainAPI.md",11021],d970501b:[()=>n.e(1357).then(n.bind(n,73846)),"@site/docs/sdk/reference/interfaces/IInvalidElectionParameters.md",73846],d9f2d88a:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(6142)]).then(n.bind(n,88773)),"@site/docs/vocdoni-api/list-of-the-existing-accounts.api.mdx",88773],dae27e03:[()=>n.e(1738).then(n.bind(n,10146)),"@site/docs/sdk/reference/interfaces/IChainTxReference.md",10146],db5a5176:[()=>n.e(1173).then(n.bind(n,79677)),"@site/docs/sdk/reference/classes/OffchainCensus.md",79677],dcb8c93b:[()=>n.e(8048).then(n.bind(n,38059)),"@site/docs/protocol/census/off-chain-tree.md",38059],ddb99459:[()=>n.e(9379).then(n.bind(n,72221)),"@site/docs/sdk/reference/interfaces/IApprovalElectionParameters.md",72221],dded7333:[()=>n.e(2329).then(n.bind(n,96274)),"@site/docs/sdk/reference/classes/UnpublishedElection.md",96274],de66f94a:[()=>n.e(2691).then(n.bind(n,1306)),"@site/docs/sdk/reference/interfaces/ICensus3StrategyCreateResponse.md",1306],df5c78e6:[()=>Promise.all([n.e(532),n.e(2284),n.e(173)]).then(n.bind(n,96072)),"@site/docs/vocdoni-api/wallet.tag.mdx",96072],dfccb580:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(1142)]).then(n.bind(n,20597)),"@site/docs/vocdoni-api/vochain-information.api.mdx",20597],dffc9575:[()=>n.e(6873).then(n.bind(n,97971)),"@site/docs/sdk/reference/interfaces/IChainTxListResponse.md",97971],e0557e97:[()=>n.e(9203).then(n.bind(n,57047)),"@site/docs/sdk/index.md",57047],e07651bc:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(1084)]).then(n.bind(n,77257)),"@site/docs/vocdoni-api/list-transactions.api.mdx",77257],e1594dfa:[()=>n.e(8257).then(n.bind(n,48021)),"@site/docs/sdk/reference/interfaces/IElectionNextIdResponse.md",48021],e20b99b5:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(6220)]).then(n.bind(n,21848)),"@site/docs/vocdoni-api/get-block-by-height.api.mdx",21848],e3461e1c:[()=>n.e(9849).then(n.bind(n,81870)),"@site/docs/sdk/reference/classes/CspCensus.md",81870],e3cace69:[()=>n.e(9787).then(n.bind(n,42444)),"@site/docs/sdk/voting-types/approval.md",42444],e6e6cd34:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(469)]).then(n.bind(n,9373)),"@site/docs/vocdoni-api/list-organization-elections-by-status.api.mdx",9373],e7df0fec:[()=>n.e(248).then(n.bind(n,74554)),"@site/docs/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse.md",74554],e7ebf400:[()=>n.e(2226).then(n.bind(n,95909)),"@site/docs/ui-components/index.md",95909],e964279c:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(9875)]).then(n.bind(n,95845)),"@site/docs/vocdoni-api/list-elections.api.mdx",95845],e9c5307c:[()=>Promise.all([n.e(532),n.e(2284),n.e(2470)]).then(n.bind(n,84416)),"@site/docs/vocdoni-api/censuses.tag.mdx",84416],ea27d690:[()=>n.e(4108).then(n.bind(n,52653)),"@site/docs/sdk/reference/interfaces/IChainBlockInfoResponse.md",52653],ea74a8a9:[()=>n.e(2832).then(n.bind(n,21047)),"@site/docs/sdk/reference/interfaces/ICensus3StrategiesOperator.md",21047],ec0516f7:[()=>n.e(2050).then(n.bind(n,14510)),"@site/docs/sdk/reference/classes/Vote.md",14510],ed25d525:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(5347)]).then(n.bind(n,7615)),"@site/docs/vocdoni-api/get-account.api.mdx",7615],ed5700b4:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(8493)]).then(n.bind(n,2364)),"@site/docs/vocdoni-api/count-organization-elections.api.mdx",2364],ed887fb8:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(7165)]).then(n.bind(n,43970)),"@site/docs/vocdoni-api/set-account.api.mdx",43970],ee2798c9:[()=>n.e(4635).then(n.bind(n,98272)),"@site/docs/sdk/reference/enums/VoteSteps.md",98272],efcaecf7:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(4792)]).then(n.bind(n,19243)),"@site/docs/vocdoni-api/list-organizations.api.mdx",19243],effdce5d:[()=>n.e(6483).then(n.bind(n,16938)),"@site/docs/sdk/reference/classes/InvalidElection.md",16938],f116289e:[()=>n.e(6349).then(n.bind(n,5431)),"@site/docs/sdk/reference/interfaces/IBudgetElectionParametersWithBudget.md",5431],f4a6fdc0:[()=>n.e(2707).then(n.bind(n,98214)),"@site/docs/sdk/voting-types/weighted.md",98214],f50a63d5:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(3987)]).then(n.bind(n,85089)),"@site/docs/vocdoni-api/list-elections-filtered.api.mdx",85089],f5100261:[()=>n.e(8400).then(n.bind(n,35508)),"@site/docs/sdk/voting-types/voting-types.md",35508],f601f941:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(3665)]).then(n.bind(n,59872)),"@site/docs/vocdoni-api/list-all-token-fees-by-reference.api.mdx",59872],f64e1fa2:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(1317)]).then(n.bind(n,54975)),"@site/docs/vocdoni-api/list-all-token-fees.api.mdx",54975],f77e462c:[()=>n.e(2975).then(n.bind(n,59186)),"@site/docs/sdk/reference/enums/CensusType.md",59186],f8d5f1d3:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(8756)]).then(n.bind(n,284)),"@site/docs/vocdoni-api/estimate-date-to-block.api.mdx",284],f9b740ff:[()=>n.e(4243).then(n.bind(n,86548)),"@site/docs/sdk/reference/enums/ElectionStatusReady.md",86548],fbd96b78:[()=>n.e(2367).then(n.bind(n,41263)),"@site/docs/protocol/census/off-chain-csp.md",41263],fc158ac8:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(5642)]).then(n.bind(n,41937)),"@site/docs/vocdoni-api/list-all-token-fees-by-type.api.mdx",41937],fc1a6383:[()=>n.e(5220).then(n.bind(n,92751)),"@site/docs/sdk/reference/interfaces/IElectionType.md",92751],fc441bf1:[()=>n.e(9192).then(n.bind(n,90821)),"@site/docs/sdk/reference/enums/CensusOrigin.md",90821],fcca6750:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(5913)]).then(n.bind(n,55364)),"@site/docs/vocdoni-api/exports-the-indexer-database.api.mdx",55364],fd8596db:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(1117)]).then(n.bind(n,19227)),"@site/docs/vocdoni-api/add-account.api.mdx",19227],fe008fee:[()=>n.e(2733).then(n.bind(n,38222)),"@site/docs/sdk/reference/classes/Census3CensusAPI.md",38222],fe83dea5:[()=>Promise.all([n.e(532),n.e(2284),n.e(9052),n.e(6057),n.e(6882),n.e(8253)]).then(n.bind(n,12592)),"@site/docs/vocdoni-api/import-census.api.mdx",12592],fe9260cd:[()=>n.e(1132).then(n.bind(n,50031)),"@site/docs/sdk/reference/changelog.md",50031],ff7cb792:[()=>n.e(2241).then(n.bind(n,61292)),"@site/docs/sdk/reference/classes/WalletAPI.md",61292],ffeeb722:[()=>n.e(992).then(n.bind(n,94100)),"@site/docs/sdk/reference/classes/VoteService.md",94100]};function l(e){let{error:t,retry:n,pastDelay:a}=e;return t?r.createElement("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"}},r.createElement("p",null,String(t)),r.createElement("div",null,r.createElement("button",{type:"button",onClick:n},"Retry"))):a?r.createElement("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"}},r.createElement("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb"},r.createElement("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2"},r.createElement("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0"},r.createElement("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})),r.createElement("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0"},r.createElement("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})),r.createElement("circle",{cx:"22",cy:"22",r:"8"},r.createElement("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"}))))):null}var u=n(99670),d=n(30226);function f(e,t){if("*"===e)return i()({loading:l,loader:()=>n.e(4972).then(n.bind(n,4972)),modules:["@theme/NotFound"],webpack:()=>[4972],render(e,t){const n=e.default;return r.createElement(d.z,{value:{plugin:{name:"native",id:"default"}}},r.createElement(n,t))}});const o=s[`${e}-${t}`],f={},p=[],m=[],h=(0,u.Z)(o);return Object.entries(h).forEach((e=>{let[t,n]=e;const r=c[n];r&&(f[t]=r[0],p.push(r[1]),m.push(r[2]))})),i().Map({loading:l,loader:f,modules:p,webpack:()=>m,render(t,n){const i=JSON.parse(JSON.stringify(o));Object.entries(t).forEach((t=>{let[n,r]=t;const a=r.default;if(!a)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof a&&"function"!=typeof a||Object.keys(r).filter((e=>"default"!==e)).forEach((e=>{a[e]=r[e]}));let o=i;const s=n.split(".");s.slice(0,-1).forEach((e=>{o=o[e]})),o[s[s.length-1]]=a}));const s=i.__comp;delete i.__comp;const c=i.__context;return delete i.__context,r.createElement(d.z,{value:c},r.createElement(s,(0,a.Z)({},i,n)))}})}const p=[{path:"/search",component:f("/search","171"),exact:!0},{path:"/",component:f("/","70b"),exact:!0},{path:"/",component:f("/","ce4"),routes:[{path:"/intro",component:f("/intro","9e0"),exact:!0,sidebar:"defaultSidebar"},{path:"/protocol",component:f("/protocol","4f3"),exact:!0,sidebar:"defaultSidebar"},{path:"/protocol/anonymity",component:f("/protocol/anonymity","286"),exact:!0,sidebar:"defaultSidebar"},{path:"/protocol/anonymity/blind-signatures",component:f("/protocol/anonymity/blind-signatures","6c6"),exact:!0,sidebar:"defaultSidebar"},{path:"/protocol/anonymity/on-chain",component:f("/protocol/anonymity/on-chain","746"),exact:!0,sidebar:"defaultSidebar"},{path:"/protocol/anonymity/zk-census-proof",component:f("/protocol/anonymity/zk-census-proof","0dd"),exact:!0,sidebar:"defaultSidebar"},{path:"/protocol/ballot-protocol",component:f("/protocol/ballot-protocol","9e7"),exact:!0,sidebar:"defaultSidebar"},{path:"/protocol/census",component:f("/protocol/census","f2b"),exact:!0,sidebar:"defaultSidebar"},{path:"/protocol/census/off-chain-csp",component:f("/protocol/census/off-chain-csp","cab"),exact:!0,sidebar:"defaultSidebar"},{path:"/protocol/census/off-chain-tree",component:f("/protocol/census/off-chain-tree","add"),exact:!0,sidebar:"defaultSidebar"},{path:"/protocol/census/on-chain",component:f("/protocol/census/on-chain","06d"),exact:!0,sidebar:"defaultSidebar"},{path:"/protocol/data-schemes",component:f("/protocol/data-schemes","684"),exact:!0,sidebar:"defaultSidebar"},{path:"/protocol/data-schemes/election",component:f("/protocol/data-schemes/election","8b1"),exact:!0,sidebar:"defaultSidebar"},{path:"/protocol/data-schemes/organization",component:f("/protocol/data-schemes/organization","38b"),exact:!0,sidebar:"defaultSidebar"},{path:"/protocol/data-schemes/vote",component:f("/protocol/data-schemes/vote","252"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk",component:f("/sdk","857"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/integration-details",component:f("/sdk/integration-details","921"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/changelog",component:f("/sdk/reference/changelog","092"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/Account",component:f("/sdk/reference/classes/Account","4b7"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/AccountAPI",component:f("/sdk/reference/classes/AccountAPI","c96"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/AccountService",component:f("/sdk/reference/classes/AccountService","3d2"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/AnonymousService",component:f("/sdk/reference/classes/AnonymousService","459"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/AnonymousVote",component:f("/sdk/reference/classes/AnonymousVote","873"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/ApprovalElection",component:f("/sdk/reference/classes/ApprovalElection","f04"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/ArchivedElection",component:f("/sdk/reference/classes/ArchivedElection","00d"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/BudgetElection",component:f("/sdk/reference/classes/BudgetElection","0b6"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/Census",component:f("/sdk/reference/classes/Census","a71"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/Census3CensusAPI",component:f("/sdk/reference/classes/Census3CensusAPI","c3a"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/Census3ServiceAPI",component:f("/sdk/reference/classes/Census3ServiceAPI","7b6"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/Census3StrategyAPI",component:f("/sdk/reference/classes/Census3StrategyAPI","056"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/Census3TokenAPI",component:f("/sdk/reference/classes/Census3TokenAPI","a0e"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/CensusAPI",component:f("/sdk/reference/classes/CensusAPI","1e8"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/CensusService",component:f("/sdk/reference/classes/CensusService","5f2"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/ChainAPI",component:f("/sdk/reference/classes/ChainAPI","08b"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/ChainService",component:f("/sdk/reference/classes/ChainService","424"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/CspCensus",component:f("/sdk/reference/classes/CspCensus","66e"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/CspService",component:f("/sdk/reference/classes/CspService","3dc"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/CspVote",component:f("/sdk/reference/classes/CspVote","c3c"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/Election",component:f("/sdk/reference/classes/Election","c48"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/ElectionAPI",component:f("/sdk/reference/classes/ElectionAPI","441"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/ElectionService",component:f("/sdk/reference/classes/ElectionService","533"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/FaucetAPI",component:f("/sdk/reference/classes/FaucetAPI","420"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/FaucetService",component:f("/sdk/reference/classes/FaucetService","32f"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/FileAPI",component:f("/sdk/reference/classes/FileAPI","f1e"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/FileService",component:f("/sdk/reference/classes/FileService","93c"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/InvalidElection",component:f("/sdk/reference/classes/InvalidElection","9cf"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/MultiChoiceElection",component:f("/sdk/reference/classes/MultiChoiceElection","0b1"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/OffchainCensus",component:f("/sdk/reference/classes/OffchainCensus","d39"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/PlainCensus",component:f("/sdk/reference/classes/PlainCensus","858"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/PublishedCensus",component:f("/sdk/reference/classes/PublishedCensus","902"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/PublishedElection",component:f("/sdk/reference/classes/PublishedElection","f5c"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/Service",component:f("/sdk/reference/classes/Service","6cc"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/TokenCensus",component:f("/sdk/reference/classes/TokenCensus","27f"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/UnpublishedElection",component:f("/sdk/reference/classes/UnpublishedElection","664"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/VocdoniCensus3Client",component:f("/sdk/reference/classes/VocdoniCensus3Client","be3"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/VocdoniSDKClient",component:f("/sdk/reference/classes/VocdoniSDKClient","5c3"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/Vote",component:f("/sdk/reference/classes/Vote","9e7"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/VoteAPI",component:f("/sdk/reference/classes/VoteAPI","649"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/VoteService",component:f("/sdk/reference/classes/VoteService","dea"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/WalletAPI",component:f("/sdk/reference/classes/WalletAPI","448"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/classes/WeightedCensus",component:f("/sdk/reference/classes/WeightedCensus","746"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/enums/CensusOrigin",component:f("/sdk/reference/enums/CensusOrigin","58f"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/enums/CensusType",component:f("/sdk/reference/enums/CensusType","e40"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/enums/CensusTypeEnum",component:f("/sdk/reference/enums/CensusTypeEnum","1e7"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/enums/CspProofType",component:f("/sdk/reference/enums/CspProofType","163"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/enums/ElectionCreationSteps",component:f("/sdk/reference/enums/ElectionCreationSteps","b5f"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/enums/ElectionResultsTypeNames",component:f("/sdk/reference/enums/ElectionResultsTypeNames","852"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/enums/ElectionStatus",component:f("/sdk/reference/enums/ElectionStatus","db7"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/enums/ElectionStatusReady",component:f("/sdk/reference/enums/ElectionStatusReady","d13"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/enums/EnvOptions",component:f("/sdk/reference/enums/EnvOptions","81f"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/enums/TransactionType",component:f("/sdk/reference/enums/TransactionType","bf2"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/enums/TxType",component:f("/sdk/reference/enums/TxType","c44"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/enums/VoteSteps",component:f("/sdk/reference/enums/VoteSteps","36c"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/AccountMetadata",component:f("/sdk/reference/interfaces/AccountMetadata","eca"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/AdminTx",component:f("/sdk/reference/interfaces/AdminTx","fc2"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/CircuitInputs",component:f("/sdk/reference/interfaces/CircuitInputs","823"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/CollectFaucetTx",component:f("/sdk/reference/interfaces/CollectFaucetTx","7d0"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ElectionMetadata",component:f("/sdk/reference/interfaces/ElectionMetadata","5c6"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/FetchElectionsParameters",component:f("/sdk/reference/interfaces/FetchElectionsParameters","30b"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IAccount",component:f("/sdk/reference/interfaces/IAccount","a20"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IAccountsCountResponse",component:f("/sdk/reference/interfaces/IAccountsCountResponse","d77"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IAccountsListResponse",component:f("/sdk/reference/interfaces/IAccountsListResponse","2ef"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IAccountTransfersCountResponse",component:f("/sdk/reference/interfaces/IAccountTransfersCountResponse","236"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IApprovalElectionParameters",component:f("/sdk/reference/interfaces/IApprovalElectionParameters","73c"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IBlockTransactionsResponse",component:f("/sdk/reference/interfaces/IBlockTransactionsResponse","c5b"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IBudgetElectionParametersInfo",component:f("/sdk/reference/interfaces/IBudgetElectionParametersInfo","6d4"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget",component:f("/sdk/reference/interfaces/IBudgetElectionParametersWithBudget","c2f"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight",component:f("/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight","1a7"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus",component:f("/sdk/reference/interfaces/ICensus","565"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3CensusListResponse",component:f("/sdk/reference/interfaces/ICensus3CensusListResponse","e3e"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3CensusQueueResponse",component:f("/sdk/reference/interfaces/ICensus3CensusQueueResponse","858"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3CensusResponse",component:f("/sdk/reference/interfaces/ICensus3CensusResponse","4be"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3ServiceInfoResponse",component:f("/sdk/reference/interfaces/ICensus3ServiceInfoResponse","b0b"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3StrategiesListResponse",component:f("/sdk/reference/interfaces/ICensus3StrategiesListResponse","f71"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated",component:f("/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated","ba4"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3StrategiesOperator",component:f("/sdk/reference/interfaces/ICensus3StrategiesOperator","661"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse",component:f("/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse","a61"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3StrategyCreateResponse",component:f("/sdk/reference/interfaces/ICensus3StrategyCreateResponse","0ec"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse",component:f("/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse","e02"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse",component:f("/sdk/reference/interfaces/ICensus3StrategyHoldersResponse","445"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated",component:f("/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated","240"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse",component:f("/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse","197"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3StrategyToken",component:f("/sdk/reference/interfaces/ICensus3StrategyToken","844"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3SupportedChain",component:f("/sdk/reference/interfaces/ICensus3SupportedChain","cbd"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3TokenHolderResponse",component:f("/sdk/reference/interfaces/ICensus3TokenHolderResponse","c9f"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3TokenListResponse",component:f("/sdk/reference/interfaces/ICensus3TokenListResponse","5af"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated",component:f("/sdk/reference/interfaces/ICensus3TokenListResponsePaginated","b69"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3TokenTypesResponse",component:f("/sdk/reference/interfaces/ICensus3TokenTypesResponse","13c"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3ValidatePredicateChild",component:f("/sdk/reference/interfaces/ICensus3ValidatePredicateChild","ed2"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse",component:f("/sdk/reference/interfaces/ICensus3ValidatePredicateResponse","d24"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensus3ValidatePredicateToken",component:f("/sdk/reference/interfaces/ICensus3ValidatePredicateToken","4cd"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensusExportResponse",component:f("/sdk/reference/interfaces/ICensusExportResponse","a9a"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensusImportResponse",component:f("/sdk/reference/interfaces/ICensusImportResponse","77c"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensusParticipant",component:f("/sdk/reference/interfaces/ICensusParticipant","9b0"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensusProofResponse",component:f("/sdk/reference/interfaces/ICensusProofResponse","dfb"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ICensusPublishResponse",component:f("/sdk/reference/interfaces/ICensusPublishResponse","3a7"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IChainBlockInfoResponse",component:f("/sdk/reference/interfaces/IChainBlockInfoResponse","bfc"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IChainGetCircuitResponse",component:f("/sdk/reference/interfaces/IChainGetCircuitResponse","dfd"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IChainGetCostsResponse",component:f("/sdk/reference/interfaces/IChainGetCostsResponse","9b1"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IChainGetInfoResponse",component:f("/sdk/reference/interfaces/IChainGetInfoResponse","1cd"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IChainOrganizationCountResponse",component:f("/sdk/reference/interfaces/IChainOrganizationCountResponse","53f"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IChainOrganizationListResponse",component:f("/sdk/reference/interfaces/IChainOrganizationListResponse","e0c"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IChainOrganizationResponse",component:f("/sdk/reference/interfaces/IChainOrganizationResponse","663"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IChainSubmitTxResponse",component:f("/sdk/reference/interfaces/IChainSubmitTxResponse","cfa"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IChainTxCountResponse",component:f("/sdk/reference/interfaces/IChainTxCountResponse","526"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IChainTxListResponse",component:f("/sdk/reference/interfaces/IChainTxListResponse","c57"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IChainTxReference",component:f("/sdk/reference/interfaces/IChainTxReference","804"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IChainValidator",component:f("/sdk/reference/interfaces/IChainValidator","932"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IChainValidatorsListResponse",component:f("/sdk/reference/interfaces/IChainValidatorsListResponse","bdb"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IChoice",component:f("/sdk/reference/interfaces/IChoice","21d"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IElectionCreateResponse",component:f("/sdk/reference/interfaces/IElectionCreateResponse","f95"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IElectionInfoResponse",component:f("/sdk/reference/interfaces/IElectionInfoResponse","bcf"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IElectionKeysResponse",component:f("/sdk/reference/interfaces/IElectionKeysResponse","db8"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IElectionListFilter",component:f("/sdk/reference/interfaces/IElectionListFilter","f8b"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IElectionListResponse",component:f("/sdk/reference/interfaces/IElectionListResponse","acd"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IElectionMode",component:f("/sdk/reference/interfaces/IElectionMode","fbb"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IElectionNextIdResponse",component:f("/sdk/reference/interfaces/IElectionNextIdResponse","107"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IElectionParameters",component:f("/sdk/reference/interfaces/IElectionParameters","077"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IElectionSummary",component:f("/sdk/reference/interfaces/IElectionSummary","cc4"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IElectionType",component:f("/sdk/reference/interfaces/IElectionType","77e"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IElectionVote",component:f("/sdk/reference/interfaces/IElectionVote","0c5"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IElectionVoteListResponse",component:f("/sdk/reference/interfaces/IElectionVoteListResponse","300"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IEncryptionKey",component:f("/sdk/reference/interfaces/IEncryptionKey","4e6"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IInvalidElectionParameters",component:f("/sdk/reference/interfaces/IInvalidElectionParameters","861"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IMultiChoiceElectionParameters",component:f("/sdk/reference/interfaces/IMultiChoiceElectionParameters","b37"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IPublishedElectionParameters",component:f("/sdk/reference/interfaces/IPublishedElectionParameters","a41"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IQuestion",component:f("/sdk/reference/interfaces/IQuestion","8bd"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ITallyMode",component:f("/sdk/reference/interfaces/ITallyMode","2fd"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IVoteInfoResponse",component:f("/sdk/reference/interfaces/IVoteInfoResponse","d2d"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IVoteMode",component:f("/sdk/reference/interfaces/IVoteMode","f25"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IVoteSubmitResponse",component:f("/sdk/reference/interfaces/IVoteSubmitResponse","db7"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/IVoteType",component:f("/sdk/reference/interfaces/IVoteType","7bb"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/MintTokensTx",component:f("/sdk/reference/interfaces/MintTokensTx","2f2"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/NewProcessTx",component:f("/sdk/reference/interfaces/NewProcessTx","4ae"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/Process",component:f("/sdk/reference/interfaces/Process","0e8"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/Proof",component:f("/sdk/reference/interfaces/Proof","b2c"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/RegisterKeyTx",component:f("/sdk/reference/interfaces/RegisterKeyTx","ad2"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/SendTokensTx",component:f("/sdk/reference/interfaces/SendTokensTx","5ac"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/ServiceProperties",component:f("/sdk/reference/interfaces/ServiceProperties","05a"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/SetAccountTx",component:f("/sdk/reference/interfaces/SetAccountTx","8bd"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/SetProcessTx",component:f("/sdk/reference/interfaces/SetProcessTx","2cc"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/SetTransactionCostsTx",component:f("/sdk/reference/interfaces/SetTransactionCostsTx","3e1"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/Tx",component:f("/sdk/reference/interfaces/Tx","bdf"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/interfaces/VoteEnvelope",component:f("/sdk/reference/interfaces/VoteEnvelope","a38"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/reference/modules",component:f("/sdk/reference/modules","89f"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/tutorial",component:f("/sdk/tutorial","99b"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/voting-types",component:f("/sdk/voting-types","b15"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/voting-types/approval",component:f("/sdk/voting-types/approval","df2"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/voting-types/quadratic",component:f("/sdk/voting-types/quadratic","b12"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/voting-types/ranked",component:f("/sdk/voting-types/ranked","472"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/voting-types/single-choice",component:f("/sdk/voting-types/single-choice","e27"),exact:!0,sidebar:"defaultSidebar"},{path:"/sdk/voting-types/weighted",component:f("/sdk/voting-types/weighted","6df"),exact:!0,sidebar:"defaultSidebar"},{path:"/ui-components",component:f("/ui-components","0d2"),exact:!0,sidebar:"defaultSidebar"},{path:"/ui-components/Election",component:f("/ui-components/Election","34a"),exact:!0,sidebar:"defaultSidebar"},{path:"/ui-components/Organization",component:f("/ui-components/Organization","cc6"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/accounts",component:f("/vocdoni-api/accounts","2d1"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/add-account",component:f("/vocdoni-api/add-account","3a5"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/add-participants-to-census",component:f("/vocdoni-api/add-participants-to-census","9e3"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/census-merkle-root",component:f("/vocdoni-api/census-merkle-root","863"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/census-size",component:f("/vocdoni-api/census-size","2da"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/census-total-weight",component:f("/vocdoni-api/census-total-weight","0da"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/censuses",component:f("/vocdoni-api/censuses","23b"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/chain",component:f("/vocdoni-api/chain","179"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/circuit-info",component:f("/vocdoni-api/circuit-info","b04"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/compute-election-price",component:f("/vocdoni-api/compute-election-price","2b3"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/compute-ipfs-ci-dv-1-of-file",component:f("/vocdoni-api/compute-ipfs-ci-dv-1-of-file","77c"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/count-election-votes",component:f("/vocdoni-api/count-election-votes","47e"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/count-organization-elections",component:f("/vocdoni-api/count-organization-elections","e48"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/count-organizations",component:f("/vocdoni-api/count-organizations","e64"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/create-a-new-census",component:f("/vocdoni-api/create-a-new-census","3dd"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/create-election",component:f("/vocdoni-api/create-election","af1"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/create-election-for-wallet",component:f("/vocdoni-api/create-election-for-wallet","350"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/delete-census",component:f("/vocdoni-api/delete-census","6fa"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/election-information",component:f("/vocdoni-api/election-information","45d"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/election-results",component:f("/vocdoni-api/election-results","fef"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/elections",component:f("/vocdoni-api/elections","35c"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/estimate-block-to-date",component:f("/vocdoni-api/estimate-block-to-date","de0"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/estimate-date-to-block",component:f("/vocdoni-api/estimate-date-to-block","a33"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/export-census",component:f("/vocdoni-api/export-census","5de"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/export-census-database",component:f("/vocdoni-api/export-census-database","755"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/exports-the-indexer-database",component:f("/vocdoni-api/exports-the-indexer-database","b29"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/get-account",component:f("/vocdoni-api/get-account","358"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/get-block-by-hash",component:f("/vocdoni-api/get-block-by-hash","e3b"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/get-block-by-height",component:f("/vocdoni-api/get-block-by-height","196"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/get-next-election-id",component:f("/vocdoni-api/get-next-election-id","486"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/get-type-of-census",component:f("/vocdoni-api/get-type-of-census","e28"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/get-vote",component:f("/vocdoni-api/get-vote","f8b"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/import-census",component:f("/vocdoni-api/import-census","f56"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/import-census-database",component:f("/vocdoni-api/import-census-database","e4d"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-account-received-and-sent-token-transfers",component:f("/vocdoni-api/list-account-received-and-sent-token-transfers","ec6"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-account-token-fees",component:f("/vocdoni-api/list-account-token-fees","218"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-all-census-references",component:f("/vocdoni-api/list-all-census-references","f26"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-all-token-fees",component:f("/vocdoni-api/list-all-token-fees","c3b"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-all-token-fees-by-reference",component:f("/vocdoni-api/list-all-token-fees-by-reference","c03"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-all-token-fees-by-type",component:f("/vocdoni-api/list-all-token-fees-by-type","e34"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-election-votes",component:f("/vocdoni-api/list-election-votes","7df"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-elections",component:f("/vocdoni-api/list-elections","a7c"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-elections-filtered",component:f("/vocdoni-api/list-elections-filtered","70c"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-encryption-keys",component:f("/vocdoni-api/list-encryption-keys","b8d"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-of-the-existing-accounts",component:f("/vocdoni-api/list-of-the-existing-accounts","a3d"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-of-valid-sik-roots",component:f("/vocdoni-api/list-of-valid-sik-roots","c85"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-organization-elections",component:f("/vocdoni-api/list-organization-elections","ce8"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-organization-elections-by-status",component:f("/vocdoni-api/list-organization-elections-by-status","6f8"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-organizations",component:f("/vocdoni-api/list-organizations","8b0"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-organizations-filtered",component:f("/vocdoni-api/list-organizations-filtered","554"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-transactions",component:f("/vocdoni-api/list-transactions","541"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/list-validators",component:f("/vocdoni-api/list-validators","66d"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/price-factors-information",component:f("/vocdoni-api/price-factors-information","093"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/prove-key-to-census",component:f("/vocdoni-api/prove-key-to-census","af9"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/publish-census",component:f("/vocdoni-api/publish-census","a10"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/publish-census-at-root",component:f("/vocdoni-api/publish-census-at-root","4fb"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/returns-if-the-address-provided-has-a-valid-sik",component:f("/vocdoni-api/returns-if-the-address-provided-has-a-valid-sik","1e5"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/set-account",component:f("/vocdoni-api/set-account","df9"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/set-wallet-account",component:f("/vocdoni-api/set-wallet-account","97c"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/sik",component:f("/vocdoni-api/sik","f12"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/submit-a-vote",component:f("/vocdoni-api/submit-a-vote","8a0"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/submit-transaction",component:f("/vocdoni-api/submit-transaction","6cd"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/total-number-of-accounts",component:f("/vocdoni-api/total-number-of-accounts","cfa"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/total-number-of-sent-and-received-transactions",component:f("/vocdoni-api/total-number-of-sent-and-received-transactions","118"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/transaction-by-block-height-and-index",component:f("/vocdoni-api/transaction-by-block-height-and-index","b15"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/transaction-by-hash",component:f("/vocdoni-api/transaction-by-hash","0d9"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/transaction-by-index",component:f("/vocdoni-api/transaction-by-index","ddf"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/transaction-costs",component:f("/vocdoni-api/transaction-costs","99d"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/transactions-count",component:f("/vocdoni-api/transactions-count","2b2"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/transactions-in-a-block",component:f("/vocdoni-api/transactions-in-a-block","9d9"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/transfer-tokens",component:f("/vocdoni-api/transfer-tokens","ebf"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/verify-merkle-proof",component:f("/vocdoni-api/verify-merkle-proof","642"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/verify-vote",component:f("/vocdoni-api/verify-vote","d94"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/vocdoni-api",component:f("/vocdoni-api/vocdoni-api","2b0"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/vochain-information",component:f("/vocdoni-api/vochain-information","9f5"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/votes",component:f("/vocdoni-api/votes","541"),exact:!0,sidebar:"defaultSidebar"},{path:"/vocdoni-api/wallet",component:f("/vocdoni-api/wallet","c13"),exact:!0,sidebar:"defaultSidebar"}]},{path:"*",component:f("*")}]},98934:(e,t,n)=>{"use strict";n.d(t,{_:()=>a,t:()=>o});var r=n(67294);const a=r.createContext(!1);function o(e){let{children:t}=e;const[n,o]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{o(!0)}),[]),r.createElement(a.Provider,{value:n},t)}},49383:(e,t,n)=>{"use strict";var r=n(67294),a=n(73935),o=n(73727),i=n(70405),s=n(10412);const c=[n(32497),n(3310),n(18320),n(52295),n(93524),n(79362),n(87406),n(86199),n(56748)];var l=n(723),u=n(16550),d=n(18790);function f(e){let{children:t}=e;return r.createElement(r.Fragment,null,t)}var p=n(87462),m=n(35742),h=n(52263),b=n(44996),g=n(86668),v=n(10833),y=n(94711),k=n(19727),S=n(43320),w=n(90197);function E(){const{i18n:{defaultLocale:e,localeConfigs:t}}=(0,h.Z)(),n=(0,y.l)();return r.createElement(m.Z,null,Object.entries(t).map((e=>{let[t,{htmlLang:a}]=e;return r.createElement("link",{key:t,rel:"alternate",href:n.createUrl({locale:t,fullyQualified:!0}),hrefLang:a})})),r.createElement("link",{rel:"alternate",href:n.createUrl({locale:e,fullyQualified:!0}),hrefLang:"x-default"}))}function x(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,h.Z)(),a=function(){const{siteConfig:{url:e}}=(0,h.Z)(),{pathname:t}=(0,u.TH)();return e+(0,b.Z)(t)}(),o=t?`${n}${t}`:a;return r.createElement(m.Z,null,r.createElement("meta",{property:"og:url",content:o}),r.createElement("link",{rel:"canonical",href:o}))}function C(){const{i18n:{currentLocale:e}}=(0,h.Z)(),{metadata:t,image:n}=(0,g.L)();return r.createElement(r.Fragment,null,r.createElement(m.Z,null,r.createElement("meta",{name:"twitter:card",content:"summary_large_image"}),r.createElement("body",{className:k.h})),n&&r.createElement(v.d,{image:n}),r.createElement(x,null),r.createElement(E,null),r.createElement(w.Z,{tag:S.HX,locale:e}),r.createElement(m.Z,null,t.map(((e,t)=>r.createElement("meta",(0,p.Z)({key:t},e))))))}const _=new Map;function I(e){if(_.has(e.pathname))return{...e,pathname:_.get(e.pathname)};if((0,d.f)(l.Z,e.pathname).some((e=>{let{route:t}=e;return!0===t.exact})))return _.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return _.set(e.pathname,t),{...e,pathname:t}}var T=n(98934),P=n(58940);function A(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r(t.default?.[e]??t[e])?.(...n)));return()=>a.forEach((e=>e?.()))}const R=function(e){let{children:t,location:n,previousLocation:a}=e;return(0,r.useLayoutEffect)((()=>{a!==n&&(a&&function(e){const{hash:t}=e;if(t){const e=decodeURIComponent(t.substring(1));document.getElementById(e)?.scrollIntoView()}else window.scrollTo(0,0)}(n),A("onRouteDidUpdate",{previousLocation:a,location:n}))}),[a,n]),t};function L(e){const t=Array.from(new Set([e,decodeURI(e)])).map((e=>(0,d.f)(l.Z,e))).flat();return Promise.all(t.map((e=>e.route.component.preload?.())))}class O extends r.Component{constructor(e){super(e),this.previousLocation=void 0,this.routeUpdateCleanupCb=void 0,this.previousLocation=null,this.routeUpdateCleanupCb=s.Z.canUseDOM?A("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const n=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=A("onRouteUpdate",{previousLocation:this.previousLocation,location:n}),L(n.pathname).then((()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})})).catch((e=>{console.warn(e),window.location.reload()})),!1}render(){const{children:e,location:t}=this.props;return r.createElement(R,{previousLocation:this.previousLocation,location:t},r.createElement(u.AW,{location:t,render:()=>e}))}}const N=O,M="docusaurus-base-url-issue-banner-container",D="docusaurus-base-url-issue-banner-suggestion-container",z="__DOCUSAURUS_INSERT_BASEURL_BANNER";function F(e){return`\nwindow['${z}'] = true;\n\ndocument.addEventListener('DOMContentLoaded', maybeInsertBanner);\n\nfunction maybeInsertBanner() {\n var shouldInsert = window['${z}'];\n shouldInsert && insertBanner();\n}\n\nfunction insertBanner() {\n var bannerContainer = document.getElementById('${M}');\n if (!bannerContainer) {\n return;\n }\n var bannerHtml = ${JSON.stringify(function(e){return`\n
\n

Your Docusaurus site did not load properly.

\n

A very common reason is a wrong site baseUrl configuration.

\n

Current configured baseUrl = ${e} ${"/"===e?" (default value)":""}

\n

We suggest trying baseUrl =

\n
\n`}(e)).replace(/{window[z]=!1}),[]),r.createElement(r.Fragment,null,!s.Z.canUseDOM&&r.createElement(m.Z,null,r.createElement("script",null,F(e))),r.createElement("div",{id:M}))}function $(){const{siteConfig:{baseUrl:e,baseUrlIssueBanner:t}}=(0,h.Z)(),{pathname:n}=(0,u.TH)();return t&&n===e?r.createElement(B,null):null}function U(){const{siteConfig:{favicon:e,title:t,noIndex:n},i18n:{currentLocale:a,localeConfigs:o}}=(0,h.Z)(),i=(0,b.Z)(e),{htmlLang:s,direction:c}=o[a];return r.createElement(m.Z,null,r.createElement("html",{lang:s,dir:c}),r.createElement("title",null,t),r.createElement("meta",{property:"og:title",content:t}),r.createElement("meta",{name:"viewport",content:"width=device-width, initial-scale=1.0"}),n&&r.createElement("meta",{name:"robots",content:"noindex, nofollow"}),e&&r.createElement("link",{rel:"icon",href:i}))}var j=n(44763);function V(){const e=(0,d.H)(l.Z),t=(0,u.TH)();return r.createElement(j.Z,null,r.createElement(P.M,null,r.createElement(T.t,null,r.createElement(f,null,r.createElement(U,null),r.createElement(C,null),r.createElement($,null),r.createElement(N,{location:I(t)},e)))))}var Z=n(16887);const H=function(e){try{return document.createElement("link").relList.supports(e)}catch{return!1}}("prefetch")?function(e){return new Promise(((t,n)=>{if("undefined"==typeof document)return void n();const r=document.createElement("link");r.setAttribute("rel","prefetch"),r.setAttribute("href",e),r.onload=()=>t(),r.onerror=()=>n();(document.getElementsByTagName("head")[0]??document.getElementsByName("script")[0]?.parentNode)?.appendChild(r)}))}:function(e){return new Promise(((t,n)=>{const r=new XMLHttpRequest;r.open("GET",e,!0),r.withCredentials=!0,r.onload=()=>{200===r.status?t():n()},r.send(null)}))};var W=n(99670);const G=new Set,q=new Set,K=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,Y={prefetch(e){if(!(e=>!K()&&!q.has(e)&&!G.has(e))(e))return!1;G.add(e);const t=(0,d.f)(l.Z,e).flatMap((e=>{return t=e.route.path,Object.entries(Z).filter((e=>{let[n]=e;return n.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,W.Z)(t))}));var t}));return Promise.all(t.map((e=>{const t=n.gca(e);return t&&!t.includes("undefined")?H(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!K()&&!q.has(e))(e)&&(q.add(e),L(e))},Q=Object.freeze(Y);if(s.Z.canUseDOM){window.docusaurus=Q;const e=a.hydrate;L(window.location.pathname).then((()=>{e(r.createElement(i.B6,null,r.createElement(o.VK,null,r.createElement(V,null))),document.getElementById("__docusaurus"))}))}},58940:(e,t,n)=>{"use strict";n.d(t,{_:()=>u,M:()=>d});var r=n(67294),a=n(36809);const o=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"path":"/","versions":[{"name":"current","label":"Next","isLast":true,"path":"/","mainDocId":"intro","docs":[{"id":"intro","path":"/intro","sidebar":"defaultSidebar"},{"id":"protocol/anonymity/anonymity","path":"/protocol/anonymity/","sidebar":"defaultSidebar"},{"id":"protocol/anonymity/blind-signatures","path":"/protocol/anonymity/blind-signatures","sidebar":"defaultSidebar"},{"id":"protocol/anonymity/on-chain","path":"/protocol/anonymity/on-chain","sidebar":"defaultSidebar"},{"id":"protocol/anonymity/zk-census-proof","path":"/protocol/anonymity/zk-census-proof","sidebar":"defaultSidebar"},{"id":"protocol/ballot-protocol","path":"/protocol/ballot-protocol","sidebar":"defaultSidebar"},{"id":"protocol/census/census","path":"/protocol/census/","sidebar":"defaultSidebar"},{"id":"protocol/census/off-chain-csp","path":"/protocol/census/off-chain-csp","sidebar":"defaultSidebar"},{"id":"protocol/census/off-chain-tree","path":"/protocol/census/off-chain-tree","sidebar":"defaultSidebar"},{"id":"protocol/census/on-chain","path":"/protocol/census/on-chain","sidebar":"defaultSidebar"},{"id":"protocol/data-schemes/data-schemes","path":"/protocol/data-schemes/","sidebar":"defaultSidebar"},{"id":"protocol/data-schemes/election","path":"/protocol/data-schemes/election","sidebar":"defaultSidebar"},{"id":"protocol/data-schemes/organization","path":"/protocol/data-schemes/organization","sidebar":"defaultSidebar"},{"id":"protocol/data-schemes/vote","path":"/protocol/data-schemes/vote","sidebar":"defaultSidebar"},{"id":"protocol/index","path":"/protocol/","sidebar":"defaultSidebar"},{"id":"sdk/index","path":"/sdk/","sidebar":"defaultSidebar"},{"id":"sdk/integration-details","path":"/sdk/integration-details","sidebar":"defaultSidebar"},{"id":"sdk/reference/changelog","path":"/sdk/reference/changelog","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/Account","path":"/sdk/reference/classes/Account","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/AccountAPI","path":"/sdk/reference/classes/AccountAPI","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/AccountService","path":"/sdk/reference/classes/AccountService","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/AnonymousService","path":"/sdk/reference/classes/AnonymousService","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/AnonymousVote","path":"/sdk/reference/classes/AnonymousVote","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/ApprovalElection","path":"/sdk/reference/classes/ApprovalElection","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/ArchivedElection","path":"/sdk/reference/classes/ArchivedElection","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/BudgetElection","path":"/sdk/reference/classes/BudgetElection","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/Census","path":"/sdk/reference/classes/Census","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/Census3CensusAPI","path":"/sdk/reference/classes/Census3CensusAPI","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/Census3ServiceAPI","path":"/sdk/reference/classes/Census3ServiceAPI","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/Census3StrategyAPI","path":"/sdk/reference/classes/Census3StrategyAPI","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/Census3TokenAPI","path":"/sdk/reference/classes/Census3TokenAPI","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/CensusAPI","path":"/sdk/reference/classes/CensusAPI","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/CensusService","path":"/sdk/reference/classes/CensusService","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/ChainAPI","path":"/sdk/reference/classes/ChainAPI","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/ChainService","path":"/sdk/reference/classes/ChainService","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/CspCensus","path":"/sdk/reference/classes/CspCensus","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/CspService","path":"/sdk/reference/classes/CspService","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/CspVote","path":"/sdk/reference/classes/CspVote","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/Election","path":"/sdk/reference/classes/Election","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/ElectionAPI","path":"/sdk/reference/classes/ElectionAPI","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/ElectionService","path":"/sdk/reference/classes/ElectionService","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/FaucetAPI","path":"/sdk/reference/classes/FaucetAPI","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/FaucetService","path":"/sdk/reference/classes/FaucetService","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/FileAPI","path":"/sdk/reference/classes/FileAPI","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/FileService","path":"/sdk/reference/classes/FileService","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/InvalidElection","path":"/sdk/reference/classes/InvalidElection","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/MultiChoiceElection","path":"/sdk/reference/classes/MultiChoiceElection","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/OffchainCensus","path":"/sdk/reference/classes/OffchainCensus","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/PlainCensus","path":"/sdk/reference/classes/PlainCensus","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/PublishedCensus","path":"/sdk/reference/classes/PublishedCensus","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/PublishedElection","path":"/sdk/reference/classes/PublishedElection","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/Service","path":"/sdk/reference/classes/Service","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/TokenCensus","path":"/sdk/reference/classes/TokenCensus","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/UnpublishedElection","path":"/sdk/reference/classes/UnpublishedElection","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/VocdoniCensus3Client","path":"/sdk/reference/classes/VocdoniCensus3Client","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/VocdoniSDKClient","path":"/sdk/reference/classes/VocdoniSDKClient","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/Vote","path":"/sdk/reference/classes/Vote","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/VoteAPI","path":"/sdk/reference/classes/VoteAPI","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/VoteService","path":"/sdk/reference/classes/VoteService","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/WalletAPI","path":"/sdk/reference/classes/WalletAPI","sidebar":"defaultSidebar"},{"id":"sdk/reference/classes/WeightedCensus","path":"/sdk/reference/classes/WeightedCensus","sidebar":"defaultSidebar"},{"id":"sdk/reference/enums/CensusOrigin","path":"/sdk/reference/enums/CensusOrigin","sidebar":"defaultSidebar"},{"id":"sdk/reference/enums/CensusType","path":"/sdk/reference/enums/CensusType","sidebar":"defaultSidebar"},{"id":"sdk/reference/enums/CensusTypeEnum","path":"/sdk/reference/enums/CensusTypeEnum","sidebar":"defaultSidebar"},{"id":"sdk/reference/enums/CspProofType","path":"/sdk/reference/enums/CspProofType","sidebar":"defaultSidebar"},{"id":"sdk/reference/enums/ElectionCreationSteps","path":"/sdk/reference/enums/ElectionCreationSteps","sidebar":"defaultSidebar"},{"id":"sdk/reference/enums/ElectionResultsTypeNames","path":"/sdk/reference/enums/ElectionResultsTypeNames","sidebar":"defaultSidebar"},{"id":"sdk/reference/enums/ElectionStatus","path":"/sdk/reference/enums/ElectionStatus","sidebar":"defaultSidebar"},{"id":"sdk/reference/enums/ElectionStatusReady","path":"/sdk/reference/enums/ElectionStatusReady","sidebar":"defaultSidebar"},{"id":"sdk/reference/enums/EnvOptions","path":"/sdk/reference/enums/EnvOptions","sidebar":"defaultSidebar"},{"id":"sdk/reference/enums/TransactionType","path":"/sdk/reference/enums/TransactionType","sidebar":"defaultSidebar"},{"id":"sdk/reference/enums/TxType","path":"/sdk/reference/enums/TxType","sidebar":"defaultSidebar"},{"id":"sdk/reference/enums/VoteSteps","path":"/sdk/reference/enums/VoteSteps","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/AccountMetadata","path":"/sdk/reference/interfaces/AccountMetadata","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/AdminTx","path":"/sdk/reference/interfaces/AdminTx","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/CircuitInputs","path":"/sdk/reference/interfaces/CircuitInputs","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/CollectFaucetTx","path":"/sdk/reference/interfaces/CollectFaucetTx","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ElectionMetadata","path":"/sdk/reference/interfaces/ElectionMetadata","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/FetchElectionsParameters","path":"/sdk/reference/interfaces/FetchElectionsParameters","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IAccount","path":"/sdk/reference/interfaces/IAccount","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IAccountsCountResponse","path":"/sdk/reference/interfaces/IAccountsCountResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IAccountsListResponse","path":"/sdk/reference/interfaces/IAccountsListResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IAccountTransfersCountResponse","path":"/sdk/reference/interfaces/IAccountTransfersCountResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IApprovalElectionParameters","path":"/sdk/reference/interfaces/IApprovalElectionParameters","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IBlockTransactionsResponse","path":"/sdk/reference/interfaces/IBlockTransactionsResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IBudgetElectionParametersInfo","path":"/sdk/reference/interfaces/IBudgetElectionParametersInfo","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IBudgetElectionParametersWithBudget","path":"/sdk/reference/interfaces/IBudgetElectionParametersWithBudget","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight","path":"/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus","path":"/sdk/reference/interfaces/ICensus","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3CensusListResponse","path":"/sdk/reference/interfaces/ICensus3CensusListResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3CensusQueueResponse","path":"/sdk/reference/interfaces/ICensus3CensusQueueResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3CensusResponse","path":"/sdk/reference/interfaces/ICensus3CensusResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3ServiceInfoResponse","path":"/sdk/reference/interfaces/ICensus3ServiceInfoResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3StrategiesListResponse","path":"/sdk/reference/interfaces/ICensus3StrategiesListResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated","path":"/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3StrategiesOperator","path":"/sdk/reference/interfaces/ICensus3StrategiesOperator","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse","path":"/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3StrategyCreateResponse","path":"/sdk/reference/interfaces/ICensus3StrategyCreateResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse","path":"/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3StrategyHoldersResponse","path":"/sdk/reference/interfaces/ICensus3StrategyHoldersResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated","path":"/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3StrategyImportQueueResponse","path":"/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3StrategyToken","path":"/sdk/reference/interfaces/ICensus3StrategyToken","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3SupportedChain","path":"/sdk/reference/interfaces/ICensus3SupportedChain","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3TokenHolderResponse","path":"/sdk/reference/interfaces/ICensus3TokenHolderResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3TokenListResponse","path":"/sdk/reference/interfaces/ICensus3TokenListResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3TokenListResponsePaginated","path":"/sdk/reference/interfaces/ICensus3TokenListResponsePaginated","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3TokenTypesResponse","path":"/sdk/reference/interfaces/ICensus3TokenTypesResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3ValidatePredicateChild","path":"/sdk/reference/interfaces/ICensus3ValidatePredicateChild","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3ValidatePredicateResponse","path":"/sdk/reference/interfaces/ICensus3ValidatePredicateResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensus3ValidatePredicateToken","path":"/sdk/reference/interfaces/ICensus3ValidatePredicateToken","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensusExportResponse","path":"/sdk/reference/interfaces/ICensusExportResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensusImportResponse","path":"/sdk/reference/interfaces/ICensusImportResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensusParticipant","path":"/sdk/reference/interfaces/ICensusParticipant","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensusProofResponse","path":"/sdk/reference/interfaces/ICensusProofResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ICensusPublishResponse","path":"/sdk/reference/interfaces/ICensusPublishResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IChainBlockInfoResponse","path":"/sdk/reference/interfaces/IChainBlockInfoResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IChainGetCircuitResponse","path":"/sdk/reference/interfaces/IChainGetCircuitResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IChainGetCostsResponse","path":"/sdk/reference/interfaces/IChainGetCostsResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IChainGetInfoResponse","path":"/sdk/reference/interfaces/IChainGetInfoResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IChainOrganizationCountResponse","path":"/sdk/reference/interfaces/IChainOrganizationCountResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IChainOrganizationListResponse","path":"/sdk/reference/interfaces/IChainOrganizationListResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IChainOrganizationResponse","path":"/sdk/reference/interfaces/IChainOrganizationResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IChainSubmitTxResponse","path":"/sdk/reference/interfaces/IChainSubmitTxResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IChainTxCountResponse","path":"/sdk/reference/interfaces/IChainTxCountResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IChainTxListResponse","path":"/sdk/reference/interfaces/IChainTxListResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IChainTxReference","path":"/sdk/reference/interfaces/IChainTxReference","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IChainValidator","path":"/sdk/reference/interfaces/IChainValidator","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IChainValidatorsListResponse","path":"/sdk/reference/interfaces/IChainValidatorsListResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IChoice","path":"/sdk/reference/interfaces/IChoice","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IElectionCreateResponse","path":"/sdk/reference/interfaces/IElectionCreateResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IElectionInfoResponse","path":"/sdk/reference/interfaces/IElectionInfoResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IElectionKeysResponse","path":"/sdk/reference/interfaces/IElectionKeysResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IElectionListFilter","path":"/sdk/reference/interfaces/IElectionListFilter","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IElectionListResponse","path":"/sdk/reference/interfaces/IElectionListResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IElectionMode","path":"/sdk/reference/interfaces/IElectionMode","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IElectionNextIdResponse","path":"/sdk/reference/interfaces/IElectionNextIdResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IElectionParameters","path":"/sdk/reference/interfaces/IElectionParameters","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IElectionSummary","path":"/sdk/reference/interfaces/IElectionSummary","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IElectionType","path":"/sdk/reference/interfaces/IElectionType","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IElectionVote","path":"/sdk/reference/interfaces/IElectionVote","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IElectionVoteListResponse","path":"/sdk/reference/interfaces/IElectionVoteListResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IEncryptionKey","path":"/sdk/reference/interfaces/IEncryptionKey","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IInvalidElectionParameters","path":"/sdk/reference/interfaces/IInvalidElectionParameters","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IMultiChoiceElectionParameters","path":"/sdk/reference/interfaces/IMultiChoiceElectionParameters","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IPublishedElectionParameters","path":"/sdk/reference/interfaces/IPublishedElectionParameters","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IQuestion","path":"/sdk/reference/interfaces/IQuestion","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ITallyMode","path":"/sdk/reference/interfaces/ITallyMode","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IVoteInfoResponse","path":"/sdk/reference/interfaces/IVoteInfoResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IVoteMode","path":"/sdk/reference/interfaces/IVoteMode","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IVoteSubmitResponse","path":"/sdk/reference/interfaces/IVoteSubmitResponse","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/IVoteType","path":"/sdk/reference/interfaces/IVoteType","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/MintTokensTx","path":"/sdk/reference/interfaces/MintTokensTx","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/NewProcessTx","path":"/sdk/reference/interfaces/NewProcessTx","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/Process","path":"/sdk/reference/interfaces/Process","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/Proof","path":"/sdk/reference/interfaces/Proof","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/RegisterKeyTx","path":"/sdk/reference/interfaces/RegisterKeyTx","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/SendTokensTx","path":"/sdk/reference/interfaces/SendTokensTx","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/ServiceProperties","path":"/sdk/reference/interfaces/ServiceProperties","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/SetAccountTx","path":"/sdk/reference/interfaces/SetAccountTx","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/SetProcessTx","path":"/sdk/reference/interfaces/SetProcessTx","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/SetTransactionCostsTx","path":"/sdk/reference/interfaces/SetTransactionCostsTx","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/Tx","path":"/sdk/reference/interfaces/Tx","sidebar":"defaultSidebar"},{"id":"sdk/reference/interfaces/VoteEnvelope","path":"/sdk/reference/interfaces/VoteEnvelope","sidebar":"defaultSidebar"},{"id":"sdk/reference/modules","path":"/sdk/reference/modules","sidebar":"defaultSidebar"},{"id":"sdk/tutorial","path":"/sdk/tutorial","sidebar":"defaultSidebar"},{"id":"sdk/voting-types/approval","path":"/sdk/voting-types/approval","sidebar":"defaultSidebar"},{"id":"sdk/voting-types/quadratic","path":"/sdk/voting-types/quadratic","sidebar":"defaultSidebar"},{"id":"sdk/voting-types/ranked","path":"/sdk/voting-types/ranked","sidebar":"defaultSidebar"},{"id":"sdk/voting-types/single-choice","path":"/sdk/voting-types/single-choice","sidebar":"defaultSidebar"},{"id":"sdk/voting-types/voting-types","path":"/sdk/voting-types/","sidebar":"defaultSidebar"},{"id":"sdk/voting-types/weighted","path":"/sdk/voting-types/weighted","sidebar":"defaultSidebar"},{"id":"ui-components/Election","path":"/ui-components/Election","sidebar":"defaultSidebar"},{"id":"ui-components/index","path":"/ui-components/","sidebar":"defaultSidebar"},{"id":"ui-components/Organization","path":"/ui-components/Organization","sidebar":"defaultSidebar"},{"id":"vocdoni-api/accounts","path":"/vocdoni-api/accounts","sidebar":"defaultSidebar"},{"id":"vocdoni-api/add-account","path":"/vocdoni-api/add-account","sidebar":"defaultSidebar"},{"id":"vocdoni-api/add-participants-to-census","path":"/vocdoni-api/add-participants-to-census","sidebar":"defaultSidebar"},{"id":"vocdoni-api/census-merkle-root","path":"/vocdoni-api/census-merkle-root","sidebar":"defaultSidebar"},{"id":"vocdoni-api/census-size","path":"/vocdoni-api/census-size","sidebar":"defaultSidebar"},{"id":"vocdoni-api/census-total-weight","path":"/vocdoni-api/census-total-weight","sidebar":"defaultSidebar"},{"id":"vocdoni-api/censuses","path":"/vocdoni-api/censuses","sidebar":"defaultSidebar"},{"id":"vocdoni-api/chain","path":"/vocdoni-api/chain","sidebar":"defaultSidebar"},{"id":"vocdoni-api/circuit-info","path":"/vocdoni-api/circuit-info","sidebar":"defaultSidebar"},{"id":"vocdoni-api/compute-election-price","path":"/vocdoni-api/compute-election-price","sidebar":"defaultSidebar"},{"id":"vocdoni-api/compute-ipfs-ci-dv-1-of-file","path":"/vocdoni-api/compute-ipfs-ci-dv-1-of-file","sidebar":"defaultSidebar"},{"id":"vocdoni-api/count-election-votes","path":"/vocdoni-api/count-election-votes","sidebar":"defaultSidebar"},{"id":"vocdoni-api/count-organization-elections","path":"/vocdoni-api/count-organization-elections","sidebar":"defaultSidebar"},{"id":"vocdoni-api/count-organizations","path":"/vocdoni-api/count-organizations","sidebar":"defaultSidebar"},{"id":"vocdoni-api/create-a-new-census","path":"/vocdoni-api/create-a-new-census","sidebar":"defaultSidebar"},{"id":"vocdoni-api/create-election","path":"/vocdoni-api/create-election","sidebar":"defaultSidebar"},{"id":"vocdoni-api/create-election-for-wallet","path":"/vocdoni-api/create-election-for-wallet","sidebar":"defaultSidebar"},{"id":"vocdoni-api/delete-census","path":"/vocdoni-api/delete-census","sidebar":"defaultSidebar"},{"id":"vocdoni-api/election-information","path":"/vocdoni-api/election-information","sidebar":"defaultSidebar"},{"id":"vocdoni-api/election-results","path":"/vocdoni-api/election-results","sidebar":"defaultSidebar"},{"id":"vocdoni-api/elections","path":"/vocdoni-api/elections","sidebar":"defaultSidebar"},{"id":"vocdoni-api/estimate-block-to-date","path":"/vocdoni-api/estimate-block-to-date","sidebar":"defaultSidebar"},{"id":"vocdoni-api/estimate-date-to-block","path":"/vocdoni-api/estimate-date-to-block","sidebar":"defaultSidebar"},{"id":"vocdoni-api/export-census","path":"/vocdoni-api/export-census","sidebar":"defaultSidebar"},{"id":"vocdoni-api/export-census-database","path":"/vocdoni-api/export-census-database","sidebar":"defaultSidebar"},{"id":"vocdoni-api/exports-the-indexer-database","path":"/vocdoni-api/exports-the-indexer-database","sidebar":"defaultSidebar"},{"id":"vocdoni-api/get-account","path":"/vocdoni-api/get-account","sidebar":"defaultSidebar"},{"id":"vocdoni-api/get-block-by-hash","path":"/vocdoni-api/get-block-by-hash","sidebar":"defaultSidebar"},{"id":"vocdoni-api/get-block-by-height","path":"/vocdoni-api/get-block-by-height","sidebar":"defaultSidebar"},{"id":"vocdoni-api/get-next-election-id","path":"/vocdoni-api/get-next-election-id","sidebar":"defaultSidebar"},{"id":"vocdoni-api/get-type-of-census","path":"/vocdoni-api/get-type-of-census","sidebar":"defaultSidebar"},{"id":"vocdoni-api/get-vote","path":"/vocdoni-api/get-vote","sidebar":"defaultSidebar"},{"id":"vocdoni-api/import-census","path":"/vocdoni-api/import-census","sidebar":"defaultSidebar"},{"id":"vocdoni-api/import-census-database","path":"/vocdoni-api/import-census-database","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-account-received-and-sent-token-transfers","path":"/vocdoni-api/list-account-received-and-sent-token-transfers","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-account-token-fees","path":"/vocdoni-api/list-account-token-fees","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-all-census-references","path":"/vocdoni-api/list-all-census-references","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-all-token-fees","path":"/vocdoni-api/list-all-token-fees","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-all-token-fees-by-reference","path":"/vocdoni-api/list-all-token-fees-by-reference","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-all-token-fees-by-type","path":"/vocdoni-api/list-all-token-fees-by-type","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-election-votes","path":"/vocdoni-api/list-election-votes","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-elections","path":"/vocdoni-api/list-elections","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-elections-filtered","path":"/vocdoni-api/list-elections-filtered","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-encryption-keys","path":"/vocdoni-api/list-encryption-keys","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-of-the-existing-accounts","path":"/vocdoni-api/list-of-the-existing-accounts","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-of-valid-sik-roots","path":"/vocdoni-api/list-of-valid-sik-roots","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-organization-elections","path":"/vocdoni-api/list-organization-elections","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-organization-elections-by-status","path":"/vocdoni-api/list-organization-elections-by-status","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-organizations","path":"/vocdoni-api/list-organizations","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-organizations-filtered","path":"/vocdoni-api/list-organizations-filtered","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-transactions","path":"/vocdoni-api/list-transactions","sidebar":"defaultSidebar"},{"id":"vocdoni-api/list-validators","path":"/vocdoni-api/list-validators","sidebar":"defaultSidebar"},{"id":"vocdoni-api/price-factors-information","path":"/vocdoni-api/price-factors-information","sidebar":"defaultSidebar"},{"id":"vocdoni-api/prove-key-to-census","path":"/vocdoni-api/prove-key-to-census","sidebar":"defaultSidebar"},{"id":"vocdoni-api/publish-census","path":"/vocdoni-api/publish-census","sidebar":"defaultSidebar"},{"id":"vocdoni-api/publish-census-at-root","path":"/vocdoni-api/publish-census-at-root","sidebar":"defaultSidebar"},{"id":"vocdoni-api/returns-if-the-address-provided-has-a-valid-sik","path":"/vocdoni-api/returns-if-the-address-provided-has-a-valid-sik","sidebar":"defaultSidebar"},{"id":"vocdoni-api/set-account","path":"/vocdoni-api/set-account","sidebar":"defaultSidebar"},{"id":"vocdoni-api/set-wallet-account","path":"/vocdoni-api/set-wallet-account","sidebar":"defaultSidebar"},{"id":"vocdoni-api/sik","path":"/vocdoni-api/sik","sidebar":"defaultSidebar"},{"id":"vocdoni-api/submit-a-vote","path":"/vocdoni-api/submit-a-vote","sidebar":"defaultSidebar"},{"id":"vocdoni-api/submit-transaction","path":"/vocdoni-api/submit-transaction","sidebar":"defaultSidebar"},{"id":"vocdoni-api/total-number-of-accounts","path":"/vocdoni-api/total-number-of-accounts","sidebar":"defaultSidebar"},{"id":"vocdoni-api/total-number-of-sent-and-received-transactions","path":"/vocdoni-api/total-number-of-sent-and-received-transactions","sidebar":"defaultSidebar"},{"id":"vocdoni-api/transaction-by-block-height-and-index","path":"/vocdoni-api/transaction-by-block-height-and-index","sidebar":"defaultSidebar"},{"id":"vocdoni-api/transaction-by-hash","path":"/vocdoni-api/transaction-by-hash","sidebar":"defaultSidebar"},{"id":"vocdoni-api/transaction-by-index","path":"/vocdoni-api/transaction-by-index","sidebar":"defaultSidebar"},{"id":"vocdoni-api/transaction-costs","path":"/vocdoni-api/transaction-costs","sidebar":"defaultSidebar"},{"id":"vocdoni-api/transactions-count","path":"/vocdoni-api/transactions-count","sidebar":"defaultSidebar"},{"id":"vocdoni-api/transactions-in-a-block","path":"/vocdoni-api/transactions-in-a-block","sidebar":"defaultSidebar"},{"id":"vocdoni-api/transfer-tokens","path":"/vocdoni-api/transfer-tokens","sidebar":"defaultSidebar"},{"id":"vocdoni-api/verify-merkle-proof","path":"/vocdoni-api/verify-merkle-proof","sidebar":"defaultSidebar"},{"id":"vocdoni-api/verify-vote","path":"/vocdoni-api/verify-vote","sidebar":"defaultSidebar"},{"id":"vocdoni-api/vocdoni-api","path":"/vocdoni-api/vocdoni-api","sidebar":"defaultSidebar"},{"id":"vocdoni-api/vochain-information","path":"/vocdoni-api/vochain-information","sidebar":"defaultSidebar"},{"id":"vocdoni-api/votes","path":"/vocdoni-api/votes","sidebar":"defaultSidebar"},{"id":"vocdoni-api/wallet","path":"/vocdoni-api/wallet","sidebar":"defaultSidebar"}],"draftIds":[],"sidebars":{"defaultSidebar":{"link":{"path":"/intro","label":"intro"}}}}],"breadcrumbs":true}}}'),i=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"En","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"}}}');var s=n(57529);const c=JSON.parse('{"docusaurusVersion":"2.2.0","siteVersion":"1.4.1","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"2.2.0"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"2.2.0"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"2.2.0"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"2.2.0"},"docusaurus-theme-search-algolia":{"type":"package","name":"@docusaurus/theme-search-algolia","version":"2.2.0"},"docusaurus-plugin-openapi-docs":{"type":"package","name":"docusaurus-plugin-openapi-docs","version":"1.5.0"},"docusaurus-tailwindcss":{"type":"local"},"docusaurus-theme-live-codeblock":{"type":"package","name":"@docusaurus/theme-live-codeblock","version":"2.2.0"},"docusaurus-theme-openapi":{"type":"package","name":"docusaurus-theme-openapi-docs","version":"1.5.0"},"docusaurus-theme-mermaid":{"type":"package","name":"@docusaurus/theme-mermaid","version":"2.2.0"}}}'),l={siteConfig:a.default,siteMetadata:c,globalData:o,i18n:i,codeTranslations:s},u=r.createContext(l);function d(e){let{children:t}=e;return r.createElement(u.Provider,{value:l},t)}},44763:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u});var r=n(67294),a=n(10412),o=n(35742),i=n(78193);function s(e){let{error:t,tryAgain:n}=e;return r.createElement("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"center",height:"50vh",width:"100%",fontSize:"20px"}},r.createElement("h1",null,"This page crashed."),r.createElement("p",null,t.message),r.createElement("button",{type:"button",onClick:n},"Try again"))}function c(e){let{error:t,tryAgain:n}=e;return r.createElement(u,{fallback:()=>r.createElement(s,{error:t,tryAgain:n})},r.createElement(o.Z,null,r.createElement("title",null,"Page Error")),r.createElement(i.Z,null,r.createElement(s,{error:t,tryAgain:n})))}const l=e=>r.createElement(c,e);class u extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){a.Z.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??l)(e)}return e??null}}},10412:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const r="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,a={canUseDOM:r,canUseEventListeners:r&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:r&&"IntersectionObserver"in window,canUseViewport:r&&"screen"in window}},35742:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(67294),a=n(70405);function o(e){return r.createElement(a.ql,e)}},39960:(e,t,n)=>{"use strict";n.d(t,{Z:()=>p});var r=n(87462),a=n(67294),o=n(73727),i=n(18780),s=n(52263),c=n(13919),l=n(10412);const u=a.createContext({collectLink:()=>{}});var d=n(44996);function f(e,t){let{isNavLink:n,to:f,href:p,activeClassName:m,isActive:h,"data-noBrokenLinkCheck":b,autoAddBaseUrl:g=!0,...v}=e;const{siteConfig:{trailingSlash:y,baseUrl:k}}=(0,s.Z)(),{withBaseUrl:S}=(0,d.C)(),w=(0,a.useContext)(u),E=(0,a.useRef)(null);(0,a.useImperativeHandle)(t,(()=>E.current));const x=f||p;const C=(0,c.Z)(x),_=x?.replace("pathname://","");let I=void 0!==_?(T=_,g&&(e=>e.startsWith("/"))(T)?S(T):T):void 0;var T;I&&C&&(I=(0,i.applyTrailingSlash)(I,{trailingSlash:y,baseUrl:k}));const P=(0,a.useRef)(!1),A=n?o.OL:o.rU,R=l.Z.canUseIntersectionObserver,L=(0,a.useRef)(),O=()=>{P.current||null==I||(window.docusaurus.preload(I),P.current=!0)};(0,a.useEffect)((()=>(!R&&C&&null!=I&&window.docusaurus.prefetch(I),()=>{R&&L.current&&L.current.disconnect()})),[L,I,R,C]);const N=I?.startsWith("#")??!1,M=!I||!C||N;return M||b||w.collectLink(I),M?a.createElement("a",(0,r.Z)({ref:E,href:I},x&&!C&&{target:"_blank",rel:"noopener noreferrer"},v)):a.createElement(A,(0,r.Z)({},v,{onMouseEnter:O,onTouchStart:O,innerRef:e=>{E.current=e,R&&e&&C&&(L.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(L.current.unobserve(e),L.current.disconnect(),null!=I&&window.docusaurus.prefetch(I))}))})),L.current.observe(e))},to:I},n&&{isActive:h,activeClassName:m}))}const p=a.forwardRef(f)},95999:(e,t,n)=>{"use strict";n.d(t,{Z:()=>c,I:()=>s});var r=n(67294);function a(e,t){const n=e.split(/(\{\w+\})/).map(((e,n)=>{if(n%2==1){const n=t?.[e.slice(1,-1)];if(void 0!==n)return n}return e}));return n.some((e=>(0,r.isValidElement)(e)))?n.map(((e,t)=>(0,r.isValidElement)(e)?r.cloneElement(e,{key:t}):e)).filter((e=>""!==e)):n.join("")}var o=n(57529);function i(e){let{id:t,message:n}=e;if(void 0===t&&void 0===n)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return o[t??n]??n??t}function s(e,t){let{message:n,id:r}=e;return a(i({message:n,id:r}),t)}function c(e){let{children:t,id:n,values:o}=e;if(t&&"string"!=typeof t)throw console.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");const s=i({message:t,id:n});return r.createElement(r.Fragment,null,a(s,o))}},29935:(e,t,n)=>{"use strict";n.d(t,{m:()=>r});const r="default"},13919:(e,t,n)=>{"use strict";function r(e){return/^(?:\w*:|\/\/)/.test(e)}function a(e){return void 0!==e&&!r(e)}n.d(t,{Z:()=>a,b:()=>r})},44996:(e,t,n)=>{"use strict";n.d(t,{C:()=>o,Z:()=>i});var r=n(52263),a=n(13919);function o(){const{siteConfig:{baseUrl:e,url:t}}=(0,r.Z)();return{withBaseUrl:(n,r)=>function(e,t,n,r){let{forcePrependBaseUrl:o=!1,absolute:i=!1}=void 0===r?{}:r;if(!n||n.startsWith("#")||(0,a.b)(n))return n;if(o)return t+n.replace(/^\//,"");if(n===t.replace(/\/$/,""))return t;const s=n.startsWith(t)?n:t+n.replace(/^\//,"");return i?e+s:s}(t,e,n,r)}}function i(e,t){void 0===t&&(t={});const{withBaseUrl:n}=o();return n(e,t)}},52263:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(67294),a=n(58940);function o(){return(0,r.useContext)(a._)}},72389:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(67294),a=n(98934);function o(){return(0,r.useContext)(a._)}},99670:(e,t,n)=>{"use strict";n.d(t,{Z:()=>r});function r(e){const t={};return function e(n,r){Object.entries(n).forEach((n=>{let[a,o]=n;const i=r?`${r}.${a}`:a;var s;"object"==typeof(s=o)&&s&&Object.keys(s).length>0?e(o,i):t[i]=o}))}(e),t}},30226:(e,t,n)=>{"use strict";n.d(t,{_:()=>a,z:()=>o});var r=n(67294);const a=r.createContext(null);function o(e){let{children:t,value:n}=e;const o=r.useContext(a),i=(0,r.useMemo)((()=>function(e){let{parent:t,value:n}=e;if(!t){if(!n)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in n))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return n}const r={...t.data,...n?.data};return{plugin:t.plugin,data:r}}({parent:o,value:n})),[o,n]);return r.createElement(a.Provider,{value:i},t)}},80143:(e,t,n)=>{"use strict";n.d(t,{Iw:()=>g,gA:()=>p,WS:()=>m,_r:()=>d,Jo:()=>v,zh:()=>f,yW:()=>b,gB:()=>h});var r=n(16550),a=n(52263),o=n(29935);function i(e,t){void 0===t&&(t={});const n=function(){const{globalData:e}=(0,a.Z)();return e}()[e];if(!n&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return n}const s=e=>e.versions.find((e=>e.isLast));function c(e,t){const n=s(e);return[...e.versions.filter((e=>e!==n)),n].find((e=>!!(0,r.LX)(t,{path:e.path,exact:!1,strict:!1})))}function l(e,t){const n=c(e,t),a=n?.docs.find((e=>!!(0,r.LX)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:n,activeDoc:a,alternateDocVersions:a?function(t){const n={};return e.versions.forEach((e=>{e.docs.forEach((r=>{r.id===t&&(n[e.name]=r)}))})),n}(a.id):{}}}const u={},d=()=>i("docusaurus-plugin-content-docs")??u,f=e=>function(e,t,n){void 0===t&&(t=o.m),void 0===n&&(n={});const r=i(e)?.[t];if(!r&&n.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return r}("docusaurus-plugin-content-docs",e,{failfast:!0});function p(e){void 0===e&&(e={});const t=d(),{pathname:n}=(0,r.TH)();return function(e,t,n){void 0===n&&(n={});const a=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,n]=e;return!!(0,r.LX)(t,{path:n.path,exact:!1,strict:!1})})),o=a?{pluginId:a[0],pluginData:a[1]}:void 0;if(!o&&n.failfast)throw new Error(`Can't find active docs plugin for "${t}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(e).map((e=>e.path)).join(", ")}`);return o}(t,n,e)}function m(e){void 0===e&&(e={});const t=p(e),{pathname:n}=(0,r.TH)();if(!t)return;return{activePlugin:t,activeVersion:c(t.pluginData,n)}}function h(e){return f(e).versions}function b(e){const t=f(e);return s(t)}function g(e){const t=f(e),{pathname:n}=(0,r.TH)();return l(t,n)}function v(e){const t=f(e),{pathname:n}=(0,r.TH)();return function(e,t){const n=s(e);return{latestDocSuggestion:l(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},18320:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>o});var r=n(74865),a=n.n(r);a().configure({showSpinner:!1});const o={onRouteUpdate(e){let{location:t,previousLocation:n}=e;if(n&&t.pathname!==n.pathname){const e=window.setTimeout((()=>{a().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){a().done()}}},3310:(e,t,n)=>{"use strict";n.r(t);var r=n(87410),a=n(36809);!function(e){const{themeConfig:{prism:t}}=a.default,{additionalLanguages:r}=t;globalThis.Prism=e,r.forEach((e=>{n(99768)(`./prism-${e}`)})),delete globalThis.Prism}(r.Z)},78193:(e,t,n)=>{"use strict";n.d(t,{Z:()=>nn});var r=n(67294),a=n(86010),o=n(44763),i=n(10833),s=n(55225),c=n(35281),l=n(19727);const u="skipToContent_fXgn";function d(){return r.createElement(s.l,{className:u})}var f=n(86668),p=n(59689),m=n(87462),h=n(95999);function b(e){let{width:t=21,height:n=21,color:a="currentColor",strokeWidth:o=1.2,className:i,...s}=e;return r.createElement("svg",(0,m.Z)({viewBox:"0 0 15 15",width:t,height:n},s),r.createElement("g",{stroke:a,strokeWidth:o},r.createElement("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})))}const g="closeButton_CVFx";function v(e){return r.createElement("button",(0,m.Z)({type:"button","aria-label":(0,h.I)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"})},e,{className:(0,a.Z)("clean-btn close",g,e.className)}),r.createElement(b,{width:14,height:14,strokeWidth:3.1}))}const y="content_knG7";function k(e){const{announcementBar:t}=(0,f.L)(),{content:n}=t;return r.createElement("div",(0,m.Z)({},e,{className:(0,a.Z)(y,e.className),dangerouslySetInnerHTML:{__html:n}}))}const S="announcementBar_mb4j",w="announcementBarPlaceholder_vyr4",E="announcementBarClose_gvF7",x="announcementBarContent_xLdY";function C(){const{announcementBar:e}=(0,f.L)(),{isActive:t,close:n}=(0,p.nT)();if(!t)return null;const{backgroundColor:a,textColor:o,isCloseable:i}=e;return r.createElement("div",{className:S,style:{backgroundColor:a,color:o},role:"banner"},i&&r.createElement("div",{className:w}),r.createElement(k,{className:x}),i&&r.createElement(v,{onClick:n,className:E}))}var _=n(93163),I=n(99445),T=n(69800),P=n(76857);function A(e){let{header:t,primaryMenu:n,secondaryMenu:o}=e;const{shown:i}=(0,P.Y)();return r.createElement("div",{className:"navbar-sidebar"},t,r.createElement("div",{className:(0,a.Z)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":i})},r.createElement("div",{className:"navbar-sidebar__item menu"},n),r.createElement("div",{className:"navbar-sidebar__item menu"},o)))}var R=n(92949),L=n(72389);function O(e){return r.createElement("svg",(0,m.Z)({viewBox:"0 0 24 24",width:24,height:24},e),r.createElement("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"}))}function N(e){return r.createElement("svg",(0,m.Z)({viewBox:"0 0 24 24",width:24,height:24},e),r.createElement("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"}))}const M={toggle:"toggle_vylO",toggleButton:"toggleButton_gllP",darkToggleIcon:"darkToggleIcon_wfgR",lightToggleIcon:"lightToggleIcon_pyhR",toggleButtonDisabled:"toggleButtonDisabled_aARS"};function D(e){let{className:t,value:n,onChange:o}=e;const i=(0,L.Z)(),s=(0,h.I)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===n?(0,h.I)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,h.I)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return r.createElement("div",{className:(0,a.Z)(M.toggle,t)},r.createElement("button",{className:(0,a.Z)("clean-btn",M.toggleButton,!i&&M.toggleButtonDisabled),type:"button",onClick:()=>o("dark"===n?"light":"dark"),disabled:!i,title:s,"aria-label":s,"aria-live":"polite"},r.createElement(O,{className:(0,a.Z)(M.toggleIcon,M.lightToggleIcon)}),r.createElement(N,{className:(0,a.Z)(M.toggleIcon,M.darkToggleIcon)})))}const z=r.memo(D);function F(e){let{className:t}=e;const n=(0,f.L)().colorMode.disableSwitch,{colorMode:a,setColorMode:o}=(0,R.I)();return n?null:r.createElement(z,{className:t,value:a,onChange:o})}var B=n(21327);function $(){return r.createElement(B.Z,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function U(){const e=(0,_.e)();return r.createElement("button",{type:"button","aria-label":(0,h.I)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle()},r.createElement(b,{color:"var(--ifm-color-emphasis-600)"}))}function j(){return r.createElement("div",{className:"navbar-sidebar__brand"},r.createElement($,null),r.createElement(F,{className:"margin-right--md"}),r.createElement(U,null))}var V=n(39960),Z=n(44996),H=n(13919),W=n(98022),G=n(19548);function q(e){let{activeBasePath:t,activeBaseRegex:n,to:a,href:o,label:i,html:s,isDropdownLink:c,prependBaseUrlToHref:l,...u}=e;const d=(0,Z.Z)(a),f=(0,Z.Z)(t),p=(0,Z.Z)(o,{forcePrependBaseUrl:!0}),h=i&&o&&!(0,H.Z)(o),b=s?{dangerouslySetInnerHTML:{__html:s}}:{children:r.createElement(r.Fragment,null,i,h&&r.createElement(G.Z,c&&{width:12,height:12}))};return o?r.createElement(V.Z,(0,m.Z)({href:l?p:o},u,b)):r.createElement(V.Z,(0,m.Z)({to:d,isNavLink:!0},(t||n)&&{isActive:(e,t)=>n?(0,W.F)(n,t.pathname):t.pathname.startsWith(f)},u,b))}function K(e){let{className:t,isDropdownItem:n=!1,...o}=e;const i=r.createElement(q,(0,m.Z)({className:(0,a.Z)(n?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:n},o));return n?r.createElement("li",null,i):i}function Y(e){let{className:t,isDropdownItem:n,...o}=e;return r.createElement("li",{className:"menu__list-item"},r.createElement(q,(0,m.Z)({className:(0,a.Z)("menu__link",t)},o)))}function Q(e){let{mobile:t=!1,position:n,...a}=e;const o=t?Y:K;return r.createElement(o,(0,m.Z)({},a,{activeClassName:a.activeClassName??(t?"menu__link--active":"navbar__link--active")}))}var X=n(86043),J=n(48596),ee=n(51753);function te(e,t){return e.some((e=>function(e,t){return!!(0,J.Mg)(e.to,t)||!!(0,W.F)(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function ne(e){let{items:t,position:n,className:o,onClick:i,...s}=e;const c=(0,r.useRef)(null),[l,u]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{const e=e=>{c.current&&!c.current.contains(e.target)&&u(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e)}}),[c]),r.createElement("div",{ref:c,className:(0,a.Z)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===n,"dropdown--show":l})},r.createElement(q,(0,m.Z)({"aria-haspopup":"true","aria-expanded":l,role:"button",href:s.to?void 0:"#",className:(0,a.Z)("navbar__link",o)},s,{onClick:s.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),u(!l))}}),s.children??s.label),r.createElement("ul",{className:"dropdown__menu"},t.map(((e,n)=>r.createElement(De,(0,m.Z)({isDropdownItem:!0,onKeyDown:e=>{if(n===t.length-1&&"Tab"===e.key){e.preventDefault(),u(!1);const t=c.current.nextElementSibling;if(t){(t instanceof HTMLAnchorElement?t:t.querySelector("a")).focus()}}},activeClassName:"dropdown__link--active"},e,{key:n}))))))}function re(e){let{items:t,className:n,position:o,onClick:i,...s}=e;const c=(0,ee.b)(),l=te(t,c),{collapsed:u,toggleCollapsed:d,setCollapsed:f}=(0,X.u)({initialState:()=>!l});return(0,r.useEffect)((()=>{l&&f(!l)}),[c,l,f]),r.createElement("li",{className:(0,a.Z)("menu__list-item",{"menu__list-item--collapsed":u})},r.createElement(q,(0,m.Z)({role:"button",className:(0,a.Z)("menu__link menu__link--sublist menu__link--sublist-caret",n)},s,{onClick:e=>{e.preventDefault(),d()}}),s.children??s.label),r.createElement(X.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:u},t.map(((e,t)=>r.createElement(De,(0,m.Z)({mobile:!0,isDropdownItem:!0,onClick:i,activeClassName:"menu__link--active"},e,{key:t}))))))}function ae(e){let{mobile:t=!1,...n}=e;const a=t?re:ne;return r.createElement(a,n)}var oe=n(52263),ie=n(94711),se=n(16550);function ce(e){let{width:t=20,height:n=20,...a}=e;return r.createElement("svg",(0,m.Z)({viewBox:"0 0 24 24",width:t,height:n,"aria-hidden":!0},a),r.createElement("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"}))}const le="iconLanguage_nlXk";var ue=n(73935),de=n(35742),fe=n(66177);function pe(){return r.createElement("svg",{width:"15",height:"15",className:"DocSearch-Control-Key-Icon"},r.createElement("path",{d:"M4.505 4.496h2M5.505 5.496v5M8.216 4.496l.055 5.993M10 7.5c.333.333.5.667.5 1v2M12.326 4.5v5.996M8.384 4.496c1.674 0 2.116 0 2.116 1.5s-.442 1.5-2.116 1.5M3.205 9.303c-.09.448-.277 1.21-1.241 1.203C1 10.5.5 9.513.5 8V7c0-1.57.5-2.5 1.464-2.494.964.006 1.134.598 1.24 1.342M12.553 10.5h1.953",strokeWidth:"1.2",stroke:"currentColor",fill:"none",strokeLinecap:"square"}))}var me=n(20830),he=["translations"];function be(){return be=Object.assign||function(e){for(var t=1;te.length)&&(t=e.length);for(var n=0,r=new Array(t);n=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var ke="Ctrl";var Se=r.forwardRef((function(e,t){var n=e.translations,a=void 0===n?{}:n,o=ye(e,he),i=a.buttonText,s=void 0===i?"Search":i,c=a.buttonAriaLabel,l=void 0===c?"Search":c,u=ge((0,r.useState)(null),2),d=u[0],f=u[1];return(0,r.useEffect)((function(){"undefined"!=typeof navigator&&(/(Mac|iPhone|iPod|iPad)/i.test(navigator.platform)?f("\u2318"):f(ke))}),[]),r.createElement("button",be({type:"button",className:"DocSearch DocSearch-Button","aria-label":l},o,{ref:t}),r.createElement("span",{className:"DocSearch-Button-Container"},r.createElement(me.W,null),r.createElement("span",{className:"DocSearch-Button-Placeholder"},s)),r.createElement("span",{className:"DocSearch-Button-Keys"},null!==d&&r.createElement(r.Fragment,null,r.createElement("kbd",{className:"DocSearch-Button-Key"},d===ke?r.createElement(pe,null):d),r.createElement("kbd",{className:"DocSearch-Button-Key"},"K"))))})),we=n(43320);const Ee={button:{buttonText:(0,h.I)({id:"theme.SearchBar.label",message:"Search",description:"The ARIA label and placeholder for search button"}),buttonAriaLabel:(0,h.I)({id:"theme.SearchBar.label",message:"Search",description:"The ARIA label and placeholder for search button"})},modal:{searchBox:{resetButtonTitle:(0,h.I)({id:"theme.SearchModal.searchBox.resetButtonTitle",message:"Clear the query",description:"The label and ARIA label for search box reset button"}),resetButtonAriaLabel:(0,h.I)({id:"theme.SearchModal.searchBox.resetButtonTitle",message:"Clear the query",description:"The label and ARIA label for search box reset button"}),cancelButtonText:(0,h.I)({id:"theme.SearchModal.searchBox.cancelButtonText",message:"Cancel",description:"The label and ARIA label for search box cancel button"}),cancelButtonAriaLabel:(0,h.I)({id:"theme.SearchModal.searchBox.cancelButtonText",message:"Cancel",description:"The label and ARIA label for search box cancel button"})},startScreen:{recentSearchesTitle:(0,h.I)({id:"theme.SearchModal.startScreen.recentSearchesTitle",message:"Recent",description:"The title for recent searches"}),noRecentSearchesText:(0,h.I)({id:"theme.SearchModal.startScreen.noRecentSearchesText",message:"No recent searches",description:"The text when no recent searches"}),saveRecentSearchButtonTitle:(0,h.I)({id:"theme.SearchModal.startScreen.saveRecentSearchButtonTitle",message:"Save this search",description:"The label for save recent search button"}),removeRecentSearchButtonTitle:(0,h.I)({id:"theme.SearchModal.startScreen.removeRecentSearchButtonTitle",message:"Remove this search from history",description:"The label for remove recent search button"}),favoriteSearchesTitle:(0,h.I)({id:"theme.SearchModal.startScreen.favoriteSearchesTitle",message:"Favorite",description:"The title for favorite searches"}),removeFavoriteSearchButtonTitle:(0,h.I)({id:"theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle",message:"Remove this search from favorites",description:"The label for remove favorite search button"})},errorScreen:{titleText:(0,h.I)({id:"theme.SearchModal.errorScreen.titleText",message:"Unable to fetch results",description:"The title for error screen of search modal"}),helpText:(0,h.I)({id:"theme.SearchModal.errorScreen.helpText",message:"You might want to check your network connection.",description:"The help text for error screen of search modal"})},footer:{selectText:(0,h.I)({id:"theme.SearchModal.footer.selectText",message:"to select",description:"The explanatory text of the action for the enter key"}),selectKeyAriaLabel:(0,h.I)({id:"theme.SearchModal.footer.selectKeyAriaLabel",message:"Enter key",description:"The ARIA label for the Enter key button that makes the selection"}),navigateText:(0,h.I)({id:"theme.SearchModal.footer.navigateText",message:"to navigate",description:"The explanatory text of the action for the Arrow up and Arrow down key"}),navigateUpKeyAriaLabel:(0,h.I)({id:"theme.SearchModal.footer.navigateUpKeyAriaLabel",message:"Arrow up",description:"The ARIA label for the Arrow up key button that makes the navigation"}),navigateDownKeyAriaLabel:(0,h.I)({id:"theme.SearchModal.footer.navigateDownKeyAriaLabel",message:"Arrow down",description:"The ARIA label for the Arrow down key button that makes the navigation"}),closeText:(0,h.I)({id:"theme.SearchModal.footer.closeText",message:"to close",description:"The explanatory text of the action for Escape key"}),closeKeyAriaLabel:(0,h.I)({id:"theme.SearchModal.footer.closeKeyAriaLabel",message:"Escape key",description:"The ARIA label for the Escape key button that close the modal"}),searchByText:(0,h.I)({id:"theme.SearchModal.footer.searchByText",message:"Search by",description:"The text explain that the search is making by Algolia"})},noResultsScreen:{noResultsText:(0,h.I)({id:"theme.SearchModal.noResultsScreen.noResultsText",message:"No results for",description:"The text explains that there are no results for the following search"}),suggestedQueryText:(0,h.I)({id:"theme.SearchModal.noResultsScreen.suggestedQueryText",message:"Try searching for",description:"The text for the suggested query when no results are found for the following search"}),reportMissingResultsText:(0,h.I)({id:"theme.SearchModal.noResultsScreen.reportMissingResultsText",message:"Believe this query should return results?",description:"The text for the question where the user thinks there are missing results"}),reportMissingResultsLinkText:(0,h.I)({id:"theme.SearchModal.noResultsScreen.reportMissingResultsLinkText",message:"Let us know.",description:"The text for the link to report missing results"})}},placeholder:(0,h.I)({id:"theme.SearchModal.placeholder",message:"Search docs",description:"The placeholder of the input of the DocSearch pop-up modal"})};let xe=null;function Ce(e){let{hit:t,children:n}=e;return r.createElement(V.Z,{to:t.url},n)}function _e(e){let{state:t,onClose:n}=e;const{generateSearchPageLink:a}=(0,fe.O)();return r.createElement(V.Z,{to:a(t.query),onClick:n},r.createElement(h.Z,{id:"theme.SearchBar.seeAll",values:{count:t.context.nbHits}},"See all {count} results"))}function Ie(e){let{contextualSearch:t,externalUrlRegex:a,...o}=e;const{siteMetadata:i}=(0,oe.Z)(),s=function(){const{locale:e,tags:t}=(0,we._q)();return[`language:${e}`,t.map((e=>`docusaurus_tag:${e}`))]}(),c=o.searchParameters?.facetFilters??[],l=t?function(e,t){const n=e=>"string"==typeof e?[e]:e;return[...n(e),...n(t)]}(s,c):c,u={...o.searchParameters,facetFilters:l},{withBaseUrl:d}=(0,Z.C)(),f=(0,se.k6)(),p=(0,r.useRef)(null),h=(0,r.useRef)(null),[b,g]=(0,r.useState)(!1),[v,y]=(0,r.useState)(void 0),k=(0,r.useCallback)((()=>xe?Promise.resolve():Promise.all([n.e(6780).then(n.bind(n,76780)),Promise.all([n.e(532),n.e(6945)]).then(n.bind(n,46945)),Promise.all([n.e(532),n.e(8894)]).then(n.bind(n,18894))]).then((e=>{let[{DocSearchModal:t}]=e;xe=t}))),[]),S=(0,r.useCallback)((()=>{k().then((()=>{p.current=document.createElement("div"),document.body.insertBefore(p.current,document.body.firstChild),g(!0)}))}),[k,g]),w=(0,r.useCallback)((()=>{g(!1),p.current?.remove()}),[g]),E=(0,r.useCallback)((e=>{k().then((()=>{g(!0),y(e.key)}))}),[k,g,y]),x=(0,r.useRef)({navigate(e){let{itemUrl:t}=e;(0,W.F)(a,t)?window.location.href=t:f.push(t)}}).current,C=(0,r.useRef)((e=>e.map((e=>{if((0,W.F)(a,e.url))return e;const t=new URL(e.url);return{...e,url:d(`${t.pathname}${t.hash}`)}})))).current,_=(0,r.useMemo)((()=>e=>r.createElement(_e,(0,m.Z)({},e,{onClose:w}))),[w]),I=(0,r.useCallback)((e=>(e.addAlgoliaAgent("docusaurus",i.docusaurusVersion),e)),[i.docusaurusVersion]);return function(e){var t=e.isOpen,n=e.onOpen,a=e.onClose,o=e.onInput,i=e.searchButtonRef;r.useEffect((function(){function e(e){(27===e.keyCode&&t||"k"===e.key.toLowerCase()&&(e.metaKey||e.ctrlKey)||!function(e){var t=e.target,n=t.tagName;return t.isContentEditable||"INPUT"===n||"SELECT"===n||"TEXTAREA"===n}(e)&&"/"===e.key&&!t)&&(e.preventDefault(),t?a():document.body.classList.contains("DocSearch--active")||document.body.classList.contains("DocSearch--active")||n()),i&&i.current===document.activeElement&&o&&/[a-zA-Z0-9]/.test(String.fromCharCode(e.keyCode))&&o(e)}return window.addEventListener("keydown",e),function(){window.removeEventListener("keydown",e)}}),[t,n,a,o,i])}({isOpen:b,onOpen:S,onClose:w,onInput:E,searchButtonRef:h}),r.createElement(r.Fragment,null,r.createElement(de.Z,null,r.createElement("link",{rel:"preconnect",href:`https://${o.appId}-dsn.algolia.net`,crossOrigin:"anonymous"})),r.createElement(Se,{onTouchStart:k,onFocus:k,onMouseOver:k,onClick:S,ref:h,translations:Ee.button}),b&&xe&&p.current&&(0,ue.createPortal)(r.createElement(xe,(0,m.Z)({onClose:w,initialScrollY:window.scrollY,initialQuery:v,navigator:x,transformItems:C,hitComponent:Ce,transformSearchClient:I},o.searchPagePath&&{resultsFooterComponent:_},o,{searchParameters:u,placeholder:Ee.placeholder,translations:Ee.modal})),p.current))}function Te(){const{siteConfig:e}=(0,oe.Z)();return r.createElement(Ie,e.themeConfig.algolia)}const Pe="searchBox_ZlJk";function Ae(e){let{children:t,className:n}=e;return r.createElement("div",{className:(0,a.Z)(n,Pe)},t)}var Re=n(80143),Le=n(53438);var Oe=n(60373);const Ne=e=>e.docs.find((t=>t.id===e.mainDocId));const Me={default:Q,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:n,dropdownItemsAfter:a,...o}=e;const{i18n:{currentLocale:i,locales:s,localeConfigs:c}}=(0,oe.Z)(),l=(0,ie.l)(),{search:u,hash:d}=(0,se.TH)(),f=[...n,...s.map((e=>{const n=`${`pathname://${l.createUrl({locale:e,fullyQualified:!1})}`}${u}${d}`;return{label:c[e].label,lang:c[e].htmlLang,to:n,target:"_self",autoAddBaseUrl:!1,className:e===i?t?"menu__link--active":"dropdown__link--active":""}})),...a],p=t?(0,h.I)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):c[i].label;return r.createElement(ae,(0,m.Z)({},o,{mobile:t,label:r.createElement(r.Fragment,null,r.createElement(ce,{className:le}),p),items:f}))},search:function(e){let{mobile:t,className:n}=e;return t?null:r.createElement(Ae,{className:n},r.createElement(Te,null))},dropdown:ae,html:function(e){let{value:t,className:n,mobile:o=!1,isDropdownItem:i=!1}=e;const s=i?"li":"div";return r.createElement(s,{className:(0,a.Z)({navbar__item:!o&&!i,"menu__list-item":o},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:n,docsPluginId:a,...o}=e;const{activeDoc:i}=(0,Re.Iw)(a),s=(0,Le.vY)(t,a);return null===s?null:r.createElement(Q,(0,m.Z)({exact:!0},o,{isActive:()=>i?.path===s.path||!!i?.sidebar&&i.sidebar===s.sidebar,label:n??s.id,to:s.path}))},docSidebar:function(e){let{sidebarId:t,label:n,docsPluginId:a,...o}=e;const{activeDoc:i}=(0,Re.Iw)(a),s=(0,Le.oz)(t,a).link;if(!s)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${t}" doesn't have anything to be linked to.`);return r.createElement(Q,(0,m.Z)({exact:!0},o,{isActive:()=>i?.sidebar===t,label:n??s.label,to:s.path}))},docsVersion:function(e){let{label:t,to:n,docsPluginId:a,...o}=e;const i=(0,Le.lO)(a)[0],s=t??i.label,c=n??(e=>e.docs.find((t=>t.id===e.mainDocId)))(i).path;return r.createElement(Q,(0,m.Z)({},o,{label:s,to:c}))},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:n,dropdownActiveClassDisabled:a,dropdownItemsBefore:o,dropdownItemsAfter:i,...s}=e;const{search:c,hash:l}=(0,se.TH)(),u=(0,Re.Iw)(n),d=(0,Re.gB)(n),{savePreferredVersionName:f}=(0,Oe.J)(n),p=[...o,...d.map((e=>{const t=u.alternateDocVersions[e.name]??Ne(e);return{label:e.label,to:`${t.path}${c}${l}`,isActive:()=>e===u.activeVersion,onClick:()=>f(e.name)}})),...i],b=(0,Le.lO)(n)[0],g=t&&p.length>1?(0,h.I)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):b.label,v=t&&p.length>1?void 0:Ne(b).path;return p.length<=1?r.createElement(Q,(0,m.Z)({},s,{mobile:t,label:g,to:v,isActive:a?()=>!1:void 0})):r.createElement(ae,(0,m.Z)({},s,{mobile:t,label:g,to:v,items:p,isActive:a?()=>!1:void 0}))}};function De(e){let{type:t,...n}=e;const a=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),o=Me[a];if(!o)throw new Error(`No NavbarItem component found for type "${t}".`);return r.createElement(o,n)}function ze(){const e=(0,_.e)(),t=(0,f.L)().navbar.items;return r.createElement("ul",{className:"menu__list"},t.map(((t,n)=>r.createElement(De,(0,m.Z)({mobile:!0},t,{onClick:()=>e.toggle(),key:n})))))}function Fe(e){return r.createElement("button",(0,m.Z)({},e,{type:"button",className:"clean-btn navbar-sidebar__back"}),r.createElement(h.Z,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)"},"\u2190 Back to main menu"))}function Be(){const e=0===(0,f.L)().navbar.items.length,t=(0,P.Y)();return r.createElement(r.Fragment,null,!e&&r.createElement(Fe,{onClick:()=>t.hide()}),t.content)}function $e(){const e=(0,_.e)();return(0,T.N)(e.shown),e.shouldRender?r.createElement(A,{header:r.createElement(j,null),primaryMenu:r.createElement(ze,null),secondaryMenu:r.createElement(Be,null)}):null}const Ue="navbarHideable_m1mJ",je="navbarHidden_jGov";function Ve(e){return r.createElement("div",(0,m.Z)({role:"presentation"},e,{className:(0,a.Z)("navbar-sidebar__backdrop",e.className)}))}function Ze(e){let{children:t}=e;const{navbar:{hideOnScroll:n,style:o}}=(0,f.L)(),i=(0,_.e)(),{navbarRef:s,isNavbarVisible:c}=(0,I.c)(n);return r.createElement("nav",{ref:s,className:(0,a.Z)("navbar","navbar--fixed-top",n&&[Ue,!c&&je],{"navbar--dark":"dark"===o,"navbar--primary":"primary"===o,"navbar-sidebar--show":i.shown})},t,r.createElement(Ve,{onClick:i.toggle}),r.createElement($e,null))}var He=n(58978);function We(e){let{width:t=30,height:n=30,className:a,...o}=e;return r.createElement("svg",(0,m.Z)({className:a,width:t,height:n,viewBox:"0 0 30 30","aria-hidden":"true"},o),r.createElement("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"}))}function Ge(){const{toggle:e,shown:t}=(0,_.e)();return r.createElement("button",{onClick:e,"aria-label":(0,h.I)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button"},r.createElement(We,null))}const qe="colorModeToggle_x44X";var Ke=n(14141);function Ye(e){let{items:t,isMobile:n}=e;const[a,o]=function(e){function t(e){return e.href?.length>0??!1}return[e.filter((e=>!t(e))),e.filter(t)]}(t);return r.createElement(r.Fragment,null,a.map(((e,t)=>r.createElement(De,(0,m.Z)({},e,{key:t})))),!n&&r.createElement(Qe,null),o.map(((e,t)=>r.createElement(De,(0,m.Z)({},e,{key:t})))))}const Qe=Ke.ZP.div` - width: 1px; - height: 80%; - background-color: black; -`;function Xe(e){let{items:t}=e;return r.createElement(r.Fragment,null,t.map(((e,t)=>r.createElement(De,(0,m.Z)({},e,{key:t})))))}function Je(e){let{left:t,center:n,right:a}=e;return r.createElement("div",{className:"navbar__inner"},r.createElement("div",{className:"navbar__items"},t),r.createElement("div",{className:"navbar__items navbar__items--center"},n),r.createElement("div",{className:"navbar__items navbar__items--right"},a))}function et(){const e=(0,_.e)(),t=(0,f.L)().navbar.items,[n,a]=(0,He.A)(t),o=t.find((e=>"search"===e.type));return r.createElement(Je,{left:r.createElement(r.Fragment,null,!e.disabled&&r.createElement(Ge,null),r.createElement($,null)),center:r.createElement(r.Fragment,null,r.createElement(Ye,{items:n,isMobile:e.shouldRender})),right:r.createElement(r.Fragment,null,!o&&r.createElement(Ae,null,r.createElement(Te,null)),r.createElement(Xe,{items:a}),r.createElement(F,{className:qe}))})}function tt(){return r.createElement(Ze,null,r.createElement(et,null))}var nt=n(42489);function rt(e){let{item:t}=e;const{to:n,href:a,label:o,prependBaseUrlToHref:i,...s}=t,c=(0,Z.Z)(n),l=(0,Z.Z)(a,{forcePrependBaseUrl:!0});return r.createElement(V.Z,(0,m.Z)({className:"footer__link-item"},a?{href:i?l:a}:{to:c},s),o,a&&!(0,H.Z)(a)&&r.createElement(G.Z,null))}function at(e){let{item:t}=e;return t.html?r.createElement("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):r.createElement("li",{key:t.href??t.to,className:"footer__item"},r.createElement(rt,{item:t}))}function ot(e){let{column:t}=e;return r.createElement("div",{className:"col footer__col"},r.createElement("div",{className:"footer__title"},t.title),r.createElement("ul",{className:"footer__items clean-list"},t.items.map(((e,t)=>r.createElement(at,{key:t,item:e})))))}function it(e){let{columns:t}=e;return r.createElement("div",{className:"row footer__links"},t.map(((e,t)=>r.createElement(ot,{key:t,column:e}))))}function st(){return r.createElement("span",{className:"footer__link-separator"},"\xb7")}function ct(e){let{item:t}=e;return t.html?r.createElement("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):r.createElement(rt,{item:t})}function lt(e){let{links:t}=e;return r.createElement("div",{className:"footer__links text--center"},r.createElement("div",{className:"footer__links"},t.map(((e,n)=>r.createElement(r.Fragment,{key:n},r.createElement(ct,{item:e}),t.length!==n+1&&r.createElement(st,null))))))}function ut(e){let{links:t}=e;return(0,nt.a)(t)?r.createElement(it,{columns:t}):r.createElement(lt,{links:t})}var dt=n(50941);const ft="footerLogoLink_BH7S";function pt(e){let{logo:t}=e;const{withBaseUrl:n}=(0,Z.C)(),o={light:n(t.src),dark:n(t.srcDark??t.src)};return r.createElement(dt.Z,{className:(0,a.Z)("footer__logo",t.className),alt:t.alt,sources:o,width:t.width,height:t.height,style:t.style})}function mt(e){let{logo:t}=e;return t.href?r.createElement(V.Z,{href:t.href,className:ft,target:t.target},r.createElement(pt,{logo:t})):r.createElement(pt,{logo:t})}function ht(e){let{copyright:t}=e;return r.createElement("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}var bt,gt;function vt(){return vt=Object.assign?Object.assign.bind():function(e){for(var t=1;t{let{title:t,titleId:n,...a}=e;return r.createElement("svg",vt({width:170,height:64,viewBox:"0 0 170 64",fill:"none",xmlns:"http://www.w3.org/2000/svg","aria-labelledby":n},a),t?r.createElement("title",{id:n},t):null,bt||(bt=r.createElement("path",{d:"M86.658 0h3.686v13.151h7.469v3.3H86.658V0ZM98.633 10.307c0-3.473 2.021-6.363 6.013-6.363 3.756 0 5.87 2.653 5.87 5.989v1.339h-8.195c.022 1.431.753 2.444 2.396 2.444 1.339 0 1.926-.657 2.137-1.22h3.499c-.329 2.206-2.279 4.156-5.636 4.156-3.876-.003-6.084-2.822-6.084-6.345Zm8.197-1.314c-.071-1.173-.752-2.089-2.173-2.089-1.551 0-2.232.916-2.303 2.089h4.476ZM113.568 12.515V7.233h-1.985V4.156h2.173V.94h3.452v3.216h2.936v3.077h-2.936v4.413c0 1.152.491 1.646 1.572 1.646h1.41v3.159h-2.491c-2.857 0-4.131-1.703-4.131-3.936ZM122.175 2.887V0h3.664v2.887l-.611 3.689h-2.444l-.609-3.689ZM127.355 12.282h3.615c0 .681.543 1.358 1.833 1.358s1.736-.47 1.736-.891c0-.543-.4-.799-1.244-.964l-1.809-.35c-1.972-.378-3.756-1.389-3.756-3.852 0-1.996 1.76-3.642 5.049-3.642 3.194 0 5.119 1.833 5.119 4.11h-3.568c.021-.563-.4-1.266-1.63-1.266-.894 0-1.431.374-1.431.844s.328.728.915.845l2.347.445c1.879.353 3.639 1.223 3.639 3.803 0 2.537-2.254 3.922-5.375 3.922-3.83.005-5.37-1.85-5.44-4.362ZM90.38 36.278h-.093l-.375 1.173h-3.243V20.07h3.618v6.271h.092c.59-.706 1.526-1.385 3.26-1.385 3.101 0 4.978 2.675 4.978 6.34 0 3.663-1.877 6.363-4.979 6.363-1.733-.006-2.67-.687-3.259-1.38Zm4.578-4.978c0-1.714-.586-3.17-2.417-3.17-1.83 0-2.415 1.445-2.415 3.159 0 1.714.636 3.194 2.42 3.194 1.785 0 2.412-1.48 2.412-3.194v.01ZM100.385 33.238v-8.08H104v6.953c0 1.407.635 2.255 2.067 2.255 1.293 0 2.232-.916 2.232-2.396v-6.812h3.615V37.44h-3.24l-.271-1.173h-.093c-.682.798-1.763 1.385-3.36 1.385-2.735 0-4.565-1.714-4.565-4.414ZM113.864 20.041h3.852v3.662h-3.852V20.04Zm.117 5.117h3.615V37.44h-3.615V25.158ZM119.709 20.063h3.618v17.383h-3.618V20.063ZM124.853 31.289c0-3.664 1.88-6.34 4.979-6.34 1.738 0 2.675.68 3.259 1.386h.092v-6.272h3.618v17.383h-3.24l-.378-1.173h-.092c-.589.703-1.526 1.385-3.259 1.385-3.099-.006-4.979-2.681-4.979-6.37Zm8.502 0c0-1.714-.587-3.17-2.42-3.17-1.834 0-2.418 1.456-2.418 3.17 0 1.713.633 3.194 2.418 3.194 1.784 0 2.42-1.48 2.42-3.194ZM85.928 52.259c0-3.713 2.172-6.342 6.083-6.342 3.64 0 5.52 2.208 5.682 5.049h-3.64c-.116-1.087-.868-1.88-2.042-1.88-1.526 0-2.395.965-2.395 3.173s.869 3.191 2.395 3.191a1.982 1.982 0 0 0 2.043-1.877h3.64c-.164 2.841-2.021 5.05-5.59 5.05-3.922 0-6.176-2.633-6.176-6.364ZM99.453 41.034h3.618v6.268h.095c.679-.798 1.76-1.385 3.357-1.385 2.716 0 4.555 1.692 4.555 4.416v8.078h-3.615v-6.95c0-1.41-.636-2.258-2.067-2.258-1.293 0-2.325.918-2.325 2.396v6.812h-3.618V41.034ZM112.604 54.771c0-2.279 1.551-3.78 4.932-3.78h2.629v-.658c0-.847-.543-1.504-1.876-1.504-1.127 0-1.785.61-1.785 1.358h-3.384c0-2.304 1.668-4.275 5.286-4.275 3.356 0 5.377 1.855 5.377 4.416v8.077h-3.237l-.272-1.105h-.095c-.682.777-1.76 1.317-3.289 1.317-2.759.006-4.286-1.662-4.286-3.846Zm7.561-.839v-.516h-2.335c-1.149 0-1.668.516-1.668 1.173 0 .706.565 1.223 1.646 1.223 1.488-.009 2.357-.878 2.357-1.88ZM125.896 46.129h3.241l.271 1.173h.093c.681-.798 1.762-1.385 3.359-1.385 2.716 0 4.555 1.714 4.555 4.416v8.077H133.8v-6.95c0-1.41-.636-2.257-2.067-2.257-1.293 0-2.232.918-2.232 2.396v6.811h-3.605V46.13ZM139.305 59.467h3.531c.095.815.918 1.431 2.045 1.431 1.597 0 2.393-.844 2.393-1.947v-1.717h-.092c-.587.707-1.527 1.388-3.26 1.388-3.099 0-4.978-2.678-4.978-6.342 0-3.663 1.879-6.363 4.978-6.363 1.739 0 2.678.681 3.26 1.385h.092l.378-1.173h3.24v12.868c0 3.077-2.583 5.003-6.011 5.003-3.3 0-5.505-1.763-5.576-4.533Zm8.148-7.187c0-1.713-.633-3.194-2.42-3.194s-2.417 1.48-2.417 3.194.587 3.17 2.417 3.17c1.831 0 2.42-1.456 2.42-3.17ZM152.432 52.28c0-3.473 2.018-6.363 6.01-6.363 3.759 0 5.872 2.653 5.872 5.975v1.339h-8.188c.024 1.431.752 2.444 2.395 2.444 1.339 0 1.926-.657 2.138-1.222h3.498c-.329 2.208-2.276 4.158-5.636 4.158-3.881.011-6.089-2.808-6.089-6.33Zm8.194-1.314c-.071-1.173-.75-2.092-2.173-2.092-1.548 0-2.23.919-2.3 2.092h4.473ZM165.841 54.747h3.864v3.664h-3.851l-.013-3.664ZM34.135 41.327 0 21.617v17.07l34.135 19.707 34.137-19.707v-17.07l-34.137 19.71Z",fill:"#000"})),gt||(gt=r.createElement("path",{d:"M41.87 0 24.803 9.854v17.07l17.067-9.857V0Z",fill:"#000"})))};var kt,St,wt,Et;function xt(){return xt=Object.assign?Object.assign.bind():function(e){for(var t=1;t{let{title:t,titleId:n,...a}=e;return r.createElement("svg",xt({width:741,height:240,viewBox:"0 0 741 240",fill:"none",xmlns:"http://www.w3.org/2000/svg","aria-labelledby":n},a),t?r.createElement("title",{id:n},t):null,kt||(kt=r.createElement("rect",{x:8,y:2,width:725,height:224,rx:50,fill:"#3164FA"})),St||(St=r.createElement("path",{d:"M487.792 106c11.115 0 18.097 3.146 24.711 8.791l-7.165 8.606c-4.961-4.257-9.922-6.848-18.006-6.848-11.758 0-20.853 10.365-20.853 22.765l.006.771c.252 13.026 8.915 22.549 21.858 22.549 6.155 0 11.575-1.944 15.525-4.905v-12.03l10.932-9.994v27.206c-6.431 5.46-15.433 10.087-26.824 10.087-20.119 0-33.347-14.436-33.347-33.314l.005-.775c.293-17.88 13.894-32.909 33.158-32.909Zm72.752 0c19.75 0 33.53 15.084 33.53 33.314l-.005.769c-.296 17.882-14.171 32.915-33.709 32.915-19.751 0-33.53-15.084-33.53-33.314l.005-.769c.296-17.882 14.171-32.915 33.709-32.915Zm-284.778.648 28.294 65.24-11.502-.001-22.212-51.636-22.049 51.636-11.297.001 28.294-65.24h10.472Zm145.733 0 28.294 65.24-11.502-.001-22.212-51.636-22.049 51.636-11.297.001 28.294-65.24h10.472Zm195.24.462 34.449 44.789V107.11h11.115v64.778h-9.462l-35.459-46.085v46.085h-11.116V107.11h10.473Zm-56.379 9.439c-12.769 0-21.68 10.18-21.68 22.765l.006.739c.26 12.334 9.186 22.396 21.858 22.396 12.769 0 21.68-10.18 21.68-22.765l-.006-.739c-.26-12.334-9.186-22.396-21.858-22.396ZM346.406 106c8.1 0 14.451 2.446 18.593 6.584 3.405 3.669 5.338 8.466 5.338 14.204l-.002.539c-.133 10.374-6.171 16.703-14.698 19.414l-.579.177 17.396 24.927h-13.438l-15.831-22.952-8.31-.002 5.831-10.253 4.872.002c7.916 0 13.018-4.042 13.246-10.547l.008-.458-.002-.439c-.113-6.986-4.976-10.661-13.344-10.661h-16.475l-.002 20.354-.009-.001v14.684l.009-.005.002 20.278H317.69V106h28.716Z",fill:"#fff"})),wt||(wt=r.createElement("path",{fillRule:"evenodd",clipRule:"evenodd",d:"m110.424 45.777-6.942-7.366c12.003-1.547 43.674.436 74.334 20.741.398 2.804.313 5.6.313 5.6l2.259 1.223.013.02.004-.03.046.029c1.268 2.176 2.548 5.42 3.367 9.238.99 4.62 1.272 9.937.118 15.023-1.163 5.124-3.371 9.353-5.533 12.446-1.597 2.286-3.12 3.884-4.121 4.759-3.916.082-11.207 2.709-13.292 11.817-6.28 3.594-16.14 7.187-29.164 7.187-12.441 0-25.132-3.603-34.671-10.581-9.502-6.949-15.883-17.236-15.883-30.78 0-10.773 4.828-19.188 10.951-25.377 6.144-6.21 14.541-11.24 19.412-12.91l-1.211-1.04Zm53.801 17.672c-2.414 2.631-4.671 3.893-5.315 4.236-14.095-3.138-19.173-10.768-19.173-10.768 13.295-.086 25.294 3.223 34.074 8.82 0 0-4.753-1.61-9.586-2.288Z",fill:"#fff"})),Et||(Et=r.createElement("path",{d:"M103.285 47.814C73.065 53.9 50 81.114 50 114.02 50 155.624 85.123 190 128.449 190c32.353 0 59.284-19.806 73.365-46.304-18.727 4.447-41.086-3.459-41.229-20.742-6.741 3.47-16.448 6.55-28.759 6.55-12.975 0-26.32-3.748-36.463-11.166-10.18-7.446-17.127-18.6-17.127-33.234 0-11.77 5.297-20.914 11.83-27.518 3.78-3.784 8.962-7.376 13.219-9.772ZM186.786 74.594a41.013 41.013 0 0 0-1.528-5.359c8.124 6.079 14.451 14.374 13.924 25.932-.76 16.648-10.803 23.198-17.233 24.289 3.086-5.185.514-8.46-.515-9.552-.5-.531-1.534-1.425-3.308-1.983a34.685 34.685 0 0 0 2.765-3.477c2.342-3.352 4.739-7.938 6.005-13.515 1.275-5.615.95-11.393-.11-16.335ZM244.38 79h3.552v-8.787h6.341c.459 0 1.24-.034 1.886-.136 4.08-.646 6.137-3.74 6.137-7.717 0-3.96-2.04-7.072-6.137-7.7a13.267 13.267 0 0 0-1.886-.136h-9.893V79Zm3.552-12.153v-8.975h6.205c.442 0 1.036.034 1.546.17 2.176.51 2.992 2.516 2.992 4.318 0 1.801-.816 3.807-2.992 4.334-.51.119-1.104.153-1.546.153h-6.205ZM279.989 79.51c7.326 0 11.558-5.184 11.558-12.748 0-7.564-4.232-12.748-11.558-12.748-7.343 0-11.576 5.184-11.576 12.748 0 7.564 4.233 12.748 11.576 12.748Zm-7.802-12.748c.017-5.61 2.6-9.417 7.802-9.366 5.201.034 7.785 3.757 7.785 9.366 0 5.61-2.584 9.417-7.785 9.366-5.202-.034-7.819-3.757-7.802-9.366ZM303.172 79h3.536l5.252-18.306L317.212 79h3.536l7.122-24.476h-3.739l-5.151 18.51-5.15-18.51-3.74.017-5.15 18.493-5.15-18.51h-3.723L303.172 79ZM334.801 79h15.638v-3.348h-12.085v-7.564H348.4v-3.349h-10.046v-6.867h12.085v-3.348h-15.638V79ZM358.601 79h3.553v-8.787h6.493L372.913 79h4.063l-4.624-9.484c2.771-1.207 4.165-3.893 4.165-7.156 0-3.96-2.04-7.072-6.137-7.7a13.257 13.257 0 0 0-1.886-.136h-9.893V79Zm3.553-12.153v-8.975h6.204c.442 0 1.037.034 1.546.17 2.176.51 2.992 2.516 2.992 4.318 0 1.801-.816 3.807-2.992 4.334-.509.119-1.104.153-1.546.153h-6.204ZM384.791 79h15.638v-3.348h-12.086v-7.564h10.046v-3.349h-10.046v-6.867h12.086v-3.348h-15.638V79ZM408.59 79h7.666c.442 0 1.904 0 3.043-.153 5.745-.73 8.805-5.847 8.805-12.085s-3.06-11.355-8.805-12.085c-1.139-.153-2.601-.153-3.043-.153h-7.666V79Zm3.638-3.382V57.906h4.028c.748 0 1.972.017 2.788.17 3.672.68 5.286 4.386 5.286 8.686 0 4.198-1.546 7.972-5.286 8.686-.816.153-2.006.17-2.788.17h-4.028ZM447.027 79h10.538c4.658 0 7.326-2.821 7.326-7.139 0-2.6-1.326-4.759-3.756-5.796 1.615-.935 2.6-2.72 2.6-4.963 0-3.332-2.413-6.578-7.088-6.578h-9.62V79Zm3.603-3.382v-7.751h6.612c2.448 0 4.012 1.7 4.012 3.926 0 2.38-1.802 3.825-4.233 3.825h-6.391Zm0-11.1v-6.646h5.966c2.125 0 3.502 1.36 3.502 3.264 0 2.142-1.53 3.382-3.502 3.382h-5.966ZM477.222 79h3.604V68.887l8.278-14.363h-4.148l-5.932 10.283-5.932-10.283h-4.148l8.278 14.363V79Z",fill:"#fff"})))},_t=[{title:"Company",links:[{title:"About",href:"https://docs.vocdoni.io/about-us/vision.html"},{title:"How we work",href:"https://docs.vocdoni.io/about-us/how-we-work.html"},{title:"Blog",href:"https://blog.vocdoni.io/vocdoni/"}]},{title:"Developer",links:[{title:"Developer Portal",href:"https://developer.vocdoni.io/"},{title:"Vocdoni API",href:"https://vocdoni.io/api"},{title:"Vocdoni APP",href:"https://vocdoni.app/"}]},{title:"Resources",links:[{title:"Guides",href:"#",soon:!0},{title:"Tutorials",href:"#",soon:!0}]},{title:"Contact",links:[{title:"info@vocdoni.io",href:"mailto:info@vocdoni.io"}]}],It=e=>{let{children:t}=e;return r.createElement(Nt,null,r.createElement("div",null,t),r.createElement(Mt,null,"Soon"))},Tt=e=>{let{title:t,links:n}=e;return r.createElement(At,null,r.createElement("h4",null,t),r.createElement("div",null,n.map(((e,t)=>r.createElement("div",{key:t},e.soon?r.createElement(It,null,e.title):r.createElement(Ot,{href:e.href},e.title),r.createElement("br",null))))))},Pt=()=>r.createElement(Lt,null,r.createElement(Rt,null,r.createElement(yt,null),r.createElement(Ct,{height:"93px",width:"130px"})),_t.map(((e,t)=>r.createElement(Tt,{key:t,title:e.title,links:e.links})))),At=Ke.ZP.div.attrs({className:"flex flex-col align-center gap-2 "})``,Rt=(0,Ke.ZP)(At).attrs({className:"gap-1 justify-center items-center"})``,Lt=Ke.ZP.div.attrs({className:"flex flex-wrap justify-between my-6 py-8 px-8 md:px-4 gap-8"})``,Ot=Ke.ZP.a.attrs({className:"text-sm text-black"})``,Nt=Ke.ZP.div.attrs({className:"text-sm text-gray-600 cursor-wait flex"})``,Mt=Ke.ZP.div.attrs({className:"-mt-1 ml-1 text-gray-600 text-xs"})``;var Dt=n(88357);function zt(e){return(0,Dt.w_)({tag:"svg",attr:{viewBox:"0 0 24 24"},child:[{tag:"g",attr:{},child:[{tag:"path",attr:{fill:"none",d:"M0 0h24v24H0z"}},{tag:"path",attr:{fillRule:"nonzero",d:"M10.076 11c.6 0 1.086.45 1.075 1 0 .55-.474 1-1.075 1C9.486 13 9 12.55 9 12s.475-1 1.076-1zm3.848 0c.601 0 1.076.45 1.076 1s-.475 1-1.076 1c-.59 0-1.075-.45-1.075-1s.474-1 1.075-1zm4.967-9C20.054 2 21 2.966 21 4.163V23l-2.211-1.995-1.245-1.176-1.317-1.25.546 1.943H5.109C3.946 20.522 3 19.556 3 18.359V4.163C3 2.966 3.946 2 5.109 2H18.89zm-3.97 13.713c2.273-.073 3.148-1.596 3.148-1.596 0-3.381-1.482-6.122-1.482-6.122-1.48-1.133-2.89-1.102-2.89-1.102l-.144.168c1.749.546 2.561 1.334 2.561 1.334a8.263 8.263 0 0 0-3.096-1.008 8.527 8.527 0 0 0-2.077.02c-.062 0-.114.011-.175.021-.36.032-1.235.168-2.335.662-.38.178-.607.305-.607.305s.854-.83 2.705-1.376l-.103-.126s-1.409-.031-2.89 1.103c0 0-1.481 2.74-1.481 6.121 0 0 .864 1.522 3.137 1.596 0 0 .38-.472.69-.871-1.307-.4-1.8-1.24-1.8-1.24s.102.074.287.179c.01.01.02.021.041.031.031.022.062.032.093.053.257.147.514.262.75.357.422.168.926.336 1.513.452a7.06 7.06 0 0 0 2.664.01 6.666 6.666 0 0 0 1.491-.451c.36-.137.761-.337 1.183-.62 0 0-.514.861-1.862 1.25.309.399.68.85.68.85z"}}]}]})(e)}function Ft(e){return(0,Dt.w_)({tag:"svg",attr:{viewBox:"0 0 24 24"},child:[{tag:"g",attr:{},child:[{tag:"path",attr:{fill:"none",d:"M0 0h24v24H0z"}},{tag:"path",attr:{d:"M22.162 5.656a8.384 8.384 0 0 1-2.402.658A4.196 4.196 0 0 0 21.6 4c-.82.488-1.719.83-2.656 1.015a4.182 4.182 0 0 0-7.126 3.814 11.874 11.874 0 0 1-8.62-4.37 4.168 4.168 0 0 0-.566 2.103c0 1.45.738 2.731 1.86 3.481a4.168 4.168 0 0 1-1.894-.523v.052a4.185 4.185 0 0 0 3.355 4.101 4.21 4.21 0 0 1-1.89.072A4.185 4.185 0 0 0 7.97 16.65a8.394 8.394 0 0 1-6.191 1.732 11.83 11.83 0 0 0 6.41 1.88c7.693 0 11.9-6.373 11.9-11.9 0-.18-.005-.362-.013-.54a8.496 8.496 0 0 0 2.087-2.165z"}}]}]})(e)}const Bt=(new Date).getFullYear(),$t=()=>r.createElement(Ut,null,r.createElement("div",null,"Copyright \xa9 ",Bt," Vocdoni, Inc. All rights reserved."),r.createElement(jt,null,r.createElement(zt,{href:"https://t.co/1JrIv5eVPF",size:"1.75em"}),r.createElement(Ft,{href:"https://twitter.com/vocdoni",size:"1.75em"}))),Ut=Ke.ZP.div.attrs({className:"pt-5 pb-3 px-3 text-xs text-monospace items-center content-center flex sm:flex-row justify-between flex-col"})` -`,jt=Ke.ZP.div.attrs({className:"flex gap-3 flex-row"})` -`,Vt=()=>r.createElement(Ht,null,r.createElement(Pt,null),r.createElement(Zt,null),r.createElement($t,null)),Zt=Ke.ZP.div.attrs({className:"border-b w-full border-black"})``,Ht=Ke.ZP.div.attrs({className:"bg-white md:px-10"})``;function Wt(e){let{style:t,links:n,logo:a,copyright:o}=e;return r.createElement(Vt,null)}function Gt(){const{footer:e}=(0,f.L)();if(!e)return null;const{copyright:t,links:n,logo:a,style:o}=e;return r.createElement(Wt,{style:o,links:n&&n.length>0&&r.createElement(ut,{links:n}),logo:a&&r.createElement(mt,{logo:a}),copyright:t&&r.createElement(ht,{copyright:t})})}const qt=r.memo(Gt);var Kt=n(902),Yt=n(7094),Qt=n(12466);const Xt=(0,Kt.Qc)([R.S,p.pl,Yt.z,Qt.OC,Oe.L5,i.VC,He.V]);function Jt(e){let{children:t}=e;return r.createElement(Xt,null,t)}function en(e){let{error:t,tryAgain:n}=e;return r.createElement("main",{className:"container margin-vert--xl"},r.createElement("div",{className:"row"},r.createElement("div",{className:"col col--6 col--offset-3"},r.createElement("h1",{className:"hero__title"},r.createElement(h.Z,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed"},"This page crashed.")),r.createElement("p",null,t.message),r.createElement("div",null,r.createElement("button",{type:"button",onClick:n},r.createElement(h.Z,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again when the page crashed"},"Try again"))))))}const tn="mainWrapper_z2l0";function nn(e){const{children:t,noFooter:n,wrapperClassName:u,title:f,description:p}=e;return(0,l.t)(),r.createElement(Jt,null,r.createElement(i.d,{title:f,description:p}),r.createElement(d,null),r.createElement(C,null),r.createElement(tt,null),r.createElement("div",{id:s.u,className:(0,a.Z)(c.k.wrapper.main,tn,u)},r.createElement(o.Z,{fallback:e=>r.createElement(en,e)},t)),!n&&r.createElement(qt,null))}},21327:(e,t,n)=>{"use strict";n.d(t,{Z:()=>d});var r=n(87462),a=n(67294),o=n(39960),i=n(44996),s=n(52263),c=n(86668),l=n(50941);function u(e){let{logo:t,alt:n,imageClassName:r}=e;const o={light:(0,i.Z)(t.src),dark:(0,i.Z)(t.srcDark||t.src)},s=a.createElement(l.Z,{className:t.className,sources:o,height:t.height,width:t.width,alt:n,style:t.style});return r?a.createElement("div",{className:r},s):s}function d(e){const{siteConfig:{title:t}}=(0,s.Z)(),{navbar:{title:n,logo:l}}=(0,c.L)(),{imageClassName:d,titleClassName:f,...p}=e,m=(0,i.Z)(l?.href||"/"),h=n?"":t,b=l?.alt??h;return a.createElement(o.Z,(0,r.Z)({to:m},p,l?.target&&{target:l.target}),l&&a.createElement(u,{logo:l,alt:b,imageClassName:d}),null!=n&&a.createElement("b",{className:f},n))}},90197:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(67294),a=n(35742);function o(e){let{locale:t,version:n,tag:o}=e;const i=t;return r.createElement(a.Z,null,t&&r.createElement("meta",{name:"docusaurus_locale",content:t}),n&&r.createElement("meta",{name:"docusaurus_version",content:n}),o&&r.createElement("meta",{name:"docusaurus_tag",content:o}),i&&r.createElement("meta",{name:"docsearch:language",content:i}),n&&r.createElement("meta",{name:"docsearch:version",content:n}),o&&r.createElement("meta",{name:"docsearch:docusaurus_tag",content:o}))}},50941:(e,t,n)=>{"use strict";n.d(t,{Z:()=>l});var r=n(87462),a=n(67294),o=n(86010),i=n(72389),s=n(92949);const c={themedImage:"themedImage_ToTc","themedImage--light":"themedImage--light_HNdA","themedImage--dark":"themedImage--dark_i4oU"};function l(e){const t=(0,i.Z)(),{colorMode:n}=(0,s.I)(),{sources:l,className:u,alt:d,...f}=e,p=t?"dark"===n?["dark"]:["light"]:["light","dark"];return a.createElement(a.Fragment,null,p.map((e=>a.createElement("img",(0,r.Z)({key:e,src:l[e],alt:d,className:(0,o.Z)(c.themedImage,c[`themedImage--${e}`],u)},f)))))}},86043:(e,t,n)=>{"use strict";n.d(t,{u:()=>i,z:()=>m});var r=n(87462),a=n(67294),o=n(10412);function i(e){let{initialState:t}=e;const[n,r]=(0,a.useState)(t??!1),o=(0,a.useCallback)((()=>{r((e=>!e))}),[]);return{collapsed:n,setCollapsed:r,toggleCollapsed:o}}const s={display:"none",overflow:"hidden",height:"0px"},c={display:"block",overflow:"visible",height:"auto"};function l(e,t){const n=t?s:c;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function u(e){let{collapsibleRef:t,collapsed:n,animation:r}=e;const o=(0,a.useRef)(!1);(0,a.useEffect)((()=>{const e=t.current;function a(){const t=e.scrollHeight,n=r?.duration??function(e){const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(t);return{transition:`height ${n}ms ${r?.easing??"ease-in-out"}`,height:`${t}px`}}function i(){const t=a();e.style.transition=t.transition,e.style.height=t.height}if(!o.current)return l(e,n),void(o.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{n?(i(),requestAnimationFrame((()=>{e.style.height=s.height,e.style.overflow=s.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{i()})))}));return()=>cancelAnimationFrame(t)}()}),[t,n,r])}function d(e){if(!o.Z.canUseDOM)return e?s:c}function f(e){let{as:t="div",collapsed:n,children:r,animation:o,onCollapseTransitionEnd:i,className:s,disableSSRStyle:c}=e;const f=(0,a.useRef)(null);return u({collapsibleRef:f,collapsed:n,animation:o}),a.createElement(t,{ref:f,style:c?void 0:d(n),onTransitionEnd:e=>{"height"===e.propertyName&&(l(f.current,n),i?.(n))},className:s},r)}function p(e){let{collapsed:t,...n}=e;const[o,i]=(0,a.useState)(!t),[s,c]=(0,a.useState)(t);return(0,a.useLayoutEffect)((()=>{t||i(!0)}),[t]),(0,a.useLayoutEffect)((()=>{o&&c(t)}),[o,t]),o?a.createElement(f,(0,r.Z)({},n,{collapsed:s})):null}function m(e){let{lazy:t,...n}=e;const r=t?p:f;return a.createElement(r,n)}},59689:(e,t,n)=>{"use strict";n.d(t,{nT:()=>m,pl:()=>p});var r=n(67294),a=n(72389),o=n(50012),i=n(902),s=n(86668);const c=(0,o.W)("docusaurus.announcement.dismiss"),l=(0,o.W)("docusaurus.announcement.id"),u=()=>"true"===c.get(),d=e=>c.set(String(e)),f=r.createContext(null);function p(e){let{children:t}=e;const n=function(){const{announcementBar:e}=(0,s.L)(),t=(0,a.Z)(),[n,o]=(0,r.useState)((()=>!!t&&u()));(0,r.useEffect)((()=>{o(u())}),[]);const i=(0,r.useCallback)((()=>{d(!0),o(!0)}),[]);return(0,r.useEffect)((()=>{if(!e)return;const{id:t}=e;let n=l.get();"annoucement-bar"===n&&(n="announcement-bar");const r=t!==n;l.set(t),r&&d(!1),!r&&u()||o(!1)}),[e]),(0,r.useMemo)((()=>({isActive:!!e&&!n,close:i})),[e,n,i])}();return r.createElement(f.Provider,{value:n},t)}function m(){const e=(0,r.useContext)(f);if(!e)throw new i.i6("AnnouncementBarProvider");return e}},92949:(e,t,n)=>{"use strict";n.d(t,{I:()=>b,S:()=>h});var r=n(67294),a=n(10412),o=n(902),i=n(50012),s=n(86668);const c=r.createContext(void 0),l="theme",u=(0,i.W)(l),d="light",f="dark",p=e=>e===f?f:d;function m(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,s.L)(),[o,i]=(0,r.useState)((e=>a.Z.canUseDOM?p(document.documentElement.getAttribute("data-theme")):p(e))(e));(0,r.useEffect)((()=>{t&&u.del()}),[t]);const c=(0,r.useCallback)((function(t,r){void 0===r&&(r={});const{persist:a=!0}=r;t?(i(t),a&&(e=>{u.set(p(e))})(t)):(i(n?window.matchMedia("(prefers-color-scheme: dark)").matches?f:d:e),u.del())}),[n,e]);(0,r.useEffect)((()=>{document.documentElement.setAttribute("data-theme",p(o))}),[o]),(0,r.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==l)return;const t=u.get();null!==t&&c(p(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,c]);const m=(0,r.useRef)(!1);return(0,r.useEffect)((()=>{if(t&&!n)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),r=()=>{window.matchMedia("print").matches||m.current?m.current=window.matchMedia("print").matches:c(null)};return e.addListener(r),()=>e.removeListener(r)}),[c,t,n]),(0,r.useMemo)((()=>({colorMode:o,setColorMode:c,get isDarkTheme(){return o===f},setLightTheme(){c(d)},setDarkTheme(){c(f)}})),[o,c])}function h(e){let{children:t}=e;const n=m();return r.createElement(c.Provider,{value:n},t)}function b(){const e=(0,r.useContext)(c);if(null==e)throw new o.i6("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},60373:(e,t,n)=>{"use strict";n.d(t,{J:()=>y,L5:()=>g,Oh:()=>k});var r=n(67294),a=n(80143),o=n(29935),i=n(86668),s=n(53438),c=n(902),l=n(50012);const u=e=>`docs-preferred-version-${e}`,d=(e,t,n)=>{(0,l.W)(u(e),{persistence:t}).set(n)},f=(e,t)=>(0,l.W)(u(e),{persistence:t}).get(),p=(e,t)=>{(0,l.W)(u(e),{persistence:t}).del()};const m=r.createContext(null);function h(){const e=(0,a._r)(),t=(0,i.L)().docs.versionPersistence,n=(0,r.useMemo)((()=>Object.keys(e)),[e]),[o,s]=(0,r.useState)((()=>(e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}]))))(n)));(0,r.useEffect)((()=>{s(function(e){let{pluginIds:t,versionPersistence:n,allDocsData:r}=e;function a(e){const t=f(e,n);return r[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(p(e,n),{preferredVersionName:null})}return Object.fromEntries(t.map((e=>[e,a(e)])))}({allDocsData:e,versionPersistence:t,pluginIds:n}))}),[e,t,n]);return[o,(0,r.useMemo)((()=>({savePreferredVersion:function(e,n){d(e,t,n),s((t=>({...t,[e]:{preferredVersionName:n}})))}})),[t])]}function b(e){let{children:t}=e;const n=h();return r.createElement(m.Provider,{value:n},t)}function g(e){let{children:t}=e;return s.cE?r.createElement(b,null,t):r.createElement(r.Fragment,null,t)}function v(){const e=(0,r.useContext)(m);if(!e)throw new c.i6("DocsPreferredVersionContextProvider");return e}function y(e){void 0===e&&(e=o.m);const t=(0,a.zh)(e),[n,i]=v(),{preferredVersionName:s}=n[e];return{preferredVersion:t.versions.find((e=>e.name===s))??null,savePreferredVersionName:(0,r.useCallback)((t=>{i.savePreferredVersion(e,t)}),[i,e])}}function k(){const e=(0,a._r)(),[t]=v();function n(n){const r=e[n],{preferredVersionName:a}=t[n];return r.versions.find((e=>e.name===a))??null}const r=Object.keys(e);return Object.fromEntries(r.map((e=>[e,n(e)])))}},1116:(e,t,n)=>{"use strict";n.d(t,{V:()=>c,b:()=>s});var r=n(67294),a=n(902);const o=Symbol("EmptyContext"),i=r.createContext(o);function s(e){let{children:t,name:n,items:a}=e;const o=(0,r.useMemo)((()=>n&&a?{name:n,items:a}:null),[n,a]);return r.createElement(i.Provider,{value:o},t)}function c(){const e=(0,r.useContext)(i);if(e===o)throw new a.i6("DocsSidebarProvider");return e}},74477:(e,t,n)=>{"use strict";n.d(t,{E:()=>s,q:()=>i});var r=n(67294),a=n(902);const o=r.createContext(null);function i(e){let{children:t,version:n}=e;return r.createElement(o.Provider,{value:n},t)}function s(){const e=(0,r.useContext)(o);if(null===e)throw new a.i6("DocsVersionProvider");return e}},93163:(e,t,n)=>{"use strict";n.d(t,{M:()=>d,e:()=>f});var r=n(67294),a=n(13102),o=n(87524),i=n(91980),s=n(86668),c=n(902);const l=r.createContext(void 0);function u(){const e=function(){const e=(0,a.HY)(),{items:t}=(0,s.L)().navbar;return 0===t.length&&!e.component}(),t=(0,o.i)(),n=!e&&"mobile"===t,[c,l]=(0,r.useState)(!1);(0,i.R)((()=>{if(c)return l(!1),!1}));const u=(0,r.useCallback)((()=>{l((e=>!e))}),[]);return(0,r.useEffect)((()=>{"desktop"===t&&l(!1)}),[t]),(0,r.useMemo)((()=>({disabled:e,shouldRender:n,toggle:u,shown:c})),[e,n,u,c])}function d(e){let{children:t}=e;const n=u();return r.createElement(l.Provider,{value:n},t)}function f(){const e=r.useContext(l);if(void 0===e)throw new c.i6("NavbarMobileSidebarProvider");return e}},13102:(e,t,n)=>{"use strict";n.d(t,{HY:()=>s,Zo:()=>c,n2:()=>i});var r=n(67294),a=n(902);const o=r.createContext(null);function i(e){let{children:t}=e;const n=(0,r.useState)({component:null,props:null});return r.createElement(o.Provider,{value:n},t)}function s(){const e=(0,r.useContext)(o);if(!e)throw new a.i6("NavbarSecondaryMenuContentProvider");return e[0]}function c(e){let{component:t,props:n}=e;const i=(0,r.useContext)(o);if(!i)throw new a.i6("NavbarSecondaryMenuContentProvider");const[,s]=i,c=(0,a.Ql)(n);return(0,r.useEffect)((()=>{s({component:t,props:c})}),[s,t,c]),(0,r.useEffect)((()=>()=>s({component:null,props:null})),[s]),null}},76857:(e,t,n)=>{"use strict";n.d(t,{P:()=>c,Y:()=>u});var r=n(67294),a=n(902),o=n(93163),i=n(13102);const s=r.createContext(null);function c(e){let{children:t}=e;const n=function(){const e=(0,o.e)(),t=(0,i.HY)(),[n,s]=(0,r.useState)(!1),c=null!==t.component,l=(0,a.D9)(c);return(0,r.useEffect)((()=>{c&&!l&&s(!0)}),[c,l]),(0,r.useEffect)((()=>{c?e.shown||s(!0):s(!1)}),[e.shown,c]),(0,r.useMemo)((()=>[n,s]),[n])}();return r.createElement(s.Provider,{value:n},t)}function l(e){if(e.component){const t=e.component;return r.createElement(t,e.props)}}function u(){const e=(0,r.useContext)(s);if(!e)throw new a.i6("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,o=(0,r.useCallback)((()=>n(!1)),[n]),c=(0,i.HY)();return(0,r.useMemo)((()=>({shown:t,hide:o,content:l(c)})),[o,c,t])}},7094:(e,t,n)=>{"use strict";n.d(t,{U:()=>l,z:()=>c});var r=n(67294),a=n(50012),o=n(902);const i="docusaurus.tab.",s=r.createContext(void 0);function c(e){let{children:t}=e;const n=function(){const[e,t]=(0,r.useState)({}),n=(0,r.useCallback)(((e,t)=>{(0,a.W)(`docusaurus.tab.${e}`).set(t)}),[]);(0,r.useEffect)((()=>{try{const e={};(0,a._)().forEach((t=>{if(t.startsWith(i)){const n=t.substring(i.length);e[n]=(0,a.W)(t).get()}})),t(e)}catch(e){console.error(e)}}),[]);const o=(0,r.useCallback)(((e,r)=>{t((t=>({...t,[e]:r}))),n(e,r)}),[n]);return(0,r.useMemo)((()=>({tabGroupChoices:e,setTabGroupChoices:o})),[e,o])}();return r.createElement(s.Provider,{value:n},t)}function l(){const e=(0,r.useContext)(s);if(null==e)throw new o.i6("TabGroupChoiceProvider");return e}},99445:(e,t,n)=>{"use strict";n.d(t,{c:()=>i});var r=n(67294),a=n(85936),o=n(12466);function i(e){const[t,n]=(0,r.useState)(e),i=(0,r.useRef)(!1),s=(0,r.useRef)(0),c=(0,r.useCallback)((e=>{null!==e&&(s.current=e.getBoundingClientRect().height)}),[]);return(0,o.RF)(((t,r)=>{let{scrollY:a}=t;if(!e)return;if(a=o?n(!1):a+l{if(!e)return;const r=t.location.hash;if(r?document.getElementById(r.substring(1)):void 0)return i.current=!0,void n(!1);n(!0)})),{navbarRef:c,isNavbarVisible:t}}},19727:(e,t,n)=>{"use strict";n.d(t,{h:()=>a,t:()=>o});var r=n(67294);const a="navigation-with-keyboard";function o(){(0,r.useEffect)((()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(a),"mousedown"===e.type&&document.body.classList.remove(a)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(a),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},69800:(e,t,n)=>{"use strict";n.d(t,{N:()=>a});var r=n(67294);function a(e){void 0===e&&(e=!0),(0,r.useEffect)((()=>(document.body.style.overflow=e?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[e])}},66177:(e,t,n)=>{"use strict";n.d(t,{O:()=>s});var r=n(67294),a=n(16550),o=n(52263);const i="q";function s(){const e=(0,a.k6)(),{siteConfig:{baseUrl:t}}=(0,o.Z)(),[n,s]=(0,r.useState)("");(0,r.useEffect)((()=>{const e=new URLSearchParams(window.location.search).get(i)??"";s(e)}),[]);return{searchQuery:n,setSearchQuery:(0,r.useCallback)((t=>{const n=new URLSearchParams(window.location.search);t?n.set(i,t):n.delete(i),e.replace({search:n.toString()}),s(t)}),[e]),generateSearchPageLink:(0,r.useCallback)((e=>`${t}search?q=${encodeURIComponent(e)}`),[t])}}},87524:(e,t,n)=>{"use strict";n.d(t,{i:()=>l});var r=n(67294),a=n(10412);const o="desktop",i="mobile",s="ssr";function c(){return a.Z.canUseDOM?window.innerWidth>996?o:i:s}function l(){const[e,t]=(0,r.useState)((()=>c()));return(0,r.useEffect)((()=>{function e(){t(c())}return window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e),clearTimeout(undefined)}}),[]),e}},35281:(e,t,n)=>{"use strict";n.d(t,{k:()=>r});const r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",admonitionType:e=>`theme-admonition-${e}`},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{}}},53438:(e,t,n)=>{"use strict";n.d(t,{MN:()=>C,Wl:()=>h,_F:()=>v,cE:()=>f,em:()=>m,hI:()=>x,jA:()=>b,lO:()=>S,oz:()=>w,s1:()=>k,vY:()=>E,xz:()=>p});var r=n(67294),a=n(16550),o=n(18790),i=n(80143),s=n(60373),c=n(74477),l=n(1116),u=n(67392),d=n(48596);const f=!!i._r;function p(e){const t=(0,c.E)();if(!e)return;const n=t.docs[e];if(!n)throw new Error(`no version doc found by id=${e}`);return n}function m(e,t){for(const n of e)if("category"===n.type){if(t(n))return n;const e=m(n.items,t);if(e)return e}}function h(e){if(e.href)return e.href;for(const t of e.items){if("link"===t.type)return t.href;if("category"===t.type){const e=h(t);if(e)return e}}}function b(){const{pathname:e}=(0,a.TH)(),t=(0,l.V)();if(!t)throw new Error("Unexpected: cant find current sidebar in context");const n=y({sidebarItems:t.items,pathname:e,onlyCategories:!0}).slice(-1)[0];if(!n)throw new Error(`${e} is not associated with a category. useCurrentSidebarCategory() should only be used on category index pages.`);return n}const g=(e,t)=>void 0!==e&&(0,d.Mg)(e,t);function v(e,t){return"link"===e.type?g(e.href,t):"category"===e.type&&(g(e.href,t)||((e,t)=>e.some((e=>v(e,t))))(e.items,t))}function y(e){let{sidebarItems:t,pathname:n,onlyCategories:r=!1}=e;const a=[];return function e(t){for(const o of t)if("category"===o.type&&((0,d.Mg)(o.href,n)||e(o.items))||"link"===o.type&&(0,d.Mg)(o.href,n)){return r&&"category"!==o.type||a.unshift(o),!0}return!1}(t),a}function k(){const e=(0,l.V)(),{pathname:t}=(0,a.TH)(),n=(0,i.gA)()?.pluginData.breadcrumbs;return!1!==n&&e?y({sidebarItems:e.items,pathname:t}):null}function S(e){const{activeVersion:t}=(0,i.Iw)(e),{preferredVersion:n}=(0,s.J)(e),a=(0,i.yW)(e);return(0,r.useMemo)((()=>(0,u.j)([t,n,a].filter(Boolean))),[t,n,a])}function w(e,t){const n=S(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.sidebars?Object.entries(e.sidebars):[])),r=t.find((t=>t[0]===e));if(!r)throw new Error(`Can't find any sidebar with id "${e}" in version${n.length>1?"s":""} ${n.map((e=>e.name)).join(", ")}".\n Available sidebar ids are:\n - ${Object.keys(t).join("\n- ")}`);return r[1]}),[e,n])}function E(e,t){const n=S(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.docs)),r=t.find((t=>t.id===e));if(!r){if(n.flatMap((e=>e.draftIds)).includes(e))return null;throw new Error(`DocNavbarItem: couldn't find any doc with id "${e}" in version${n.length>1?"s":""} ${n.map((e=>e.name)).join(", ")}".\nAvailable doc ids are:\n- ${(0,u.j)(t.map((e=>e.id))).join("\n- ")}`)}return r}),[e,n])}function x(e){let{route:t,versionMetadata:n}=e;const r=(0,a.TH)(),i=t.routes,s=i.find((e=>(0,a.LX)(r.pathname,e)));if(!s)return null;const c=s.sidebar,l=c?n.docsSidebars[c]:void 0;return{docElement:(0,o.H)(i),sidebarName:c,sidebarItems:l}}function C(e){return e.filter((e=>"category"!==e.type||!!h(e)))}},42489:(e,t,n)=>{"use strict";function r(e){return"title"in e[0]}n.d(t,{a:()=>r})},82128:(e,t,n)=>{"use strict";n.d(t,{p:()=>a});var r=n(52263);function a(e){const{siteConfig:t}=(0,r.Z)(),{title:n,titleDelimiter:a}=t;return e?.trim().length?`${e.trim()} ${a} ${n}`:n}},91980:(e,t,n)=>{"use strict";n.d(t,{R:()=>i});var r=n(67294),a=n(16550),o=n(902);function i(e){!function(e){const t=(0,a.k6)(),n=(0,o.zX)(e);(0,r.useEffect)((()=>t.block(((e,t)=>n(e,t)))),[t,n])}(((t,n)=>{if("POP"===n)return e(t,n)}))}},67392:(e,t,n)=>{"use strict";function r(e,t){return void 0===t&&(t=(e,t)=>e===t),e.filter(((n,r)=>e.findIndex((e=>t(e,n)))!==r))}function a(e){return Array.from(new Set(e))}n.d(t,{j:()=>a,l:()=>r})},10833:(e,t,n)=>{"use strict";n.d(t,{FG:()=>f,d:()=>u,VC:()=>p});var r=n(67294),a=n(86010),o=n(35742),i=n(30226);function s(){const e=r.useContext(i._);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}var c=n(44996),l=n(82128);function u(e){let{title:t,description:n,keywords:a,image:i,children:s}=e;const u=(0,l.p)(t),{withBaseUrl:d}=(0,c.C)(),f=i?d(i,{absolute:!0}):void 0;return r.createElement(o.Z,null,t&&r.createElement("title",null,u),t&&r.createElement("meta",{property:"og:title",content:u}),n&&r.createElement("meta",{name:"description",content:n}),n&&r.createElement("meta",{property:"og:description",content:n}),a&&r.createElement("meta",{name:"keywords",content:Array.isArray(a)?a.join(","):a}),f&&r.createElement("meta",{property:"og:image",content:f}),f&&r.createElement("meta",{name:"twitter:image",content:f}),s)}const d=r.createContext(void 0);function f(e){let{className:t,children:n}=e;const i=r.useContext(d),s=(0,a.Z)(i,t);return r.createElement(d.Provider,{value:s},r.createElement(o.Z,null,r.createElement("html",{className:s})),n)}function p(e){let{children:t}=e;const n=s(),o=`plugin-${n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const i=`plugin-id-${n.plugin.id}`;return r.createElement(f,{className:(0,a.Z)(o,i)},t)}},58978:(e,t,n)=>{"use strict";n.d(t,{A:()=>s,V:()=>c});var r=n(67294),a=n(93163),o=n(13102),i=n(76857);function s(e){function t(e){return"left"===(e.position??"right")}return[e.filter(t),e.filter((e=>!t(e)))]}function c(e){let{children:t}=e;return r.createElement(o.n2,null,r.createElement(a.M,null,r.createElement(i.P,null,t)))}},902:(e,t,n)=>{"use strict";n.d(t,{D9:()=>i,LI:()=>a,Qc:()=>l,Ql:()=>c,i6:()=>s,zX:()=>o});var r=n(67294);const a=n(10412).Z.canUseDOM?r.useLayoutEffect:r.useEffect;function o(e){const t=(0,r.useRef)(e);return a((()=>{t.current=e}),[e]),(0,r.useCallback)((function(){return t.current(...arguments)}),[])}function i(e){const t=(0,r.useRef)();return a((()=>{t.current=e})),t.current}class s extends Error{constructor(e,t){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?\w+)/)?.groups.name??""} is called outside the <${e}>. ${t??""}`}}function c(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,r.useMemo)((()=>e),t.flat())}function l(e){return t=>{let{children:n}=t;return r.createElement(r.Fragment,null,e.reduceRight(((e,t)=>r.createElement(t,null,e)),n))}}},98022:(e,t,n)=>{"use strict";function r(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}n.d(t,{F:()=>r})},48596:(e,t,n)=>{"use strict";n.d(t,{Mg:()=>i,Ns:()=>s});var r=n(67294),a=n(723),o=n(52263);function i(e,t){const n=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return n(e)===n(t)}function s(){const{baseUrl:e}=(0,o.Z)().siteConfig;return(0,r.useMemo)((()=>function(e){let{baseUrl:t,routes:n}=e;function r(e){return e.path===t&&!0===e.exact}function a(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(r)||e(t.filter(a).flatMap((e=>e.routes??[])))}(n)}({routes:a.Z,baseUrl:e})),[e])}},12466:(e,t,n)=>{"use strict";n.d(t,{Ct:()=>p,OC:()=>c,RF:()=>d,o5:()=>f,sG:()=>l});var r=n(67294),a=n(10412),o=n(72389),i=n(902);const s=r.createContext(void 0);function c(e){let{children:t}=e;const n=function(){const e=(0,r.useRef)(!0);return(0,r.useMemo)((()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}})),[])}();return r.createElement(s.Provider,{value:n},t)}function l(){const e=(0,r.useContext)(s);if(null==e)throw new i.i6("ScrollControllerProvider");return e}const u=()=>a.Z.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function d(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:n}=l(),a=(0,r.useRef)(u()),o=(0,i.zX)(e);(0,r.useEffect)((()=>{const e=()=>{if(!n.current)return;const e=u();o(e,a.current),a.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[o,n,...t])}function f(){const e=l(),t=function(){const e=(0,r.useRef)({elem:null,top:0}),t=(0,r.useCallback)((t=>{e.current={elem:t,top:t.getBoundingClientRect().top}}),[]),n=(0,r.useCallback)((()=>{const{current:{elem:t,top:n}}=e;if(!t)return{restored:!1};const r=t.getBoundingClientRect().top-n;return r&&window.scrollBy({left:0,top:r}),e.current={elem:null,top:0},{restored:0!==r}}),[]);return(0,r.useMemo)((()=>({save:t,restore:n})),[n,t])}(),n=(0,r.useRef)(void 0),a=(0,r.useCallback)((r=>{t.save(r),e.disableScrollEvents(),n.current=()=>{const{restored:r}=t.restore();if(n.current=void 0,r){const t=()=>{e.enableScrollEvents(),window.removeEventListener("scroll",t)};window.addEventListener("scroll",t)}else e.enableScrollEvents()}}),[e,t]);return(0,r.useLayoutEffect)((()=>{n.current?.()})),{blockElementScrollPositionUntilNextRender:a}}function p(){const e=(0,r.useRef)(null),t=(0,o.Z)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:n=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(n):function(e){let t=null;const n=document.documentElement.scrollTop>e;return function r(){const a=document.documentElement.scrollTop;(n&&a>e||!n&&at&&cancelAnimationFrame(t)}(n)},cancelScroll:()=>e.current?.()}}},43320:(e,t,n)=>{"use strict";n.d(t,{HX:()=>i,_q:()=>c,os:()=>s});var r=n(80143),a=n(52263),o=n(60373);const i="default";function s(e,t){return`docs-${e}-${t}`}function c(){const{i18n:e}=(0,a.Z)(),t=(0,r._r)(),n=(0,r.WS)(),c=(0,o.Oh)();const l=[i,...Object.keys(t).map((function(e){const r=n?.activePlugin.pluginId===e?n.activeVersion:void 0,a=c[e],o=t[e].versions.find((e=>e.isLast));return s(e,(r??a??o).name)}))];return{locale:e.currentLocale,tags:l}}},55225:(e,t,n)=>{"use strict";n.d(t,{l:()=>f,u:()=>c});var r=n(87462),a=n(67294),o=n(16550),i=n(95999),s=n(85936);const c="docusaurus_skipToContent_fallback";function l(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function u(){const e=(0,a.useRef)(null),{action:t}=(0,o.k6)(),n=(0,a.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(c);t&&l(t)}),[]);return(0,s.S)((n=>{let{location:r}=n;e.current&&!r.hash&&"PUSH"===t&&l(e.current)})),{containerRef:e,onClick:n}}const d=(0,i.I)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function f(e){const t=e.children??d,{containerRef:n,onClick:o}=u();return a.createElement("div",{ref:n,role:"region","aria-label":d},a.createElement("a",(0,r.Z)({},e,{href:`#${c}`,onClick:o}),t))}},50012:(e,t,n)=>{"use strict";n.d(t,{W:()=>s,_:()=>c});const r="localStorage";function a(e){if(void 0===e&&(e=r),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(n){return t=n,o||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),o=!0),null}var t}let o=!1;const i={get:()=>null,set:()=>{},del:()=>{}};function s(e,t){if("undefined"==typeof window)return function(e){function t(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:t,set:t,del:t}}(e);const n=a(t?.persistence);return null===n?i:{get:()=>{try{return n.getItem(e)}catch(t){return console.error(`Docusaurus storage error, can't get key=${e}`,t),null}},set:t=>{try{n.setItem(e,t)}catch(r){console.error(`Docusaurus storage error, can't set ${e}=${t}`,r)}},del:()=>{try{n.removeItem(e)}catch(t){console.error(`Docusaurus storage error, can't delete key=${e}`,t)}}}}function c(e){void 0===e&&(e=r);const t=a(e);if(!t)return[];const n=[];for(let r=0;r{"use strict";n.d(t,{l:()=>o});var r=n(52263),a=n(16550);function o(){const{siteConfig:{baseUrl:e,url:t},i18n:{defaultLocale:n,currentLocale:o}}=(0,r.Z)(),{pathname:i}=(0,a.TH)(),s=o===n?e:e.replace(`/${o}/`,"/"),c=i.replace(e,"");return{createUrl:function(e){let{locale:r,fullyQualified:a}=e;return`${a?t:""}${function(e){return e===n?`${s}`:`${s}${e}/`}(r)}${c}`}}}},51753:(e,t,n)=>{"use strict";n.d(t,{b:()=>o});var r=n(16550),a=n(52263);function o(){const{siteConfig:{baseUrl:e}}=(0,a.Z)(),{pathname:t}=(0,r.TH)();return t.replace(e,"/")}},85936:(e,t,n)=>{"use strict";n.d(t,{S:()=>i});var r=n(67294),a=n(16550),o=n(902);function i(e){const t=(0,a.TH)(),n=(0,o.D9)(t),i=(0,o.zX)(e);(0,r.useEffect)((()=>{n&&t!==n&&i({location:t,previousLocation:n})}),[i,t,n])}},86668:(e,t,n)=>{"use strict";n.d(t,{L:()=>a});var r=n(52263);function a(){return(0,r.Z)().siteConfig.themeConfig}},8802:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e,t){const{trailingSlash:n,baseUrl:r}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[a]=e.split(/[#?]/),o="/"===a||a===r?a:(i=a,n?function(e){return e.endsWith("/")?e:`${e}/`}(i):function(e){return e.endsWith("/")?e.slice(0,-1):e}(i));var i;return e.replace(a,o)}},18780:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.applyTrailingSlash=t.blogPostContainerID=void 0,t.blogPostContainerID="post-content";var a=n(8802);Object.defineProperty(t,"applyTrailingSlash",{enumerable:!0,get:function(){return r(a).default}})},19548:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(67294);const a="iconExternalLink_2l9O";function o(e){let{width:t=13.5,height:n=13.5}=e;return r.createElement("svg",{stroke:"currentColor",fill:"currentColor",strokeWidth:"0","aria-hidden":"true",viewBox:"0 0 15 15",height:n,width:t,xmlns:"http://www.w3.org/2000/svg",className:a},r.createElement("path",{fillRule:"evenodd",d:"M14 2.5a.5.5 0 0 0-.5-.5h-6a.5.5 0 0 0 0 1h4.793L2.146 13.146a.5.5 0 0 0 .708.708L13 3.707V8.5a.5.5 0 0 0 1 0v-6z"}))}},86010:(e,t,n)=>{"use strict";function r(e){var t,n,a="";if("string"==typeof e||"number"==typeof e)a+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;ta});const a=function(){for(var e,t,n=0,a="";n{"use strict";n.d(t,{lX:()=>k,q_:()=>_,ob:()=>p,PP:()=>T,Ep:()=>f});var r=n(87462);function a(e){return"/"===e.charAt(0)}function o(e,t){for(var n=t,r=n+1,a=e.length;r=0;f--){var p=i[f];"."===p?o(i,f):".."===p?(o(i,f),d++):d&&(o(i,f),d--)}if(!l)for(;d--;d)i.unshift("..");!l||""===i[0]||i[0]&&a(i[0])||i.unshift("");var m=i.join("/");return n&&"/"!==m.substr(-1)&&(m+="/"),m};var s=n(38776);function c(e){return"/"===e.charAt(0)?e:"/"+e}function l(e){return"/"===e.charAt(0)?e.substr(1):e}function u(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function d(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function f(e){var t=e.pathname,n=e.search,r=e.hash,a=t||"/";return n&&"?"!==n&&(a+="?"===n.charAt(0)?n:"?"+n),r&&"#"!==r&&(a+="#"===r.charAt(0)?r:"#"+r),a}function p(e,t,n,a){var o;"string"==typeof e?(o=function(e){var t=e||"/",n="",r="",a=t.indexOf("#");-1!==a&&(r=t.substr(a),t=t.substr(0,a));var o=t.indexOf("?");return-1!==o&&(n=t.substr(o),t=t.substr(0,o)),{pathname:t,search:"?"===n?"":n,hash:"#"===r?"":r}}(e),o.state=t):(void 0===(o=(0,r.Z)({},e)).pathname&&(o.pathname=""),o.search?"?"!==o.search.charAt(0)&&(o.search="?"+o.search):o.search="",o.hash?"#"!==o.hash.charAt(0)&&(o.hash="#"+o.hash):o.hash="",void 0!==t&&void 0===o.state&&(o.state=t));try{o.pathname=decodeURI(o.pathname)}catch(s){throw s instanceof URIError?new URIError('Pathname "'+o.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):s}return n&&(o.key=n),a?o.pathname?"/"!==o.pathname.charAt(0)&&(o.pathname=i(o.pathname,a.pathname)):o.pathname=a.pathname:o.pathname||(o.pathname="/"),o}function m(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,r,a){if(null!=e){var o="function"==typeof e?e(t,n):e;"string"==typeof o?"function"==typeof r?r(o,a):a(!0):a(!1!==o)}else a(!0)},appendListener:function(e){var n=!0;function r(){n&&e.apply(void 0,arguments)}return t.push(r),function(){n=!1,t=t.filter((function(e){return e!==r}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),r=0;rt?n.splice(t,n.length-t,a):n.push(a),d({action:r,location:a,index:t,entries:n})}}))},replace:function(e,t){var r="REPLACE",a=p(e,t,h(),k.location);u.confirmTransitionTo(a,r,n,(function(e){e&&(k.entries[k.index]=a,d({action:r,location:a}))}))},go:y,goBack:function(){y(-1)},goForward:function(){y(1)},canGo:function(e){var t=k.index+e;return t>=0&&t{"use strict";var r=n(59864),a={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},o={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},i={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},s={};function c(e){return r.isMemo(e)?i:s[e.$$typeof]||a}s[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},s[r.Memo]=i;var l=Object.defineProperty,u=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,f=Object.getOwnPropertyDescriptor,p=Object.getPrototypeOf,m=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(m){var a=p(n);a&&a!==m&&e(t,a,r)}var i=u(n);d&&(i=i.concat(d(n)));for(var s=c(t),h=c(n),b=0;b{"use strict";e.exports=function(e,t,n,r,a,o,i,s){if(!e){var c;if(void 0===t)c=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var l=[n,r,a,o,i,s],u=0;(c=new Error(t.replace(/%s/g,(function(){return l[u++]})))).name="Invariant Violation"}throw c.framesToPop=1,c}}},5826:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},56748:(e,t,n)=>{"use strict";n.r(t)},32497:(e,t,n)=>{"use strict";n.r(t)},87406:(e,t,n)=>{"use strict";n.r(t)},52295:(e,t,n)=>{"use strict";n.r(t)},86199:(e,t,n)=>{"use strict";n.r(t)},79362:(e,t,n)=>{"use strict";n.r(t)},93524:(e,t,n)=>{"use strict";n.r(t)},74865:function(e,t,n){var r,a;r=function(){var e,t,n={version:"0.2.0"},r=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function a(e,t,n){return en?n:e}function o(e){return 100*(-1+e)}function i(e,t,n){var a;return(a="translate3d"===r.positionUsing?{transform:"translate3d("+o(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+o(e)+"%,0)"}:{"margin-left":o(e)+"%"}).transition="all "+t+"ms "+n,a}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=a(e,r.minimum,1),n.status=1===e?null:e;var o=n.render(!t),l=o.querySelector(r.barSelector),u=r.speed,d=r.easing;return o.offsetWidth,s((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),c(l,i(e,u,d)),1===e?(c(o,{transition:"none",opacity:1}),o.offsetWidth,setTimeout((function(){c(o,{transition:"all "+u+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),u)}),u)):setTimeout(t,u)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*a(Math.random()*t,.1,.95)),t=a(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var a,i=t.querySelector(r.barSelector),s=e?"-100":o(n.status||0),l=document.querySelector(r.parent);return c(i,{transition:"all 0 linear",transform:"translate3d("+s+"%,0,0)"}),r.showSpinner||(a=t.querySelector(r.spinnerSelector))&&p(a),l!=document.body&&u(l,"nprogress-custom-parent"),l.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&p(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var s=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),c=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function r(t){var n=document.body.style;if(t in n)return t;for(var r,a=e.length,o=t.charAt(0).toUpperCase()+t.slice(1);a--;)if((r=e[a]+o)in n)return r;return t}function a(e){return e=n(e),t[e]||(t[e]=r(e))}function o(e,t,n){t=a(t),e.style[t]=n}return function(e,t){var n,r,a=arguments;if(2==a.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&o(e,n,r);else o(e,a[1],a[2])}}();function l(e,t){return("string"==typeof e?e:f(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=f(e),r=n+t;l(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=f(e);l(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function f(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function p(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(a="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=a)},87410:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=function(){var e=/(?:^|\s)lang(?:uage)?-([\w-]+)(?=\s|$)/i,t=0,n={},r={util:{encode:function e(t){return t instanceof a?new a(t.type,e(t.content),t.alias):Array.isArray(t)?t.map(e):t.replace(/&/g,"&").replace(/=d.reach);E+=w.value.length,w=w.next){var x=w.value;if(t.length>e.length)return;if(!(x instanceof a)){var C,_=1;if(v){if(!(C=o(S,E,e,g))||C.index>=e.length)break;var I=C.index,T=C.index+C[0].length,P=E;for(P+=w.value.length;I>=P;)P+=(w=w.next).value.length;if(E=P-=w.value.length,w.value instanceof a)continue;for(var A=w;A!==t.tail&&(Pd.reach&&(d.reach=N);var M=w.prev;if(L&&(M=c(t,M,L),E+=L.length),l(t,M,_),w=c(t,M,new a(f,b?r.tokenize(R,b):R,y,R)),O&&c(t,w,O),_>1){var D={cause:f+","+m,reach:N};i(e,t,n,w.prev,E,D),d&&D.reach>d.reach&&(d.reach=D.reach)}}}}}}function s(){var e={value:null,prev:null,next:null},t={value:null,prev:e,next:null};e.next=t,this.head=e,this.tail=t,this.length=0}function c(e,t,n){var r=t.next,a={value:n,prev:t,next:r};return t.next=a,r.prev=a,e.length++,a}function l(e,t,n){for(var r=t.next,a=0;a"+o.content+""},r}(),a=r;r.default=r,a.languages.markup={comment:{pattern://,greedy:!0},prolog:{pattern:/<\?[\s\S]+?\?>/,greedy:!0},doctype:{pattern:/"'[\]]|"[^"]*"|'[^']*')+(?:\[(?:[^<"'\]]|"[^"]*"|'[^']*'|<(?!!--)|)*\]\s*)?>/i,greedy:!0,inside:{"internal-subset":{pattern:/(^[^\[]*\[)[\s\S]+(?=\]>$)/,lookbehind:!0,greedy:!0,inside:null},string:{pattern:/"[^"]*"|'[^']*'/,greedy:!0},punctuation:/^$|[[\]]/,"doctype-tag":/^DOCTYPE/i,name:/[^\s<>'"]+/}},cdata:{pattern://i,greedy:!0},tag:{pattern:/<\/?(?!\d)[^\s>\/=$<%]+(?:\s(?:\s*[^\s>\/=]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))|(?=[\s/>])))+)?\s*\/?>/,greedy:!0,inside:{tag:{pattern:/^<\/?[^\s>\/]+/,inside:{punctuation:/^<\/?/,namespace:/^[^\s>\/:]+:/}},"special-attr":[],"attr-value":{pattern:/=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+)/,inside:{punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}},punctuation:/\/?>/,"attr-name":{pattern:/[^\s>\/]+/,inside:{namespace:/^[^\s>\/:]+:/}}}},entity:[{pattern:/&[\da-z]{1,8};/i,alias:"named-entity"},/&#x?[\da-f]{1,8};/i]},a.languages.markup.tag.inside["attr-value"].inside.entity=a.languages.markup.entity,a.languages.markup.doctype.inside["internal-subset"].inside=a.languages.markup,a.hooks.add("wrap",(function(e){"entity"===e.type&&(e.attributes.title=e.content.replace(/&/,"&"))})),Object.defineProperty(a.languages.markup.tag,"addInlined",{value:function(e,t){var n={};n["language-"+t]={pattern:/(^$)/i,lookbehind:!0,inside:a.languages[t]},n.cdata=/^$/i;var r={"included-cdata":{pattern://i,inside:n}};r["language-"+t]={pattern:/[\s\S]+/,inside:a.languages[t]};var o={};o[e]={pattern:RegExp(/(<__[^>]*>)(?:))*\]\]>|(?!)/.source.replace(/__/g,(function(){return e})),"i"),lookbehind:!0,greedy:!0,inside:r},a.languages.insertBefore("markup","cdata",o)}}),Object.defineProperty(a.languages.markup.tag,"addAttribute",{value:function(e,t){a.languages.markup.tag.inside["special-attr"].push({pattern:RegExp(/(^|["'\s])/.source+"(?:"+e+")"+/\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))/.source,"i"),lookbehind:!0,inside:{"attr-name":/^[^\s=]+/,"attr-value":{pattern:/=[\s\S]+/,inside:{value:{pattern:/(^=\s*(["']|(?!["'])))\S[\s\S]*(?=\2$)/,lookbehind:!0,alias:[t,"language-"+t],inside:a.languages[t]},punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}}}})}}),a.languages.html=a.languages.markup,a.languages.mathml=a.languages.markup,a.languages.svg=a.languages.markup,a.languages.xml=a.languages.extend("markup",{}),a.languages.ssml=a.languages.xml,a.languages.atom=a.languages.xml,a.languages.rss=a.languages.xml,function(e){var t="\\b(?:BASH|BASHOPTS|BASH_ALIASES|BASH_ARGC|BASH_ARGV|BASH_CMDS|BASH_COMPLETION_COMPAT_DIR|BASH_LINENO|BASH_REMATCH|BASH_SOURCE|BASH_VERSINFO|BASH_VERSION|COLORTERM|COLUMNS|COMP_WORDBREAKS|DBUS_SESSION_BUS_ADDRESS|DEFAULTS_PATH|DESKTOP_SESSION|DIRSTACK|DISPLAY|EUID|GDMSESSION|GDM_LANG|GNOME_KEYRING_CONTROL|GNOME_KEYRING_PID|GPG_AGENT_INFO|GROUPS|HISTCONTROL|HISTFILE|HISTFILESIZE|HISTSIZE|HOME|HOSTNAME|HOSTTYPE|IFS|INSTANCE|JOB|LANG|LANGUAGE|LC_ADDRESS|LC_ALL|LC_IDENTIFICATION|LC_MEASUREMENT|LC_MONETARY|LC_NAME|LC_NUMERIC|LC_PAPER|LC_TELEPHONE|LC_TIME|LESSCLOSE|LESSOPEN|LINES|LOGNAME|LS_COLORS|MACHTYPE|MAILCHECK|MANDATORY_PATH|NO_AT_BRIDGE|OLDPWD|OPTERR|OPTIND|ORBIT_SOCKETDIR|OSTYPE|PAPERSIZE|PATH|PIPESTATUS|PPID|PS1|PS2|PS3|PS4|PWD|RANDOM|REPLY|SECONDS|SELINUX_INIT|SESSION|SESSIONTYPE|SESSION_MANAGER|SHELL|SHELLOPTS|SHLVL|SSH_AUTH_SOCK|TERM|UID|UPSTART_EVENTS|UPSTART_INSTANCE|UPSTART_JOB|UPSTART_SESSION|USER|WINDOWID|XAUTHORITY|XDG_CONFIG_DIRS|XDG_CURRENT_DESKTOP|XDG_DATA_DIRS|XDG_GREETER_DATA_DIR|XDG_MENU_PREFIX|XDG_RUNTIME_DIR|XDG_SEAT|XDG_SEAT_PATH|XDG_SESSION_DESKTOP|XDG_SESSION_ID|XDG_SESSION_PATH|XDG_SESSION_TYPE|XDG_VTNR|XMODIFIERS)\\b",n={pattern:/(^(["']?)\w+\2)[ \t]+\S.*/,lookbehind:!0,alias:"punctuation",inside:null},r={bash:n,environment:{pattern:RegExp("\\$"+t),alias:"constant"},variable:[{pattern:/\$?\(\([\s\S]+?\)\)/,greedy:!0,inside:{variable:[{pattern:/(^\$\(\([\s\S]+)\)\)/,lookbehind:!0},/^\$\(\(/],number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee]-?\d+)?/,operator:/--|\+\+|\*\*=?|<<=?|>>=?|&&|\|\||[=!+\-*/%<>^&|]=?|[?~:]/,punctuation:/\(\(?|\)\)?|,|;/}},{pattern:/\$\((?:\([^)]+\)|[^()])+\)|`[^`]+`/,greedy:!0,inside:{variable:/^\$\(|^`|\)$|`$/}},{pattern:/\$\{[^}]+\}/,greedy:!0,inside:{operator:/:[-=?+]?|[!\/]|##?|%%?|\^\^?|,,?/,punctuation:/[\[\]]/,environment:{pattern:RegExp("(\\{)"+t),lookbehind:!0,alias:"constant"}}},/\$(?:\w+|[#?*!@$])/],entity:/\\(?:[abceEfnrtv\\"]|O?[0-7]{1,3}|U[0-9a-fA-F]{8}|u[0-9a-fA-F]{4}|x[0-9a-fA-F]{1,2})/};e.languages.bash={shebang:{pattern:/^#!\s*\/.*/,alias:"important"},comment:{pattern:/(^|[^"{\\$])#.*/,lookbehind:!0},"function-name":[{pattern:/(\bfunction\s+)[\w-]+(?=(?:\s*\(?:\s*\))?\s*\{)/,lookbehind:!0,alias:"function"},{pattern:/\b[\w-]+(?=\s*\(\s*\)\s*\{)/,alias:"function"}],"for-or-select":{pattern:/(\b(?:for|select)\s+)\w+(?=\s+in\s)/,alias:"variable",lookbehind:!0},"assign-left":{pattern:/(^|[\s;|&]|[<>]\()\w+(?=\+?=)/,inside:{environment:{pattern:RegExp("(^|[\\s;|&]|[<>]\\()"+t),lookbehind:!0,alias:"constant"}},alias:"variable",lookbehind:!0},string:[{pattern:/((?:^|[^<])<<-?\s*)(\w+)\s[\s\S]*?(?:\r?\n|\r)\2/,lookbehind:!0,greedy:!0,inside:r},{pattern:/((?:^|[^<])<<-?\s*)(["'])(\w+)\2\s[\s\S]*?(?:\r?\n|\r)\3/,lookbehind:!0,greedy:!0,inside:{bash:n}},{pattern:/(^|[^\\](?:\\\\)*)"(?:\\[\s\S]|\$\([^)]+\)|\$(?!\()|`[^`]+`|[^"\\`$])*"/,lookbehind:!0,greedy:!0,inside:r},{pattern:/(^|[^$\\])'[^']*'/,lookbehind:!0,greedy:!0},{pattern:/\$'(?:[^'\\]|\\[\s\S])*'/,greedy:!0,inside:{entity:r.entity}}],environment:{pattern:RegExp("\\$?"+t),alias:"constant"},variable:r.variable,function:{pattern:/(^|[\s;|&]|[<>]\()(?:add|apropos|apt|apt-cache|apt-get|aptitude|aspell|automysqlbackup|awk|basename|bash|bc|bconsole|bg|bzip2|cal|cat|cfdisk|chgrp|chkconfig|chmod|chown|chroot|cksum|clear|cmp|column|comm|composer|cp|cron|crontab|csplit|curl|cut|date|dc|dd|ddrescue|debootstrap|df|diff|diff3|dig|dir|dircolors|dirname|dirs|dmesg|docker|docker-compose|du|egrep|eject|env|ethtool|expand|expect|expr|fdformat|fdisk|fg|fgrep|file|find|fmt|fold|format|free|fsck|ftp|fuser|gawk|git|gparted|grep|groupadd|groupdel|groupmod|groups|grub-mkconfig|gzip|halt|head|hg|history|host|hostname|htop|iconv|id|ifconfig|ifdown|ifup|import|install|ip|jobs|join|kill|killall|less|link|ln|locate|logname|logrotate|look|lpc|lpr|lprint|lprintd|lprintq|lprm|ls|lsof|lynx|make|man|mc|mdadm|mkconfig|mkdir|mke2fs|mkfifo|mkfs|mkisofs|mknod|mkswap|mmv|more|most|mount|mtools|mtr|mutt|mv|nano|nc|netstat|nice|nl|node|nohup|notify-send|npm|nslookup|op|open|parted|passwd|paste|pathchk|ping|pkill|pnpm|podman|podman-compose|popd|pr|printcap|printenv|ps|pushd|pv|quota|quotacheck|quotactl|ram|rar|rcp|reboot|remsync|rename|renice|rev|rm|rmdir|rpm|rsync|scp|screen|sdiff|sed|sendmail|seq|service|sftp|sh|shellcheck|shuf|shutdown|sleep|slocate|sort|split|ssh|stat|strace|su|sudo|sum|suspend|swapon|sync|tac|tail|tar|tee|time|timeout|top|touch|tr|traceroute|tsort|tty|umount|uname|unexpand|uniq|units|unrar|unshar|unzip|update-grub|uptime|useradd|userdel|usermod|users|uudecode|uuencode|v|vcpkg|vdir|vi|vim|virsh|vmstat|wait|watch|wc|wget|whereis|which|who|whoami|write|xargs|xdg-open|yarn|yes|zenity|zip|zsh|zypper)(?=$|[)\s;|&])/,lookbehind:!0},keyword:{pattern:/(^|[\s;|&]|[<>]\()(?:case|do|done|elif|else|esac|fi|for|function|if|in|select|then|until|while)(?=$|[)\s;|&])/,lookbehind:!0},builtin:{pattern:/(^|[\s;|&]|[<>]\()(?:\.|:|alias|bind|break|builtin|caller|cd|command|continue|declare|echo|enable|eval|exec|exit|export|getopts|hash|help|let|local|logout|mapfile|printf|pwd|read|readarray|readonly|return|set|shift|shopt|source|test|times|trap|type|typeset|ulimit|umask|unalias|unset)(?=$|[)\s;|&])/,lookbehind:!0,alias:"class-name"},boolean:{pattern:/(^|[\s;|&]|[<>]\()(?:false|true)(?=$|[)\s;|&])/,lookbehind:!0},"file-descriptor":{pattern:/\B&\d\b/,alias:"important"},operator:{pattern:/\d?<>|>\||\+=|=[=~]?|!=?|<<[<-]?|[&\d]?>>|\d[<>]&?|[<>][&=]?|&[>&]?|\|[&|]?/,inside:{"file-descriptor":{pattern:/^\d/,alias:"important"}}},punctuation:/\$?\(\(?|\)\)?|\.\.|[{}[\];\\]/,number:{pattern:/(^|\s)(?:[1-9]\d*|0)(?:[.,]\d+)?\b/,lookbehind:!0}},n.inside=e.languages.bash;for(var a=["comment","function-name","for-or-select","assign-left","string","environment","function","keyword","builtin","boolean","file-descriptor","operator","punctuation","number"],o=r.variable[1].inside,i=0;i]=?|[!=]=?=?|--?|\+\+?|&&?|\|\|?|[?*/~^%]/,punctuation:/[{}[\];(),.:]/},a.languages.c=a.languages.extend("clike",{comment:{pattern:/\/\/(?:[^\r\n\\]|\\(?:\r\n?|\n|(?![\r\n])))*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},"class-name":{pattern:/(\b(?:enum|struct)\s+(?:__attribute__\s*\(\([\s\S]*?\)\)\s*)?)\w+|\b[a-z]\w*_t\b/,lookbehind:!0},keyword:/\b(?:_Alignas|_Alignof|_Atomic|_Bool|_Complex|_Generic|_Imaginary|_Noreturn|_Static_assert|_Thread_local|__attribute__|asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|inline|int|long|register|return|short|signed|sizeof|static|struct|switch|typedef|typeof|union|unsigned|void|volatile|while)\b/,function:/\b[a-z_]\w*(?=\s*\()/i,number:/(?:\b0x(?:[\da-f]+(?:\.[\da-f]*)?|\.[\da-f]+)(?:p[+-]?\d+)?|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:e[+-]?\d+)?)[ful]{0,4}/i,operator:/>>=?|<<=?|->|([-+&|:])\1|[?:~]|[-+*/%&|^!=<>]=?/}),a.languages.insertBefore("c","string",{char:{pattern:/'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n]){0,32}'/,greedy:!0}}),a.languages.insertBefore("c","string",{macro:{pattern:/(^[\t ]*)#\s*[a-z](?:[^\r\n\\/]|\/(?!\*)|\/\*(?:[^*]|\*(?!\/))*\*\/|\\(?:\r\n|[\s\S]))*/im,lookbehind:!0,greedy:!0,alias:"property",inside:{string:[{pattern:/^(#\s*include\s*)<[^>]+>/,lookbehind:!0},a.languages.c.string],char:a.languages.c.char,comment:a.languages.c.comment,"macro-name":[{pattern:/(^#\s*define\s+)\w+\b(?!\()/i,lookbehind:!0},{pattern:/(^#\s*define\s+)\w+\b(?=\()/i,lookbehind:!0,alias:"function"}],directive:{pattern:/^(#\s*)[a-z]+/,lookbehind:!0,alias:"keyword"},"directive-hash":/^#/,punctuation:/##|\\(?=[\r\n])/,expression:{pattern:/\S[\s\S]*/,inside:a.languages.c}}}}),a.languages.insertBefore("c","function",{constant:/\b(?:EOF|NULL|SEEK_CUR|SEEK_END|SEEK_SET|__DATE__|__FILE__|__LINE__|__TIMESTAMP__|__TIME__|__func__|stderr|stdin|stdout)\b/}),delete a.languages.c.boolean,function(e){var t=/\b(?:alignas|alignof|asm|auto|bool|break|case|catch|char|char16_t|char32_t|char8_t|class|co_await|co_return|co_yield|compl|concept|const|const_cast|consteval|constexpr|constinit|continue|decltype|default|delete|do|double|dynamic_cast|else|enum|explicit|export|extern|final|float|for|friend|goto|if|import|inline|int|int16_t|int32_t|int64_t|int8_t|long|module|mutable|namespace|new|noexcept|nullptr|operator|override|private|protected|public|register|reinterpret_cast|requires|return|short|signed|sizeof|static|static_assert|static_cast|struct|switch|template|this|thread_local|throw|try|typedef|typeid|typename|uint16_t|uint32_t|uint64_t|uint8_t|union|unsigned|using|virtual|void|volatile|wchar_t|while)\b/,n=/\b(?!)\w+(?:\s*\.\s*\w+)*\b/.source.replace(//g,(function(){return t.source}));e.languages.cpp=e.languages.extend("c",{"class-name":[{pattern:RegExp(/(\b(?:class|concept|enum|struct|typename)\s+)(?!)\w+/.source.replace(//g,(function(){return t.source}))),lookbehind:!0},/\b[A-Z]\w*(?=\s*::\s*\w+\s*\()/,/\b[A-Z_]\w*(?=\s*::\s*~\w+\s*\()/i,/\b\w+(?=\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>\s*::\s*\w+\s*\()/],keyword:t,number:{pattern:/(?:\b0b[01']+|\b0x(?:[\da-f']+(?:\.[\da-f']*)?|\.[\da-f']+)(?:p[+-]?[\d']+)?|(?:\b[\d']+(?:\.[\d']*)?|\B\.[\d']+)(?:e[+-]?[\d']+)?)[ful]{0,4}/i,greedy:!0},operator:/>>=?|<<=?|->|--|\+\+|&&|\|\||[?:~]|<=>|[-+*/%&|^!=<>]=?|\b(?:and|and_eq|bitand|bitor|not|not_eq|or|or_eq|xor|xor_eq)\b/,boolean:/\b(?:false|true)\b/}),e.languages.insertBefore("cpp","string",{module:{pattern:RegExp(/(\b(?:import|module)\s+)/.source+"(?:"+/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|<[^<>\r\n]*>/.source+"|"+/(?:\s*:\s*)?|:\s*/.source.replace(//g,(function(){return n}))+")"),lookbehind:!0,greedy:!0,inside:{string:/^[<"][\s\S]+/,operator:/:/,punctuation:/\./}},"raw-string":{pattern:/R"([^()\\ ]{0,16})\([\s\S]*?\)\1"/,alias:"string",greedy:!0}}),e.languages.insertBefore("cpp","keyword",{"generic-function":{pattern:/\b(?!operator\b)[a-z_]\w*\s*<(?:[^<>]|<[^<>]*>)*>(?=\s*\()/i,inside:{function:/^\w+/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:e.languages.cpp}}}}),e.languages.insertBefore("cpp","operator",{"double-colon":{pattern:/::/,alias:"punctuation"}}),e.languages.insertBefore("cpp","class-name",{"base-clause":{pattern:/(\b(?:class|struct)\s+\w+\s*:\s*)[^;{}"'\s]+(?:\s+[^;{}"'\s]+)*(?=\s*[;{])/,lookbehind:!0,greedy:!0,inside:e.languages.extend("cpp",{})}}),e.languages.insertBefore("inside","double-colon",{"class-name":/\b[a-z_]\w*\b(?!\s*::)/i},e.languages.cpp["base-clause"])}(a),function(e){var t=/(?:"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n])*')/;e.languages.css={comment:/\/\*[\s\S]*?\*\//,atrule:{pattern:/@[\w-](?:[^;{\s]|\s+(?![\s{]))*(?:;|(?=\s*\{))/,inside:{rule:/^@[\w-]+/,"selector-function-argument":{pattern:/(\bselector\s*\(\s*(?![\s)]))(?:[^()\s]|\s+(?![\s)])|\((?:[^()]|\([^()]*\))*\))+(?=\s*\))/,lookbehind:!0,alias:"selector"},keyword:{pattern:/(^|[^\w-])(?:and|not|only|or)(?![\w-])/,lookbehind:!0}}},url:{pattern:RegExp("\\burl\\((?:"+t.source+"|"+/(?:[^\\\r\n()"']|\\[\s\S])*/.source+")\\)","i"),greedy:!0,inside:{function:/^url/i,punctuation:/^\(|\)$/,string:{pattern:RegExp("^"+t.source+"$"),alias:"url"}}},selector:{pattern:RegExp("(^|[{}\\s])[^{}\\s](?:[^{};\"'\\s]|\\s+(?![\\s{])|"+t.source+")*(?=\\s*\\{)"),lookbehind:!0},string:{pattern:t,greedy:!0},property:{pattern:/(^|[^-\w\xA0-\uFFFF])(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*(?=\s*:)/i,lookbehind:!0},important:/!important\b/i,function:{pattern:/(^|[^-a-z0-9])[-a-z0-9]+(?=\()/i,lookbehind:!0},punctuation:/[(){};:,]/},e.languages.css.atrule.inside.rest=e.languages.css;var n=e.languages.markup;n&&(n.tag.addInlined("style","css"),n.tag.addAttribute("style","css"))}(a),function(e){var t,n=/("|')(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/;e.languages.css.selector={pattern:e.languages.css.selector.pattern,lookbehind:!0,inside:t={"pseudo-element":/:(?:after|before|first-letter|first-line|selection)|::[-\w]+/,"pseudo-class":/:[-\w]+/,class:/\.[-\w]+/,id:/#[-\w]+/,attribute:{pattern:RegExp("\\[(?:[^[\\]\"']|"+n.source+")*\\]"),greedy:!0,inside:{punctuation:/^\[|\]$/,"case-sensitivity":{pattern:/(\s)[si]$/i,lookbehind:!0,alias:"keyword"},namespace:{pattern:/^(\s*)(?:(?!\s)[-*\w\xA0-\uFFFF])*\|(?!=)/,lookbehind:!0,inside:{punctuation:/\|$/}},"attr-name":{pattern:/^(\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+/,lookbehind:!0},"attr-value":[n,{pattern:/(=\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+(?=\s*$)/,lookbehind:!0}],operator:/[|~*^$]?=/}},"n-th":[{pattern:/(\(\s*)[+-]?\d*[\dn](?:\s*[+-]\s*\d+)?(?=\s*\))/,lookbehind:!0,inside:{number:/[\dn]+/,operator:/[+-]/}},{pattern:/(\(\s*)(?:even|odd)(?=\s*\))/i,lookbehind:!0}],combinator:/>|\+|~|\|\|/,punctuation:/[(),]/}},e.languages.css.atrule.inside["selector-function-argument"].inside=t,e.languages.insertBefore("css","property",{variable:{pattern:/(^|[^-\w\xA0-\uFFFF])--(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*/i,lookbehind:!0}});var r={pattern:/(\b\d+)(?:%|[a-z]+(?![\w-]))/,lookbehind:!0},a={pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0};e.languages.insertBefore("css","function",{operator:{pattern:/(\s)[+\-*\/](?=\s)/,lookbehind:!0},hexcode:{pattern:/\B#[\da-f]{3,8}\b/i,alias:"color"},color:[{pattern:/(^|[^\w-])(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)(?![\w-])/i,lookbehind:!0},{pattern:/\b(?:hsl|rgb)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:hsl|rgb)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:r,number:a,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:r,number:a})}(a),a.languages.javascript=a.languages.extend("clike",{"class-name":[a.languages.clike["class-name"],{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$A-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\.(?:constructor|prototype))/,lookbehind:!0}],keyword:[{pattern:/((?:^|\})\s*)catch\b/,lookbehind:!0},{pattern:/(^|[^.]|\.\.\.\s*)\b(?:as|assert(?=\s*\{)|async(?=\s*(?:function\b|\(|[$\w\xA0-\uFFFF]|$))|await|break|case|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally(?=\s*(?:\{|$))|for|from(?=\s*(?:['"]|$))|function|(?:get|set)(?=\s*(?:[#\[$\w\xA0-\uFFFF]|$))|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)\b/,lookbehind:!0}],function:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*(?:\.\s*(?:apply|bind|call)\s*)?\()/,number:{pattern:RegExp(/(^|[^\w$])/.source+"(?:"+/NaN|Infinity/.source+"|"+/0[bB][01]+(?:_[01]+)*n?/.source+"|"+/0[oO][0-7]+(?:_[0-7]+)*n?/.source+"|"+/0[xX][\dA-Fa-f]+(?:_[\dA-Fa-f]+)*n?/.source+"|"+/\d+(?:_\d+)*n/.source+"|"+/(?:\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\.\d+(?:_\d+)*)(?:[Ee][+-]?\d+(?:_\d+)*)?/.source+")"+/(?![\w$])/.source),lookbehind:!0},operator:/--|\+\+|\*\*=?|=>|&&=?|\|\|=?|[!=]==|<<=?|>>>?=?|[-+*/%&|^!=<>]=?|\.{3}|\?\?=?|\?\.?|[~:]/}),a.languages.javascript["class-name"][0].pattern=/(\b(?:class|extends|implements|instanceof|interface|new)\s+)[\w.\\]+/,a.languages.insertBefore("javascript","keyword",{regex:{pattern:/((?:^|[^$\w\xA0-\uFFFF."'\])\s]|\b(?:return|yield))\s*)\/(?:\[(?:[^\]\\\r\n]|\\.)*\]|\\.|[^/\\\[\r\n])+\/[dgimyus]{0,7}(?=(?:\s|\/\*(?:[^*]|\*(?!\/))*\*\/)*(?:$|[\r\n,.;:})\]]|\/\/))/,lookbehind:!0,greedy:!0,inside:{"regex-source":{pattern:/^(\/)[\s\S]+(?=\/[a-z]*$)/,lookbehind:!0,alias:"language-regex",inside:a.languages.regex},"regex-delimiter":/^\/|\/$/,"regex-flags":/^[a-z]+$/}},"function-variable":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*[=:]\s*(?:async\s*)?(?:\bfunction\b|(?:\((?:[^()]|\([^()]*\))*\)|(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)\s*=>))/,alias:"function"},parameter:[{pattern:/(function(?:\s+(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)?\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\))/,lookbehind:!0,inside:a.languages.javascript},{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$a-z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*=>)/i,lookbehind:!0,inside:a.languages.javascript},{pattern:/(\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*=>)/,lookbehind:!0,inside:a.languages.javascript},{pattern:/((?:\b|\s|^)(?!(?:as|async|await|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally|for|from|function|get|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)(?![$\w\xA0-\uFFFF]))(?:(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*)\(\s*|\]\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*\{)/,lookbehind:!0,inside:a.languages.javascript}],constant:/\b[A-Z](?:[A-Z_]|\dx?)*\b/}),a.languages.insertBefore("javascript","string",{hashbang:{pattern:/^#!.*/,greedy:!0,alias:"comment"},"template-string":{pattern:/`(?:\\[\s\S]|\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}|(?!\$\{)[^\\`])*`/,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},interpolation:{pattern:/((?:^|[^\\])(?:\\{2})*)\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}/,lookbehind:!0,inside:{"interpolation-punctuation":{pattern:/^\$\{|\}$/,alias:"punctuation"},rest:a.languages.javascript}},string:/[\s\S]+/}},"string-property":{pattern:/((?:^|[,{])[ \t]*)(["'])(?:\\(?:\r\n|[\s\S])|(?!\2)[^\\\r\n])*\2(?=\s*:)/m,lookbehind:!0,greedy:!0,alias:"property"}}),a.languages.insertBefore("javascript","operator",{"literal-property":{pattern:/((?:^|[,{])[ \t]*)(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*:)/m,lookbehind:!0,alias:"property"}}),a.languages.markup&&(a.languages.markup.tag.addInlined("script","javascript"),a.languages.markup.tag.addAttribute(/on(?:abort|blur|change|click|composition(?:end|start|update)|dblclick|error|focus(?:in|out)?|key(?:down|up)|load|mouse(?:down|enter|leave|move|out|over|up)|reset|resize|scroll|select|slotchange|submit|unload|wheel)/.source,"javascript")),a.languages.js=a.languages.javascript,function(e){var t=/#(?!\{).+/,n={pattern:/#\{[^}]+\}/,alias:"variable"};e.languages.coffeescript=e.languages.extend("javascript",{comment:t,string:[{pattern:/'(?:\\[\s\S]|[^\\'])*'/,greedy:!0},{pattern:/"(?:\\[\s\S]|[^\\"])*"/,greedy:!0,inside:{interpolation:n}}],keyword:/\b(?:and|break|by|catch|class|continue|debugger|delete|do|each|else|extend|extends|false|finally|for|if|in|instanceof|is|isnt|let|loop|namespace|new|no|not|null|of|off|on|or|own|return|super|switch|then|this|throw|true|try|typeof|undefined|unless|until|when|while|window|with|yes|yield)\b/,"class-member":{pattern:/@(?!\d)\w+/,alias:"variable"}}),e.languages.insertBefore("coffeescript","comment",{"multiline-comment":{pattern:/###[\s\S]+?###/,alias:"comment"},"block-regex":{pattern:/\/{3}[\s\S]*?\/{3}/,alias:"regex",inside:{comment:t,interpolation:n}}}),e.languages.insertBefore("coffeescript","string",{"inline-javascript":{pattern:/`(?:\\[\s\S]|[^\\`])*`/,inside:{delimiter:{pattern:/^`|`$/,alias:"punctuation"},script:{pattern:/[\s\S]+/,alias:"language-javascript",inside:e.languages.javascript}}},"multiline-string":[{pattern:/'''[\s\S]*?'''/,greedy:!0,alias:"string"},{pattern:/"""[\s\S]*?"""/,greedy:!0,alias:"string",inside:{interpolation:n}}]}),e.languages.insertBefore("coffeescript","keyword",{property:/(?!\d)\w+(?=\s*:(?!:))/}),delete e.languages.coffeescript["template-string"],e.languages.coffee=e.languages.coffeescript}(a),function(e){var t=/[*&][^\s[\]{},]+/,n=/!(?:<[\w\-%#;/?:@&=+$,.!~*'()[\]]+>|(?:[a-zA-Z\d-]*!)?[\w\-%#;/?:@&=+$.~*'()]+)?/,r="(?:"+n.source+"(?:[ \t]+"+t.source+")?|"+t.source+"(?:[ \t]+"+n.source+")?)",a=/(?:[^\s\x00-\x08\x0e-\x1f!"#%&'*,\-:>?@[\]`{|}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]|[?:-])(?:[ \t]*(?:(?![#:])|:))*/.source.replace(//g,(function(){return/[^\s\x00-\x08\x0e-\x1f,[\]{}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]/.source})),o=/"(?:[^"\\\r\n]|\\.)*"|'(?:[^'\\\r\n]|\\.)*'/.source;function i(e,t){t=(t||"").replace(/m/g,"")+"m";var n=/([:\-,[{]\s*(?:\s<>[ \t]+)?)(?:<>)(?=[ \t]*(?:$|,|\]|\}|(?:[\r\n]\s*)?#))/.source.replace(/<>/g,(function(){return r})).replace(/<>/g,(function(){return e}));return RegExp(n,t)}e.languages.yaml={scalar:{pattern:RegExp(/([\-:]\s*(?:\s<>[ \t]+)?[|>])[ \t]*(?:((?:\r?\n|\r)[ \t]+)\S[^\r\n]*(?:\2[^\r\n]+)*)/.source.replace(/<>/g,(function(){return r}))),lookbehind:!0,alias:"string"},comment:/#.*/,key:{pattern:RegExp(/((?:^|[:\-,[{\r\n?])[ \t]*(?:<>[ \t]+)?)<>(?=\s*:\s)/.source.replace(/<>/g,(function(){return r})).replace(/<>/g,(function(){return"(?:"+a+"|"+o+")"}))),lookbehind:!0,greedy:!0,alias:"atrule"},directive:{pattern:/(^[ \t]*)%.+/m,lookbehind:!0,alias:"important"},datetime:{pattern:i(/\d{4}-\d\d?-\d\d?(?:[tT]|[ \t]+)\d\d?:\d{2}:\d{2}(?:\.\d*)?(?:[ \t]*(?:Z|[-+]\d\d?(?::\d{2})?))?|\d{4}-\d{2}-\d{2}|\d\d?:\d{2}(?::\d{2}(?:\.\d*)?)?/.source),lookbehind:!0,alias:"number"},boolean:{pattern:i(/false|true/.source,"i"),lookbehind:!0,alias:"important"},null:{pattern:i(/null|~/.source,"i"),lookbehind:!0,alias:"important"},string:{pattern:i(o),lookbehind:!0,greedy:!0},number:{pattern:i(/[+-]?(?:0x[\da-f]+|0o[0-7]+|(?:\d+(?:\.\d*)?|\.\d+)(?:e[+-]?\d+)?|\.inf|\.nan)/.source,"i"),lookbehind:!0},tag:n,important:t,punctuation:/---|[:[\]{}\-,|>?]|\.\.\./},e.languages.yml=e.languages.yaml}(a),function(e){var t=/(?:\\.|[^\\\n\r]|(?:\n|\r\n?)(?![\r\n]))/.source;function n(e){return e=e.replace(//g,(function(){return t})),RegExp(/((?:^|[^\\])(?:\\{2})*)/.source+"(?:"+e+")")}var r=/(?:\\.|``(?:[^`\r\n]|`(?!`))+``|`[^`\r\n]+`|[^\\|\r\n`])+/.source,a=/\|?__(?:\|__)+\|?(?:(?:\n|\r\n?)|(?![\s\S]))/.source.replace(/__/g,(function(){return r})),o=/\|?[ \t]*:?-{3,}:?[ \t]*(?:\|[ \t]*:?-{3,}:?[ \t]*)+\|?(?:\n|\r\n?)/.source;e.languages.markdown=e.languages.extend("markup",{}),e.languages.insertBefore("markdown","prolog",{"front-matter-block":{pattern:/(^(?:\s*[\r\n])?)---(?!.)[\s\S]*?[\r\n]---(?!.)/,lookbehind:!0,greedy:!0,inside:{punctuation:/^---|---$/,"front-matter":{pattern:/\S+(?:\s+\S+)*/,alias:["yaml","language-yaml"],inside:e.languages.yaml}}},blockquote:{pattern:/^>(?:[\t ]*>)*/m,alias:"punctuation"},table:{pattern:RegExp("^"+a+o+"(?:"+a+")*","m"),inside:{"table-data-rows":{pattern:RegExp("^("+a+o+")(?:"+a+")*$"),lookbehind:!0,inside:{"table-data":{pattern:RegExp(r),inside:e.languages.markdown},punctuation:/\|/}},"table-line":{pattern:RegExp("^("+a+")"+o+"$"),lookbehind:!0,inside:{punctuation:/\||:?-{3,}:?/}},"table-header-row":{pattern:RegExp("^"+a+"$"),inside:{"table-header":{pattern:RegExp(r),alias:"important",inside:e.languages.markdown},punctuation:/\|/}}}},code:[{pattern:/((?:^|\n)[ \t]*\n|(?:^|\r\n?)[ \t]*\r\n?)(?: {4}|\t).+(?:(?:\n|\r\n?)(?: {4}|\t).+)*/,lookbehind:!0,alias:"keyword"},{pattern:/^```[\s\S]*?^```$/m,greedy:!0,inside:{"code-block":{pattern:/^(```.*(?:\n|\r\n?))[\s\S]+?(?=(?:\n|\r\n?)^```$)/m,lookbehind:!0},"code-language":{pattern:/^(```).+/,lookbehind:!0},punctuation:/```/}}],title:[{pattern:/\S.*(?:\n|\r\n?)(?:==+|--+)(?=[ \t]*$)/m,alias:"important",inside:{punctuation:/==+$|--+$/}},{pattern:/(^\s*)#.+/m,lookbehind:!0,alias:"important",inside:{punctuation:/^#+|#+$/}}],hr:{pattern:/(^\s*)([*-])(?:[\t ]*\2){2,}(?=\s*$)/m,lookbehind:!0,alias:"punctuation"},list:{pattern:/(^\s*)(?:[*+-]|\d+\.)(?=[\t ].)/m,lookbehind:!0,alias:"punctuation"},"url-reference":{pattern:/!?\[[^\]]+\]:[\t ]+(?:\S+|<(?:\\.|[^>\\])+>)(?:[\t ]+(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\)))?/,inside:{variable:{pattern:/^(!?\[)[^\]]+/,lookbehind:!0},string:/(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\))$/,punctuation:/^[\[\]!:]|[<>]/},alias:"url"},bold:{pattern:n(/\b__(?:(?!_)|_(?:(?!_))+_)+__\b|\*\*(?:(?!\*)|\*(?:(?!\*))+\*)+\*\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^..)[\s\S]+(?=..$)/,lookbehind:!0,inside:{}},punctuation:/\*\*|__/}},italic:{pattern:n(/\b_(?:(?!_)|__(?:(?!_))+__)+_\b|\*(?:(?!\*)|\*\*(?:(?!\*))+\*\*)+\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^.)[\s\S]+(?=.$)/,lookbehind:!0,inside:{}},punctuation:/[*_]/}},strike:{pattern:n(/(~~?)(?:(?!~))+\2/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^~~?)[\s\S]+(?=\1$)/,lookbehind:!0,inside:{}},punctuation:/~~?/}},"code-snippet":{pattern:/(^|[^\\`])(?:``[^`\r\n]+(?:`[^`\r\n]+)*``(?!`)|`[^`\r\n]+`(?!`))/,lookbehind:!0,greedy:!0,alias:["code","keyword"]},url:{pattern:n(/!?\[(?:(?!\]))+\](?:\([^\s)]+(?:[\t ]+"(?:\\.|[^"\\])*")?\)|[ \t]?\[(?:(?!\]))+\])/.source),lookbehind:!0,greedy:!0,inside:{operator:/^!/,content:{pattern:/(^\[)[^\]]+(?=\])/,lookbehind:!0,inside:{}},variable:{pattern:/(^\][ \t]?\[)[^\]]+(?=\]$)/,lookbehind:!0},url:{pattern:/(^\]\()[^\s)]+/,lookbehind:!0},string:{pattern:/(^[ \t]+)"(?:\\.|[^"\\])*"(?=\)$)/,lookbehind:!0}}}}),["url","bold","italic","strike"].forEach((function(t){["url","bold","italic","strike","code-snippet"].forEach((function(n){t!==n&&(e.languages.markdown[t].inside.content.inside[n]=e.languages.markdown[n])}))})),e.hooks.add("after-tokenize",(function(e){"markdown"!==e.language&&"md"!==e.language||function e(t){if(t&&"string"!=typeof t)for(var n=0,r=t.length;n",quot:'"'},c=String.fromCodePoint||String.fromCharCode;e.languages.md=e.languages.markdown}(a),a.languages.graphql={comment:/#.*/,description:{pattern:/(?:"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*")(?=\s*[a-z_])/i,greedy:!0,alias:"string",inside:{"language-markdown":{pattern:/(^"(?:"")?)(?!\1)[\s\S]+(?=\1$)/,lookbehind:!0,inside:a.languages.markdown}}},string:{pattern:/"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*"/,greedy:!0},number:/(?:\B-|\b)\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,boolean:/\b(?:false|true)\b/,variable:/\$[a-z_]\w*/i,directive:{pattern:/@[a-z_]\w*/i,alias:"function"},"attr-name":{pattern:/\b[a-z_]\w*(?=\s*(?:\((?:[^()"]|"(?:\\.|[^\\"\r\n])*")*\))?:)/i,greedy:!0},"atom-input":{pattern:/\b[A-Z]\w*Input\b/,alias:"class-name"},scalar:/\b(?:Boolean|Float|ID|Int|String)\b/,constant:/\b[A-Z][A-Z_\d]*\b/,"class-name":{pattern:/(\b(?:enum|implements|interface|on|scalar|type|union)\s+|&\s*|:\s*|\[)[A-Z_]\w*/,lookbehind:!0},fragment:{pattern:/(\bfragment\s+|\.{3}\s*(?!on\b))[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},"definition-mutation":{pattern:/(\bmutation\s+)[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},"definition-query":{pattern:/(\bquery\s+)[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},keyword:/\b(?:directive|enum|extend|fragment|implements|input|interface|mutation|on|query|repeatable|scalar|schema|subscription|type|union)\b/,operator:/[!=|&]|\.{3}/,"property-query":/\w+(?=\s*\()/,object:/\w+(?=\s*\{)/,punctuation:/[!(){}\[\]:=,]/,property:/\w+/},a.hooks.add("after-tokenize",(function(e){if("graphql"===e.language)for(var t=e.tokens.filter((function(e){return"string"!=typeof e&&"comment"!==e.type&&"scalar"!==e.type})),n=0;n0)){var s=f(/^\{$/,/^\}$/);if(-1===s)continue;for(var c=n;c=0&&p(l,"variable-input")}}}}function u(e){return t[n+e]}function d(e,t){t=t||0;for(var n=0;n?|<|>)?|>[>=]?|\b(?:AND|BETWEEN|DIV|ILIKE|IN|IS|LIKE|NOT|OR|REGEXP|RLIKE|SOUNDS LIKE|XOR)\b/i,punctuation:/[;[\]()`,.]/},function(e){var t=e.languages.javascript["template-string"],n=t.pattern.source,r=t.inside.interpolation,a=r.inside["interpolation-punctuation"],o=r.pattern.source;function i(t,r){if(e.languages[t])return{pattern:RegExp("((?:"+r+")\\s*)"+n),lookbehind:!0,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},"embedded-code":{pattern:/[\s\S]+/,alias:t}}}}function s(e,t){return"___"+t.toUpperCase()+"_"+e+"___"}function c(t,n,r){var a={code:t,grammar:n,language:r};return e.hooks.run("before-tokenize",a),a.tokens=e.tokenize(a.code,a.grammar),e.hooks.run("after-tokenize",a),a.tokens}function l(t){var n={};n["interpolation-punctuation"]=a;var o=e.tokenize(t,n);if(3===o.length){var i=[1,1];i.push.apply(i,c(o[1],e.languages.javascript,"javascript")),o.splice.apply(o,i)}return new e.Token("interpolation",o,r.alias,t)}function u(t,n,r){var a=e.tokenize(t,{interpolation:{pattern:RegExp(o),lookbehind:!0}}),i=0,u={},d=c(a.map((function(e){if("string"==typeof e)return e;for(var n,a=e.content;-1!==t.indexOf(n=s(i++,r)););return u[n]=a,n})).join(""),n,r),f=Object.keys(u);return i=0,function e(t){for(var n=0;n=f.length)return;var r=t[n];if("string"==typeof r||"string"==typeof r.content){var a=f[i],o="string"==typeof r?r:r.content,s=o.indexOf(a);if(-1!==s){++i;var c=o.substring(0,s),d=l(u[a]),p=o.substring(s+a.length),m=[];if(c&&m.push(c),m.push(d),p){var h=[p];e(h),m.push.apply(m,h)}"string"==typeof r?(t.splice.apply(t,[n,1].concat(m)),n+=m.length-1):r.content=m}}else{var b=r.content;Array.isArray(b)?e(b):e([b])}}}(d),new e.Token(r,d,"language-"+r,t)}e.languages.javascript["template-string"]=[i("css",/\b(?:styled(?:\([^)]*\))?(?:\s*\.\s*\w+(?:\([^)]*\))*)*|css(?:\s*\.\s*(?:global|resolve))?|createGlobalStyle|keyframes)/.source),i("html",/\bhtml|\.\s*(?:inner|outer)HTML\s*\+?=/.source),i("svg",/\bsvg/.source),i("markdown",/\b(?:markdown|md)/.source),i("graphql",/\b(?:gql|graphql(?:\s*\.\s*experimental)?)/.source),i("sql",/\bsql/.source),t].filter(Boolean);var d={javascript:!0,js:!0,typescript:!0,ts:!0,jsx:!0,tsx:!0};function f(e){return"string"==typeof e?e:Array.isArray(e)?e.map(f).join(""):f(e.content)}e.hooks.add("after-tokenize",(function(t){t.language in d&&function t(n){for(var r=0,a=n.length;r]|<(?:[^<>]|<[^<>]*>)*>)*>)?/,lookbehind:!0,greedy:!0,inside:null},builtin:/\b(?:Array|Function|Promise|any|boolean|console|never|number|string|symbol|unknown)\b/}),e.languages.typescript.keyword.push(/\b(?:abstract|declare|is|keyof|readonly|require)\b/,/\b(?:asserts|infer|interface|module|namespace|type)\b(?=\s*(?:[{_$a-zA-Z\xA0-\uFFFF]|$))/,/\btype\b(?=\s*(?:[\{*]|$))/),delete e.languages.typescript.parameter,delete e.languages.typescript["literal-property"];var t=e.languages.extend("typescript",{});delete t["class-name"],e.languages.typescript["class-name"].inside=t,e.languages.insertBefore("typescript","function",{decorator:{pattern:/@[$\w\xA0-\uFFFF]+/,inside:{at:{pattern:/^@/,alias:"operator"},function:/^[\s\S]+/}},"generic-function":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>(?=\s*\()/,greedy:!0,inside:{function:/^#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:t}}}}),e.languages.ts=e.languages.typescript}(a),function(e){function t(e,t){return RegExp(e.replace(//g,(function(){return/(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/.source})),t)}e.languages.insertBefore("javascript","function-variable",{"method-variable":{pattern:RegExp("(\\.\\s*)"+e.languages.javascript["function-variable"].pattern.source),lookbehind:!0,alias:["function-variable","method","function","property-access"]}}),e.languages.insertBefore("javascript","function",{method:{pattern:RegExp("(\\.\\s*)"+e.languages.javascript.function.source),lookbehind:!0,alias:["function","property-access"]}}),e.languages.insertBefore("javascript","constant",{"known-class-name":[{pattern:/\b(?:(?:Float(?:32|64)|(?:Int|Uint)(?:8|16|32)|Uint8Clamped)?Array|ArrayBuffer|BigInt|Boolean|DataView|Date|Error|Function|Intl|JSON|(?:Weak)?(?:Map|Set)|Math|Number|Object|Promise|Proxy|Reflect|RegExp|String|Symbol|WebAssembly)\b/,alias:"class-name"},{pattern:/\b(?:[A-Z]\w*)Error\b/,alias:"class-name"}]}),e.languages.insertBefore("javascript","keyword",{imports:{pattern:t(/(\bimport\b\s*)(?:(?:\s*,\s*(?:\*\s*as\s+|\{[^{}]*\}))?|\*\s*as\s+|\{[^{}]*\})(?=\s*\bfrom\b)/.source),lookbehind:!0,inside:e.languages.javascript},exports:{pattern:t(/(\bexport\b\s*)(?:\*(?:\s*as\s+)?(?=\s*\bfrom\b)|\{[^{}]*\})/.source),lookbehind:!0,inside:e.languages.javascript}}),e.languages.javascript.keyword.unshift({pattern:/\b(?:as|default|export|from|import)\b/,alias:"module"},{pattern:/\b(?:await|break|catch|continue|do|else|finally|for|if|return|switch|throw|try|while|yield)\b/,alias:"control-flow"},{pattern:/\bnull\b/,alias:["null","nil"]},{pattern:/\bundefined\b/,alias:"nil"}),e.languages.insertBefore("javascript","operator",{spread:{pattern:/\.{3}/,alias:"operator"},arrow:{pattern:/=>/,alias:"operator"}}),e.languages.insertBefore("javascript","punctuation",{"property-access":{pattern:t(/(\.\s*)#?/.source),lookbehind:!0},"maybe-class-name":{pattern:/(^|[^$\w\xA0-\uFFFF])[A-Z][$\w\xA0-\uFFFF]+/,lookbehind:!0},dom:{pattern:/\b(?:document|(?:local|session)Storage|location|navigator|performance|window)\b/,alias:"variable"},console:{pattern:/\bconsole(?=\s*\.)/,alias:"class-name"}});for(var n=["function","function-variable","method","method-variable","property-access"],r=0;r*\.{3}(?:[^{}]|)*\})/.source;function o(e,t){return e=e.replace(//g,(function(){return n})).replace(//g,(function(){return r})).replace(//g,(function(){return a})),RegExp(e,t)}a=o(a).source,e.languages.jsx=e.languages.extend("markup",t),e.languages.jsx.tag.pattern=o(/<\/?(?:[\w.:-]+(?:+(?:[\w.:$-]+(?:=(?:"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*'|[^\s{'"/>=]+|))?|))**\/?)?>/.source),e.languages.jsx.tag.inside.tag.pattern=/^<\/?[^\s>\/]*/,e.languages.jsx.tag.inside["attr-value"].pattern=/=(?!\{)(?:"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*'|[^\s'">]+)/,e.languages.jsx.tag.inside.tag.inside["class-name"]=/^[A-Z]\w*(?:\.[A-Z]\w*)*$/,e.languages.jsx.tag.inside.comment=t.comment,e.languages.insertBefore("inside","attr-name",{spread:{pattern:o(//.source),inside:e.languages.jsx}},e.languages.jsx.tag),e.languages.insertBefore("inside","special-attr",{script:{pattern:o(/=/.source),alias:"language-javascript",inside:{"script-punctuation":{pattern:/^=(?=\{)/,alias:"punctuation"},rest:e.languages.jsx}}},e.languages.jsx.tag);var i=function(e){return e?"string"==typeof e?e:"string"==typeof e.content?e.content:e.content.map(i).join(""):""},s=function(t){for(var n=[],r=0;r0&&n[n.length-1].tagName===i(a.content[0].content[1])&&n.pop():"/>"===a.content[a.content.length-1].content||n.push({tagName:i(a.content[0].content[1]),openedBraces:0}):n.length>0&&"punctuation"===a.type&&"{"===a.content?n[n.length-1].openedBraces++:n.length>0&&n[n.length-1].openedBraces>0&&"punctuation"===a.type&&"}"===a.content?n[n.length-1].openedBraces--:o=!0),(o||"string"==typeof a)&&n.length>0&&0===n[n.length-1].openedBraces){var c=i(a);r0&&("string"==typeof t[r-1]||"plain-text"===t[r-1].type)&&(c=i(t[r-1])+c,t.splice(r-1,1),r--),t[r]=new e.Token("plain-text",c,null,c)}a.content&&"string"!=typeof a.content&&s(a.content)}};e.hooks.add("after-tokenize",(function(e){"jsx"!==e.language&&"tsx"!==e.language||s(e.tokens)}))}(a),function(e){e.languages.diff={coord:[/^(?:\*{3}|-{3}|\+{3}).*$/m,/^@@.*@@$/m,/^\d.*$/m]};var t={"deleted-sign":"-","deleted-arrow":"<","inserted-sign":"+","inserted-arrow":">",unchanged:" ",diff:"!"};Object.keys(t).forEach((function(n){var r=t[n],a=[];/^\w+$/.test(n)||a.push(/\w+/.exec(n)[0]),"diff"===n&&a.push("bold"),e.languages.diff[n]={pattern:RegExp("^(?:["+r+"].*(?:\r\n?|\n|(?![\\s\\S])))+","m"),alias:a,inside:{line:{pattern:/(.)(?=[\s\S]).*(?:\r\n?|\n)?/,lookbehind:!0},prefix:{pattern:/[\s\S]/,alias:/\w+/.exec(n)[0]}}}})),Object.defineProperty(e.languages.diff,"PREFIXES",{value:t})}(a),a.languages.git={comment:/^#.*/m,deleted:/^[-\u2013].*/m,inserted:/^\+.*/m,string:/("|')(?:\\.|(?!\1)[^\\\r\n])*\1/,command:{pattern:/^.*\$ git .*$/m,inside:{parameter:/\s--?\w+/}},coord:/^@@.*@@$/m,"commit-sha1":/^commit \w{40}$/m},a.languages.go=a.languages.extend("clike",{string:{pattern:/(^|[^\\])"(?:\\.|[^"\\\r\n])*"|`[^`]*`/,lookbehind:!0,greedy:!0},keyword:/\b(?:break|case|chan|const|continue|default|defer|else|fallthrough|for|func|go(?:to)?|if|import|interface|map|package|range|return|select|struct|switch|type|var)\b/,boolean:/\b(?:_|false|iota|nil|true)\b/,number:[/\b0(?:b[01_]+|o[0-7_]+)i?\b/i,/\b0x(?:[a-f\d_]+(?:\.[a-f\d_]*)?|\.[a-f\d_]+)(?:p[+-]?\d+(?:_\d+)*)?i?(?!\w)/i,/(?:\b\d[\d_]*(?:\.[\d_]*)?|\B\.\d[\d_]*)(?:e[+-]?[\d_]+)?i?(?!\w)/i],operator:/[*\/%^!=]=?|\+[=+]?|-[=-]?|\|[=|]?|&(?:=|&|\^=?)?|>(?:>=?|=)?|<(?:<=?|=|-)?|:=|\.\.\./,builtin:/\b(?:append|bool|byte|cap|close|complex|complex(?:64|128)|copy|delete|error|float(?:32|64)|u?int(?:8|16|32|64)?|imag|len|make|new|panic|print(?:ln)?|real|recover|rune|string|uintptr)\b/}),a.languages.insertBefore("go","string",{char:{pattern:/'(?:\\.|[^'\\\r\n]){0,10}'/,greedy:!0}}),delete a.languages.go["class-name"],function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,a,o){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(a,(function(e){if("function"==typeof o&&!o(e))return e;for(var a,s=i.length;-1!==n.code.indexOf(a=t(r,s));)++s;return i[s]=e,a})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var a=0,o=Object.keys(n.tokenStack);!function i(s){for(var c=0;c=o.length);c++){var l=s[c];if("string"==typeof l||l.content&&"string"==typeof l.content){var u=o[a],d=n.tokenStack[u],f="string"==typeof l?l:l.content,p=t(r,u),m=f.indexOf(p);if(m>-1){++a;var h=f.substring(0,m),b=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),g=f.substring(m+p.length),v=[];h&&v.push.apply(v,i([h])),v.push(b),g&&v.push.apply(v,i([g])),"string"==typeof l?s.splice.apply(s,[c,1].concat(v)):l.content=v}}else l.content&&i(l.content)}return s}(n.tokens)}}}})}(a),function(e){e.languages.handlebars={comment:/\{\{![\s\S]*?\}\}/,delimiter:{pattern:/^\{\{\{?|\}\}\}?$/,alias:"punctuation"},string:/(["'])(?:\\.|(?!\1)[^\\\r\n])*\1/,number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee][+-]?\d+)?/,boolean:/\b(?:false|true)\b/,block:{pattern:/^(\s*(?:~\s*)?)[#\/]\S+?(?=\s*(?:~\s*)?$|\s)/,lookbehind:!0,alias:"keyword"},brackets:{pattern:/\[[^\]]+\]/,inside:{punctuation:/\[|\]/,variable:/[\s\S]+/}},punctuation:/[!"#%&':()*+,.\/;<=>@\[\\\]^`{|}~]/,variable:/[^!"#%&'()*+,\/;<=>@\[\\\]^`{|}~\s]+/},e.hooks.add("before-tokenize",(function(t){e.languages["markup-templating"].buildPlaceholders(t,"handlebars",/\{\{\{[\s\S]+?\}\}\}|\{\{[\s\S]+?\}\}/g)})),e.hooks.add("after-tokenize",(function(t){e.languages["markup-templating"].tokenizePlaceholders(t,"handlebars")})),e.languages.hbs=e.languages.handlebars}(a),a.languages.json={property:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?=\s*:)/,lookbehind:!0,greedy:!0},string:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?!\s*:)/,lookbehind:!0,greedy:!0},comment:{pattern:/\/\/.*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},number:/-?\b\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,punctuation:/[{}[\],]/,operator:/:/,boolean:/\b(?:false|true)\b/,null:{pattern:/\bnull\b/,alias:"keyword"}},a.languages.webmanifest=a.languages.json,a.languages.less=a.languages.extend("css",{comment:[/\/\*[\s\S]*?\*\//,{pattern:/(^|[^\\])\/\/.*/,lookbehind:!0}],atrule:{pattern:/@[\w-](?:\((?:[^(){}]|\([^(){}]*\))*\)|[^(){};\s]|\s+(?!\s))*?(?=\s*\{)/,inside:{punctuation:/[:()]/}},selector:{pattern:/(?:@\{[\w-]+\}|[^{};\s@])(?:@\{[\w-]+\}|\((?:[^(){}]|\([^(){}]*\))*\)|[^(){};@\s]|\s+(?!\s))*?(?=\s*\{)/,inside:{variable:/@+[\w-]+/}},property:/(?:@\{[\w-]+\}|[\w-])+(?:\+_?)?(?=\s*:)/,operator:/[+\-*\/]/}),a.languages.insertBefore("less","property",{variable:[{pattern:/@[\w-]+\s*:/,inside:{punctuation:/:/}},/@@?[\w-]+/],"mixin-usage":{pattern:/([{;]\s*)[.#](?!\d)[\w-].*?(?=[(;])/,lookbehind:!0,alias:"function"}}),a.languages.makefile={comment:{pattern:/(^|[^\\])#(?:\\(?:\r\n|[\s\S])|[^\\\r\n])*/,lookbehind:!0},string:{pattern:/(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0},"builtin-target":{pattern:/\.[A-Z][^:#=\s]+(?=\s*:(?!=))/,alias:"builtin"},target:{pattern:/^(?:[^:=\s]|[ \t]+(?![\s:]))+(?=\s*:(?!=))/m,alias:"symbol",inside:{variable:/\$+(?:(?!\$)[^(){}:#=\s]+|(?=[({]))/}},variable:/\$+(?:(?!\$)[^(){}:#=\s]+|\([@*%<^+?][DF]\)|(?=[({]))/,keyword:/-include\b|\b(?:define|else|endef|endif|export|ifn?def|ifn?eq|include|override|private|sinclude|undefine|unexport|vpath)\b/,function:{pattern:/(\()(?:abspath|addsuffix|and|basename|call|dir|error|eval|file|filter(?:-out)?|findstring|firstword|flavor|foreach|guile|if|info|join|lastword|load|notdir|or|origin|patsubst|realpath|shell|sort|strip|subst|suffix|value|warning|wildcard|word(?:list|s)?)(?=[ \t])/,lookbehind:!0},operator:/(?:::|[?:+!])?=|[|@]/,punctuation:/[:;(){}]/},a.languages.objectivec=a.languages.extend("c",{string:{pattern:/@?"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},keyword:/\b(?:asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|in|inline|int|long|register|return|self|short|signed|sizeof|static|struct|super|switch|typedef|typeof|union|unsigned|void|volatile|while)\b|(?:@interface|@end|@implementation|@protocol|@class|@public|@protected|@private|@property|@try|@catch|@finally|@throw|@synthesize|@dynamic|@selector)\b/,operator:/-[->]?|\+\+?|!=?|<>?=?|==?|&&?|\|\|?|[~^%?*\/@]/}),delete a.languages.objectivec["class-name"],a.languages.objc=a.languages.objectivec,a.languages.ocaml={comment:{pattern:/\(\*[\s\S]*?\*\)/,greedy:!0},char:{pattern:/'(?:[^\\\r\n']|\\(?:.|[ox]?[0-9a-f]{1,3}))'/i,greedy:!0},string:[{pattern:/"(?:\\(?:[\s\S]|\r\n)|[^\\\r\n"])*"/,greedy:!0},{pattern:/\{([a-z_]*)\|[\s\S]*?\|\1\}/,greedy:!0}],number:[/\b(?:0b[01][01_]*|0o[0-7][0-7_]*)\b/i,/\b0x[a-f0-9][a-f0-9_]*(?:\.[a-f0-9_]*)?(?:p[+-]?\d[\d_]*)?(?!\w)/i,/\b\d[\d_]*(?:\.[\d_]*)?(?:e[+-]?\d[\d_]*)?(?!\w)/i],directive:{pattern:/\B#\w+/,alias:"property"},label:{pattern:/\B~\w+/,alias:"property"},"type-variable":{pattern:/\B'\w+/,alias:"function"},variant:{pattern:/`\w+/,alias:"symbol"},keyword:/\b(?:as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|match|method|module|mutable|new|nonrec|object|of|open|private|rec|sig|struct|then|to|try|type|val|value|virtual|when|where|while|with)\b/,boolean:/\b(?:false|true)\b/,"operator-like-punctuation":{pattern:/\[[<>|]|[>|]\]|\{<|>\}/,alias:"punctuation"},operator:/\.[.~]|:[=>]|[=<>@^|&+\-*\/$%!?~][!$%&*+\-.\/:<=>?@^|~]*|\b(?:and|asr|land|lor|lsl|lsr|lxor|mod|or)\b/,punctuation:/;;|::|[(){}\[\].,:;#]|\b_\b/},a.languages.python={comment:{pattern:/(^|[^\\])#.*/,lookbehind:!0,greedy:!0},"string-interpolation":{pattern:/(?:f|fr|rf)(?:("""|''')[\s\S]*?\1|("|')(?:\\.|(?!\2)[^\\\r\n])*\2)/i,greedy:!0,inside:{interpolation:{pattern:/((?:^|[^{])(?:\{\{)*)\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}])+\})+\})+\}/,lookbehind:!0,inside:{"format-spec":{pattern:/(:)[^:(){}]+(?=\}$)/,lookbehind:!0},"conversion-option":{pattern:/![sra](?=[:}]$)/,alias:"punctuation"},rest:null}},string:/[\s\S]+/}},"triple-quoted-string":{pattern:/(?:[rub]|br|rb)?("""|''')[\s\S]*?\1/i,greedy:!0,alias:"string"},string:{pattern:/(?:[rub]|br|rb)?("|')(?:\\.|(?!\1)[^\\\r\n])*\1/i,greedy:!0},function:{pattern:/((?:^|\s)def[ \t]+)[a-zA-Z_]\w*(?=\s*\()/g,lookbehind:!0},"class-name":{pattern:/(\bclass\s+)\w+/i,lookbehind:!0},decorator:{pattern:/(^[\t ]*)@\w+(?:\.\w+)*/m,lookbehind:!0,alias:["annotation","punctuation"],inside:{punctuation:/\./}},keyword:/\b(?:_(?=\s*:)|and|as|assert|async|await|break|case|class|continue|def|del|elif|else|except|exec|finally|for|from|global|if|import|in|is|lambda|match|nonlocal|not|or|pass|print|raise|return|try|while|with|yield)\b/,builtin:/\b(?:__import__|abs|all|any|apply|ascii|basestring|bin|bool|buffer|bytearray|bytes|callable|chr|classmethod|cmp|coerce|compile|complex|delattr|dict|dir|divmod|enumerate|eval|execfile|file|filter|float|format|frozenset|getattr|globals|hasattr|hash|help|hex|id|input|int|intern|isinstance|issubclass|iter|len|list|locals|long|map|max|memoryview|min|next|object|oct|open|ord|pow|property|range|raw_input|reduce|reload|repr|reversed|round|set|setattr|slice|sorted|staticmethod|str|sum|super|tuple|type|unichr|unicode|vars|xrange|zip)\b/,boolean:/\b(?:False|None|True)\b/,number:/\b0(?:b(?:_?[01])+|o(?:_?[0-7])+|x(?:_?[a-f0-9])+)\b|(?:\b\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\B\.\d+(?:_\d+)*)(?:e[+-]?\d+(?:_\d+)*)?j?(?!\w)/i,operator:/[-+%=]=?|!=|:=|\*\*?=?|\/\/?=?|<[<=>]?|>[=>]?|[&|^~]/,punctuation:/[{}[\];(),.:]/},a.languages.python["string-interpolation"].inside.interpolation.inside.rest=a.languages.python,a.languages.py=a.languages.python,a.languages.reason=a.languages.extend("clike",{string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^\\\r\n"])*"/,greedy:!0},"class-name":/\b[A-Z]\w*/,keyword:/\b(?:and|as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|method|module|mutable|new|nonrec|object|of|open|or|private|rec|sig|struct|switch|then|to|try|type|val|virtual|when|while|with)\b/,operator:/\.{3}|:[:=]|\|>|->|=(?:==?|>)?|<=?|>=?|[|^?'#!~`]|[+\-*\/]\.?|\b(?:asr|land|lor|lsl|lsr|lxor|mod)\b/}),a.languages.insertBefore("reason","class-name",{char:{pattern:/'(?:\\x[\da-f]{2}|\\o[0-3][0-7][0-7]|\\\d{3}|\\.|[^'\\\r\n])'/,greedy:!0},constructor:/\b[A-Z]\w*\b(?!\s*\.)/,label:{pattern:/\b[a-z]\w*(?=::)/,alias:"symbol"}}),delete a.languages.reason.function,function(e){e.languages.sass=e.languages.extend("css",{comment:{pattern:/^([ \t]*)\/[\/*].*(?:(?:\r?\n|\r)\1[ \t].+)*/m,lookbehind:!0,greedy:!0}}),e.languages.insertBefore("sass","atrule",{"atrule-line":{pattern:/^(?:[ \t]*)[@+=].+/m,greedy:!0,inside:{atrule:/(?:@[\w-]+|[+=])/}}}),delete e.languages.sass.atrule;var t=/\$[-\w]+|#\{\$[-\w]+\}/,n=[/[+*\/%]|[=!]=|<=?|>=?|\b(?:and|not|or)\b/,{pattern:/(\s)-(?=\s)/,lookbehind:!0}];e.languages.insertBefore("sass","property",{"variable-line":{pattern:/^[ \t]*\$.+/m,greedy:!0,inside:{punctuation:/:/,variable:t,operator:n}},"property-line":{pattern:/^[ \t]*(?:[^:\s]+ *:.*|:[^:\s].*)/m,greedy:!0,inside:{property:[/[^:\s]+(?=\s*:)/,{pattern:/(:)[^:\s]+/,lookbehind:!0}],punctuation:/:/,variable:t,operator:n,important:e.languages.sass.important}}}),delete e.languages.sass.property,delete e.languages.sass.important,e.languages.insertBefore("sass","punctuation",{selector:{pattern:/^([ \t]*)\S(?:,[^,\r\n]+|[^,\r\n]*)(?:,[^,\r\n]+)*(?:,(?:\r?\n|\r)\1[ \t]+\S(?:,[^,\r\n]+|[^,\r\n]*)(?:,[^,\r\n]+)*)*/m,lookbehind:!0,greedy:!0}})}(a),a.languages.scss=a.languages.extend("css",{comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0},atrule:{pattern:/@[\w-](?:\([^()]+\)|[^()\s]|\s+(?!\s))*?(?=\s+[{;])/,inside:{rule:/@[\w-]+/}},url:/(?:[-a-z]+-)?url(?=\()/i,selector:{pattern:/(?=\S)[^@;{}()]?(?:[^@;{}()\s]|\s+(?!\s)|#\{\$[-\w]+\})+(?=\s*\{(?:\}|\s|[^}][^:{}]*[:{][^}]))/,inside:{parent:{pattern:/&/,alias:"important"},placeholder:/%[-\w]+/,variable:/\$[-\w]+|#\{\$[-\w]+\}/}},property:{pattern:/(?:[-\w]|\$[-\w]|#\{\$[-\w]+\})+(?=\s*:)/,inside:{variable:/\$[-\w]+|#\{\$[-\w]+\}/}}}),a.languages.insertBefore("scss","atrule",{keyword:[/@(?:content|debug|each|else(?: if)?|extend|for|forward|function|if|import|include|mixin|return|use|warn|while)\b/i,{pattern:/( )(?:from|through)(?= )/,lookbehind:!0}]}),a.languages.insertBefore("scss","important",{variable:/\$[-\w]+|#\{\$[-\w]+\}/}),a.languages.insertBefore("scss","function",{"module-modifier":{pattern:/\b(?:as|hide|show|with)\b/i,alias:"keyword"},placeholder:{pattern:/%[-\w]+/,alias:"selector"},statement:{pattern:/\B!(?:default|optional)\b/i,alias:"keyword"},boolean:/\b(?:false|true)\b/,null:{pattern:/\bnull\b/,alias:"keyword"},operator:{pattern:/(\s)(?:[-+*\/%]|[=!]=|<=?|>=?|and|not|or)(?=\s)/,lookbehind:!0}}),a.languages.scss.atrule.inside.rest=a.languages.scss,function(e){var t={pattern:/(\b\d+)(?:%|[a-z]+)/,lookbehind:!0},n={pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0},r={comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0},url:{pattern:/\burl\((["']?).*?\1\)/i,greedy:!0},string:{pattern:/("|')(?:(?!\1)[^\\\r\n]|\\(?:\r\n|[\s\S]))*\1/,greedy:!0},interpolation:null,func:null,important:/\B!(?:important|optional)\b/i,keyword:{pattern:/(^|\s+)(?:(?:else|for|if|return|unless)(?=\s|$)|@[\w-]+)/,lookbehind:!0},hexcode:/#[\da-f]{3,6}/i,color:[/\b(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)\b/i,{pattern:/\b(?:hsl|rgb)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:hsl|rgb)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:t,number:n,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:t,boolean:/\b(?:false|true)\b/,operator:[/~|[+!\/%<>?=]=?|[-:]=|\*[*=]?|\.{2,3}|&&|\|\||\B-\B|\b(?:and|in|is(?: a| defined| not|nt)?|not|or)\b/],number:n,punctuation:/[{}()\[\];:,]/};r.interpolation={pattern:/\{[^\r\n}:]+\}/,alias:"variable",inside:{delimiter:{pattern:/^\{|\}$/,alias:"punctuation"},rest:r}},r.func={pattern:/[\w-]+\([^)]*\).*/,inside:{function:/^[^(]+/,rest:r}},e.languages.stylus={"atrule-declaration":{pattern:/(^[ \t]*)@.+/m,lookbehind:!0,inside:{atrule:/^@[\w-]+/,rest:r}},"variable-declaration":{pattern:/(^[ \t]*)[\w$-]+\s*.?=[ \t]*(?:\{[^{}]*\}|\S.*|$)/m,lookbehind:!0,inside:{variable:/^\S+/,rest:r}},statement:{pattern:/(^[ \t]*)(?:else|for|if|return|unless)[ \t].+/m,lookbehind:!0,inside:{keyword:/^\S+/,rest:r}},"property-declaration":{pattern:/((?:^|\{)([ \t]*))(?:[\w-]|\{[^}\r\n]+\})+(?:\s*:\s*|[ \t]+)(?!\s)[^{\r\n]*(?:;|[^{\r\n,]$(?!(?:\r?\n|\r)(?:\{|\2[ \t])))/m,lookbehind:!0,inside:{property:{pattern:/^[^\s:]+/,inside:{interpolation:r.interpolation}},rest:r}},selector:{pattern:/(^[ \t]*)(?:(?=\S)(?:[^{}\r\n:()]|::?[\w-]+(?:\([^)\r\n]*\)|(?![\w-]))|\{[^}\r\n]+\})+)(?:(?:\r?\n|\r)(?:\1(?:(?=\S)(?:[^{}\r\n:()]|::?[\w-]+(?:\([^)\r\n]*\)|(?![\w-]))|\{[^}\r\n]+\})+)))*(?:,$|\{|(?=(?:\r?\n|\r)(?:\{|\1[ \t])))/m,lookbehind:!0,inside:{interpolation:r.interpolation,comment:r.comment,punctuation:/[{},]/}},func:r.func,string:r.string,comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0,greedy:!0},interpolation:r.interpolation,punctuation:/[{}()\[\];:.]/}}(a),function(e){var t=e.util.clone(e.languages.typescript);e.languages.tsx=e.languages.extend("jsx",t),delete e.languages.tsx.parameter,delete e.languages.tsx["literal-property"];var n=e.languages.tsx.tag;n.pattern=RegExp(/(^|[^\w$]|(?=<\/))/.source+"(?:"+n.pattern.source+")",n.pattern.flags),n.lookbehind=!0}(a),a.languages.wasm={comment:[/\(;[\s\S]*?;\)/,{pattern:/;;.*/,greedy:!0}],string:{pattern:/"(?:\\[\s\S]|[^"\\])*"/,greedy:!0},keyword:[{pattern:/\b(?:align|offset)=/,inside:{operator:/=/}},{pattern:/\b(?:(?:f32|f64|i32|i64)(?:\.(?:abs|add|and|ceil|clz|const|convert_[su]\/i(?:32|64)|copysign|ctz|demote\/f64|div(?:_[su])?|eqz?|extend_[su]\/i32|floor|ge(?:_[su])?|gt(?:_[su])?|le(?:_[su])?|load(?:(?:8|16|32)_[su])?|lt(?:_[su])?|max|min|mul|neg?|nearest|or|popcnt|promote\/f32|reinterpret\/[fi](?:32|64)|rem_[su]|rot[lr]|shl|shr_[su]|sqrt|store(?:8|16|32)?|sub|trunc(?:_[su]\/f(?:32|64))?|wrap\/i64|xor))?|memory\.(?:grow|size))\b/,inside:{punctuation:/\./}},/\b(?:anyfunc|block|br(?:_if|_table)?|call(?:_indirect)?|data|drop|elem|else|end|export|func|get_(?:global|local)|global|if|import|local|loop|memory|module|mut|nop|offset|param|result|return|select|set_(?:global|local)|start|table|tee_local|then|type|unreachable)\b/],variable:/\$[\w!#$%&'*+\-./:<=>?@\\^`|~]+/,number:/[+-]?\b(?:\d(?:_?\d)*(?:\.\d(?:_?\d)*)?(?:[eE][+-]?\d(?:_?\d)*)?|0x[\da-fA-F](?:_?[\da-fA-F])*(?:\.[\da-fA-F](?:_?[\da-fA-D])*)?(?:[pP][+-]?\d(?:_?\d)*)?)\b|\binf\b|\bnan(?::0x[\da-fA-F](?:_?[\da-fA-D])*)?\b/,punctuation:/[()]/};const o=a},79016:()=>{!function(e){function t(e,t){return e.replace(/<<(\d+)>>/g,(function(e,n){return"(?:"+t[+n]+")"}))}function n(e,n,r){return RegExp(t(e,n),r||"")}function r(e,t){for(var n=0;n>/g,(function(){return"(?:"+e+")"}));return e.replace(/<>/g,"[^\\s\\S]")}var a="bool byte char decimal double dynamic float int long object sbyte short string uint ulong ushort var void",o="class enum interface record struct",i="add alias and ascending async await by descending from(?=\\s*(?:\\w|$)) get global group into init(?=\\s*;) join let nameof not notnull on or orderby partial remove select set unmanaged value when where with(?=\\s*{)",s="abstract as base break case catch checked const continue default delegate do else event explicit extern finally fixed for foreach goto if implicit in internal is lock namespace new null operator out override params private protected public readonly ref return sealed sizeof stackalloc static switch this throw try typeof unchecked unsafe using virtual volatile while yield";function c(e){return"\\b(?:"+e.trim().replace(/ /g,"|")+")\\b"}var l=c(o),u=RegExp(c(a+" "+o+" "+i+" "+s)),d=c(o+" "+i+" "+s),f=c(a+" "+o+" "+s),p=r(/<(?:[^<>;=+\-*/%&|^]|<>)*>/.source,2),m=r(/\((?:[^()]|<>)*\)/.source,2),h=/@?\b[A-Za-z_]\w*\b/.source,b=t(/<<0>>(?:\s*<<1>>)?/.source,[h,p]),g=t(/(?!<<0>>)<<1>>(?:\s*\.\s*<<1>>)*/.source,[d,b]),v=/\[\s*(?:,\s*)*\]/.source,y=t(/<<0>>(?:\s*(?:\?\s*)?<<1>>)*(?:\s*\?)?/.source,[g,v]),k=t(/[^,()<>[\];=+\-*/%&|^]|<<0>>|<<1>>|<<2>>/.source,[p,m,v]),S=t(/\(<<0>>+(?:,<<0>>+)+\)/.source,[k]),w=t(/(?:<<0>>|<<1>>)(?:\s*(?:\?\s*)?<<2>>)*(?:\s*\?)?/.source,[S,g,v]),E={keyword:u,punctuation:/[<>()?,.:[\]]/},x=/'(?:[^\r\n'\\]|\\.|\\[Uux][\da-fA-F]{1,8})'/.source,C=/"(?:\\.|[^\\"\r\n])*"/.source,_=/@"(?:""|\\[\s\S]|[^\\"])*"(?!")/.source;e.languages.csharp=e.languages.extend("clike",{string:[{pattern:n(/(^|[^$\\])<<0>>/.source,[_]),lookbehind:!0,greedy:!0},{pattern:n(/(^|[^@$\\])<<0>>/.source,[C]),lookbehind:!0,greedy:!0}],"class-name":[{pattern:n(/(\busing\s+static\s+)<<0>>(?=\s*;)/.source,[g]),lookbehind:!0,inside:E},{pattern:n(/(\busing\s+<<0>>\s*=\s*)<<1>>(?=\s*;)/.source,[h,w]),lookbehind:!0,inside:E},{pattern:n(/(\busing\s+)<<0>>(?=\s*=)/.source,[h]),lookbehind:!0},{pattern:n(/(\b<<0>>\s+)<<1>>/.source,[l,b]),lookbehind:!0,inside:E},{pattern:n(/(\bcatch\s*\(\s*)<<0>>/.source,[g]),lookbehind:!0,inside:E},{pattern:n(/(\bwhere\s+)<<0>>/.source,[h]),lookbehind:!0},{pattern:n(/(\b(?:is(?:\s+not)?|as)\s+)<<0>>/.source,[y]),lookbehind:!0,inside:E},{pattern:n(/\b<<0>>(?=\s+(?!<<1>>|with\s*\{)<<2>>(?:\s*[=,;:{)\]]|\s+(?:in|when)\b))/.source,[w,f,h]),inside:E}],keyword:u,number:/(?:\b0(?:x[\da-f_]*[\da-f]|b[01_]*[01])|(?:\B\.\d+(?:_+\d+)*|\b\d+(?:_+\d+)*(?:\.\d+(?:_+\d+)*)?)(?:e[-+]?\d+(?:_+\d+)*)?)(?:[dflmu]|lu|ul)?\b/i,operator:/>>=?|<<=?|[-=]>|([-+&|])\1|~|\?\?=?|[-+*/%&|^!=<>]=?/,punctuation:/\?\.?|::|[{}[\];(),.:]/}),e.languages.insertBefore("csharp","number",{range:{pattern:/\.\./,alias:"operator"}}),e.languages.insertBefore("csharp","punctuation",{"named-parameter":{pattern:n(/([(,]\s*)<<0>>(?=\s*:)/.source,[h]),lookbehind:!0,alias:"punctuation"}}),e.languages.insertBefore("csharp","class-name",{namespace:{pattern:n(/(\b(?:namespace|using)\s+)<<0>>(?:\s*\.\s*<<0>>)*(?=\s*[;{])/.source,[h]),lookbehind:!0,inside:{punctuation:/\./}},"type-expression":{pattern:n(/(\b(?:default|sizeof|typeof)\s*\(\s*(?!\s))(?:[^()\s]|\s(?!\s)|<<0>>)*(?=\s*\))/.source,[m]),lookbehind:!0,alias:"class-name",inside:E},"return-type":{pattern:n(/<<0>>(?=\s+(?:<<1>>\s*(?:=>|[({]|\.\s*this\s*\[)|this\s*\[))/.source,[w,g]),inside:E,alias:"class-name"},"constructor-invocation":{pattern:n(/(\bnew\s+)<<0>>(?=\s*[[({])/.source,[w]),lookbehind:!0,inside:E,alias:"class-name"},"generic-method":{pattern:n(/<<0>>\s*<<1>>(?=\s*\()/.source,[h,p]),inside:{function:n(/^<<0>>/.source,[h]),generic:{pattern:RegExp(p),alias:"class-name",inside:E}}},"type-list":{pattern:n(/\b((?:<<0>>\s+<<1>>|record\s+<<1>>\s*<<5>>|where\s+<<2>>)\s*:\s*)(?:<<3>>|<<4>>|<<1>>\s*<<5>>|<<6>>)(?:\s*,\s*(?:<<3>>|<<4>>|<<6>>))*(?=\s*(?:where|[{;]|=>|$))/.source,[l,b,h,w,u.source,m,/\bnew\s*\(\s*\)/.source]),lookbehind:!0,inside:{"record-arguments":{pattern:n(/(^(?!new\s*\()<<0>>\s*)<<1>>/.source,[b,m]),lookbehind:!0,greedy:!0,inside:e.languages.csharp},keyword:u,"class-name":{pattern:RegExp(w),greedy:!0,inside:E},punctuation:/[,()]/}},preprocessor:{pattern:/(^[\t ]*)#.*/m,lookbehind:!0,alias:"property",inside:{directive:{pattern:/(#)\b(?:define|elif|else|endif|endregion|error|if|line|nullable|pragma|region|undef|warning)\b/,lookbehind:!0,alias:"keyword"}}}});var I=C+"|"+x,T=t(/\/(?![*/])|\/\/[^\r\n]*[\r\n]|\/\*(?:[^*]|\*(?!\/))*\*\/|<<0>>/.source,[I]),P=r(t(/[^"'/()]|<<0>>|\(<>*\)/.source,[T]),2),A=/\b(?:assembly|event|field|method|module|param|property|return|type)\b/.source,R=t(/<<0>>(?:\s*\(<<1>>*\))?/.source,[g,P]);e.languages.insertBefore("csharp","class-name",{attribute:{pattern:n(/((?:^|[^\s\w>)?])\s*\[\s*)(?:<<0>>\s*:\s*)?<<1>>(?:\s*,\s*<<1>>)*(?=\s*\])/.source,[A,R]),lookbehind:!0,greedy:!0,inside:{target:{pattern:n(/^<<0>>(?=\s*:)/.source,[A]),alias:"keyword"},"attribute-arguments":{pattern:n(/\(<<0>>*\)/.source,[P]),inside:e.languages.csharp},"class-name":{pattern:RegExp(g),inside:{punctuation:/\./}},punctuation:/[:,]/}}});var L=/:[^}\r\n]+/.source,O=r(t(/[^"'/()]|<<0>>|\(<>*\)/.source,[T]),2),N=t(/\{(?!\{)(?:(?![}:])<<0>>)*<<1>>?\}/.source,[O,L]),M=r(t(/[^"'/()]|\/(?!\*)|\/\*(?:[^*]|\*(?!\/))*\*\/|<<0>>|\(<>*\)/.source,[I]),2),D=t(/\{(?!\{)(?:(?![}:])<<0>>)*<<1>>?\}/.source,[M,L]);function z(t,r){return{interpolation:{pattern:n(/((?:^|[^{])(?:\{\{)*)<<0>>/.source,[t]),lookbehind:!0,inside:{"format-string":{pattern:n(/(^\{(?:(?![}:])<<0>>)*)<<1>>(?=\}$)/.source,[r,L]),lookbehind:!0,inside:{punctuation:/^:/}},punctuation:/^\{|\}$/,expression:{pattern:/[\s\S]+/,alias:"language-csharp",inside:e.languages.csharp}}},string:/[\s\S]+/}}e.languages.insertBefore("csharp","string",{"interpolation-string":[{pattern:n(/(^|[^\\])(?:\$@|@\$)"(?:""|\\[\s\S]|\{\{|<<0>>|[^\\{"])*"/.source,[N]),lookbehind:!0,greedy:!0,inside:z(N,O)},{pattern:n(/(^|[^@\\])\$"(?:\\.|\{\{|<<0>>|[^\\"{])*"/.source,[D]),lookbehind:!0,greedy:!0,inside:z(D,M)}],char:{pattern:RegExp(x),greedy:!0}}),e.languages.dotnet=e.languages.cs=e.languages.csharp}(Prism)},99945:()=>{!function(e){var t=/\/\*[\s\S]*?\*\/|\/\/.*|#(?!\[).*/,n=[{pattern:/\b(?:false|true)\b/i,alias:"boolean"},{pattern:/(::\s*)\b[a-z_]\w*\b(?!\s*\()/i,greedy:!0,lookbehind:!0},{pattern:/(\b(?:case|const)\s+)\b[a-z_]\w*(?=\s*[;=])/i,greedy:!0,lookbehind:!0},/\b(?:null)\b/i,/\b[A-Z_][A-Z0-9_]*\b(?!\s*\()/],r=/\b0b[01]+(?:_[01]+)*\b|\b0o[0-7]+(?:_[0-7]+)*\b|\b0x[\da-f]+(?:_[\da-f]+)*\b|(?:\b\d+(?:_\d+)*\.?(?:\d+(?:_\d+)*)?|\B\.\d+)(?:e[+-]?\d+)?/i,a=/|\?\?=?|\.{3}|\??->|[!=]=?=?|::|\*\*=?|--|\+\+|&&|\|\||<<|>>|[?~]|[/^|%*&<>.+-]=?/,o=/[{}\[\](),:;]/;e.languages.php={delimiter:{pattern:/\?>$|^<\?(?:php(?=\s)|=)?/i,alias:"important"},comment:t,variable:/\$+(?:\w+\b|(?=\{))/,package:{pattern:/(namespace\s+|use\s+(?:function\s+)?)(?:\\?\b[a-z_]\w*)+\b(?!\\)/i,lookbehind:!0,inside:{punctuation:/\\/}},"class-name-definition":{pattern:/(\b(?:class|enum|interface|trait)\s+)\b[a-z_]\w*(?!\\)\b/i,lookbehind:!0,alias:"class-name"},"function-definition":{pattern:/(\bfunction\s+)[a-z_]\w*(?=\s*\()/i,lookbehind:!0,alias:"function"},keyword:[{pattern:/(\(\s*)\b(?:array|bool|boolean|float|int|integer|object|string)\b(?=\s*\))/i,alias:"type-casting",greedy:!0,lookbehind:!0},{pattern:/([(,?]\s*)\b(?:array(?!\s*\()|bool|callable|(?:false|null)(?=\s*\|)|float|int|iterable|mixed|object|self|static|string)\b(?=\s*\$)/i,alias:"type-hint",greedy:!0,lookbehind:!0},{pattern:/(\)\s*:\s*(?:\?\s*)?)\b(?:array(?!\s*\()|bool|callable|(?:false|null)(?=\s*\|)|float|int|iterable|mixed|never|object|self|static|string|void)\b/i,alias:"return-type",greedy:!0,lookbehind:!0},{pattern:/\b(?:array(?!\s*\()|bool|float|int|iterable|mixed|object|string|void)\b/i,alias:"type-declaration",greedy:!0},{pattern:/(\|\s*)(?:false|null)\b|\b(?:false|null)(?=\s*\|)/i,alias:"type-declaration",greedy:!0,lookbehind:!0},{pattern:/\b(?:parent|self|static)(?=\s*::)/i,alias:"static-context",greedy:!0},{pattern:/(\byield\s+)from\b/i,lookbehind:!0},/\bclass\b/i,{pattern:/((?:^|[^\s>:]|(?:^|[^-])>|(?:^|[^:]):)\s*)\b(?:abstract|and|array|as|break|callable|case|catch|clone|const|continue|declare|default|die|do|echo|else|elseif|empty|enddeclare|endfor|endforeach|endif|endswitch|endwhile|enum|eval|exit|extends|final|finally|fn|for|foreach|function|global|goto|if|implements|include|include_once|instanceof|insteadof|interface|isset|list|match|namespace|never|new|or|parent|print|private|protected|public|readonly|require|require_once|return|self|static|switch|throw|trait|try|unset|use|var|while|xor|yield|__halt_compiler)\b/i,lookbehind:!0}],"argument-name":{pattern:/([(,]\s*)\b[a-z_]\w*(?=\s*:(?!:))/i,lookbehind:!0},"class-name":[{pattern:/(\b(?:extends|implements|instanceof|new(?!\s+self|\s+static))\s+|\bcatch\s*\()\b[a-z_]\w*(?!\\)\b/i,greedy:!0,lookbehind:!0},{pattern:/(\|\s*)\b[a-z_]\w*(?!\\)\b/i,greedy:!0,lookbehind:!0},{pattern:/\b[a-z_]\w*(?!\\)\b(?=\s*\|)/i,greedy:!0},{pattern:/(\|\s*)(?:\\?\b[a-z_]\w*)+\b/i,alias:"class-name-fully-qualified",greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}},{pattern:/(?:\\?\b[a-z_]\w*)+\b(?=\s*\|)/i,alias:"class-name-fully-qualified",greedy:!0,inside:{punctuation:/\\/}},{pattern:/(\b(?:extends|implements|instanceof|new(?!\s+self\b|\s+static\b))\s+|\bcatch\s*\()(?:\\?\b[a-z_]\w*)+\b(?!\\)/i,alias:"class-name-fully-qualified",greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}},{pattern:/\b[a-z_]\w*(?=\s*\$)/i,alias:"type-declaration",greedy:!0},{pattern:/(?:\\?\b[a-z_]\w*)+(?=\s*\$)/i,alias:["class-name-fully-qualified","type-declaration"],greedy:!0,inside:{punctuation:/\\/}},{pattern:/\b[a-z_]\w*(?=\s*::)/i,alias:"static-context",greedy:!0},{pattern:/(?:\\?\b[a-z_]\w*)+(?=\s*::)/i,alias:["class-name-fully-qualified","static-context"],greedy:!0,inside:{punctuation:/\\/}},{pattern:/([(,?]\s*)[a-z_]\w*(?=\s*\$)/i,alias:"type-hint",greedy:!0,lookbehind:!0},{pattern:/([(,?]\s*)(?:\\?\b[a-z_]\w*)+(?=\s*\$)/i,alias:["class-name-fully-qualified","type-hint"],greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}},{pattern:/(\)\s*:\s*(?:\?\s*)?)\b[a-z_]\w*(?!\\)\b/i,alias:"return-type",greedy:!0,lookbehind:!0},{pattern:/(\)\s*:\s*(?:\?\s*)?)(?:\\?\b[a-z_]\w*)+\b(?!\\)/i,alias:["class-name-fully-qualified","return-type"],greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}}],constant:n,function:{pattern:/(^|[^\\\w])\\?[a-z_](?:[\w\\]*\w)?(?=\s*\()/i,lookbehind:!0,inside:{punctuation:/\\/}},property:{pattern:/(->\s*)\w+/,lookbehind:!0},number:r,operator:a,punctuation:o};var i={pattern:/\{\$(?:\{(?:\{[^{}]+\}|[^{}]+)\}|[^{}])+\}|(^|[^\\{])\$+(?:\w+(?:\[[^\r\n\[\]]+\]|->\w+)?)/,lookbehind:!0,inside:e.languages.php},s=[{pattern:/<<<'([^']+)'[\r\n](?:.*[\r\n])*?\1;/,alias:"nowdoc-string",greedy:!0,inside:{delimiter:{pattern:/^<<<'[^']+'|[a-z_]\w*;$/i,alias:"symbol",inside:{punctuation:/^<<<'?|[';]$/}}}},{pattern:/<<<(?:"([^"]+)"[\r\n](?:.*[\r\n])*?\1;|([a-z_]\w*)[\r\n](?:.*[\r\n])*?\2;)/i,alias:"heredoc-string",greedy:!0,inside:{delimiter:{pattern:/^<<<(?:"[^"]+"|[a-z_]\w*)|[a-z_]\w*;$/i,alias:"symbol",inside:{punctuation:/^<<<"?|[";]$/}},interpolation:i}},{pattern:/`(?:\\[\s\S]|[^\\`])*`/,alias:"backtick-quoted-string",greedy:!0},{pattern:/'(?:\\[\s\S]|[^\\'])*'/,alias:"single-quoted-string",greedy:!0},{pattern:/"(?:\\[\s\S]|[^\\"])*"/,alias:"double-quoted-string",greedy:!0,inside:{interpolation:i}}];e.languages.insertBefore("php","variable",{string:s,attribute:{pattern:/#\[(?:[^"'\/#]|\/(?![*/])|\/\/.*$|#(?!\[).*$|\/\*(?:[^*]|\*(?!\/))*\*\/|"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*')+\](?=\s*[a-z$#])/im,greedy:!0,inside:{"attribute-content":{pattern:/^(#\[)[\s\S]+(?=\]$)/,lookbehind:!0,inside:{comment:t,string:s,"attribute-class-name":[{pattern:/([^:]|^)\b[a-z_]\w*(?!\\)\b/i,alias:"class-name",greedy:!0,lookbehind:!0},{pattern:/([^:]|^)(?:\\?\b[a-z_]\w*)+/i,alias:["class-name","class-name-fully-qualified"],greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}}],constant:n,number:r,operator:a,punctuation:o}},delimiter:{pattern:/^#\[|\]$/,alias:"punctuation"}}}}),e.hooks.add("before-tokenize",(function(t){if(/<\?/.test(t.code)){e.languages["markup-templating"].buildPlaceholders(t,"php",/<\?(?:[^"'/#]|\/(?![*/])|("|')(?:\\[\s\S]|(?!\1)[^\\])*\1|(?:\/\/|#(?!\[))(?:[^?\n\r]|\?(?!>))*(?=$|\?>|[\r\n])|#\[|\/\*(?:[^*]|\*(?!\/))*(?:\*\/|$))*?(?:\?>|$)/g)}})),e.hooks.add("after-tokenize",(function(t){e.languages["markup-templating"].tokenizePlaceholders(t,"php")}))}(Prism)},37345:()=>{!function(e){var t=/\b(?:bool|bytes|double|s?fixed(?:32|64)|float|[su]?int(?:32|64)|string)\b/;e.languages.protobuf=e.languages.extend("clike",{"class-name":[{pattern:/(\b(?:enum|extend|message|service)\s+)[A-Za-z_]\w*(?=\s*\{)/,lookbehind:!0},{pattern:/(\b(?:rpc\s+\w+|returns)\s*\(\s*(?:stream\s+)?)\.?[A-Za-z_]\w*(?:\.[A-Za-z_]\w*)*(?=\s*\))/,lookbehind:!0}],keyword:/\b(?:enum|extend|extensions|import|message|oneof|option|optional|package|public|repeated|required|reserved|returns|rpc(?=\s+\w)|service|stream|syntax|to)\b(?!\s*=\s*\d)/,function:/\b[a-z_]\w*(?=\s*\()/i}),e.languages.insertBefore("protobuf","operator",{map:{pattern:/\bmap<\s*[\w.]+\s*,\s*[\w.]+\s*>(?=\s+[a-z_]\w*\s*[=;])/i,alias:"class-name",inside:{punctuation:/[<>.,]/,builtin:t}},builtin:t,"positional-class-name":{pattern:/(?:\b|\B\.)[a-z_]\w*(?:\.[a-z_]\w*)*(?=\s+[a-z_]\w*\s*[=;])/i,alias:"class-name",inside:{punctuation:/\./}},annotation:{pattern:/(\[\s*)[a-z_]\w*(?=\s*=)/i,lookbehind:!0}})}(Prism)},59385:()=>{!function(e){e.languages.ruby=e.languages.extend("clike",{comment:{pattern:/#.*|^=begin\s[\s\S]*?^=end/m,greedy:!0},"class-name":{pattern:/(\b(?:class|module)\s+|\bcatch\s+\()[\w.\\]+|\b[A-Z_]\w*(?=\s*\.\s*new\b)/,lookbehind:!0,inside:{punctuation:/[.\\]/}},keyword:/\b(?:BEGIN|END|alias|and|begin|break|case|class|def|define_method|defined|do|each|else|elsif|end|ensure|extend|for|if|in|include|module|new|next|nil|not|or|prepend|private|protected|public|raise|redo|require|rescue|retry|return|self|super|then|throw|undef|unless|until|when|while|yield)\b/,operator:/\.{2,3}|&\.|===||[!=]?~|(?:&&|\|\||<<|>>|\*\*|[+\-*/%<>!^&|=])=?|[?:]/,punctuation:/[(){}[\].,;]/}),e.languages.insertBefore("ruby","operator",{"double-colon":{pattern:/::/,alias:"punctuation"}});var t={pattern:/((?:^|[^\\])(?:\\{2})*)#\{(?:[^{}]|\{[^{}]*\})*\}/,lookbehind:!0,inside:{content:{pattern:/^(#\{)[\s\S]+(?=\}$)/,lookbehind:!0,inside:e.languages.ruby},delimiter:{pattern:/^#\{|\}$/,alias:"punctuation"}}};delete e.languages.ruby.function;var n="(?:"+[/([^a-zA-Z0-9\s{(\[<=])(?:(?!\1)[^\\]|\\[\s\S])*\1/.source,/\((?:[^()\\]|\\[\s\S]|\((?:[^()\\]|\\[\s\S])*\))*\)/.source,/\{(?:[^{}\\]|\\[\s\S]|\{(?:[^{}\\]|\\[\s\S])*\})*\}/.source,/\[(?:[^\[\]\\]|\\[\s\S]|\[(?:[^\[\]\\]|\\[\s\S])*\])*\]/.source,/<(?:[^<>\\]|\\[\s\S]|<(?:[^<>\\]|\\[\s\S])*>)*>/.source].join("|")+")",r=/(?:"(?:\\.|[^"\\\r\n])*"|(?:\b[a-zA-Z_]\w*|[^\s\0-\x7F]+)[?!]?|\$.)/.source;e.languages.insertBefore("ruby","keyword",{"regex-literal":[{pattern:RegExp(/%r/.source+n+/[egimnosux]{0,6}/.source),greedy:!0,inside:{interpolation:t,regex:/[\s\S]+/}},{pattern:/(^|[^/])\/(?!\/)(?:\[[^\r\n\]]+\]|\\.|[^[/\\\r\n])+\/[egimnosux]{0,6}(?=\s*(?:$|[\r\n,.;})#]))/,lookbehind:!0,greedy:!0,inside:{interpolation:t,regex:/[\s\S]+/}}],variable:/[@$]+[a-zA-Z_]\w*(?:[?!]|\b)/,symbol:[{pattern:RegExp(/(^|[^:]):/.source+r),lookbehind:!0,greedy:!0},{pattern:RegExp(/([\r\n{(,][ \t]*)/.source+r+/(?=:(?!:))/.source),lookbehind:!0,greedy:!0}],"method-definition":{pattern:/(\bdef\s+)\w+(?:\s*\.\s*\w+)?/,lookbehind:!0,inside:{function:/\b\w+$/,keyword:/^self\b/,"class-name":/^\w+/,punctuation:/\./}}}),e.languages.insertBefore("ruby","string",{"string-literal":[{pattern:RegExp(/%[qQiIwWs]?/.source+n),greedy:!0,inside:{interpolation:t,string:/[\s\S]+/}},{pattern:/("|')(?:#\{[^}]+\}|#(?!\{)|\\(?:\r\n|[\s\S])|(?!\1)[^\\#\r\n])*\1/,greedy:!0,inside:{interpolation:t,string:/[\s\S]+/}},{pattern:/<<[-~]?([a-z_]\w*)[\r\n](?:.*[\r\n])*?[\t ]*\1/i,alias:"heredoc-string",greedy:!0,inside:{delimiter:{pattern:/^<<[-~]?[a-z_]\w*|\b[a-z_]\w*$/i,inside:{symbol:/\b\w+/,punctuation:/^<<[-~]?/}},interpolation:t,string:/[\s\S]+/}},{pattern:/<<[-~]?'([a-z_]\w*)'[\r\n](?:.*[\r\n])*?[\t ]*\1/i,alias:"heredoc-string",greedy:!0,inside:{delimiter:{pattern:/^<<[-~]?'[a-z_]\w*'|\b[a-z_]\w*$/i,inside:{symbol:/\b\w+/,punctuation:/^<<[-~]?'|'$/}},string:/[\s\S]+/}}],"command-literal":[{pattern:RegExp(/%x/.source+n),greedy:!0,inside:{interpolation:t,command:{pattern:/[\s\S]+/,alias:"string"}}},{pattern:/`(?:#\{[^}]+\}|#(?!\{)|\\(?:\r\n|[\s\S])|[^\\`#\r\n])*`/,greedy:!0,inside:{interpolation:t,command:{pattern:/[\s\S]+/,alias:"string"}}}]}),delete e.languages.ruby.string,e.languages.insertBefore("ruby","number",{builtin:/\b(?:Array|Bignum|Binding|Class|Continuation|Dir|Exception|FalseClass|File|Fixnum|Float|Hash|IO|Integer|MatchData|Method|Module|NilClass|Numeric|Object|Proc|Range|Regexp|Stat|String|Struct|Symbol|TMS|Thread|ThreadGroup|Time|TrueClass)\b/,constant:/\b[A-Z][A-Z0-9_]*(?:[?!]|\b)/}),e.languages.rb=e.languages.ruby}(Prism)},99768:(e,t,n)=>{var r={"./prism-csharp":79016,"./prism-php":99945,"./prism-protobuf":37345,"./prism-ruby":59385};function a(e){var t=o(e);return n(t)}function o(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=o,e.exports=a,a.id=99768},34155:e=>{var t,n,r=e.exports={};function a(){throw new Error("setTimeout has not been defined")}function o(){throw new Error("clearTimeout has not been defined")}function i(e){if(t===setTimeout)return setTimeout(e,0);if((t===a||!t)&&setTimeout)return t=setTimeout,setTimeout(e,0);try{return t(e,0)}catch(n){try{return t.call(null,e,0)}catch(n){return t.call(this,e,0)}}}!function(){try{t="function"==typeof setTimeout?setTimeout:a}catch(e){t=a}try{n="function"==typeof clearTimeout?clearTimeout:o}catch(e){n=o}}();var s,c=[],l=!1,u=-1;function d(){l&&s&&(l=!1,s.length?c=s.concat(c):u=-1,c.length&&f())}function f(){if(!l){var e=i(d);l=!0;for(var t=c.length;t;){for(s=c,c=[];++u1)for(var n=1;n{"use strict";var r=n(50414);function a(){}function o(){}o.resetWarningCache=a,e.exports=function(){function e(e,t,n,a,o,i){if(i!==r){var s=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw s.name="Invariant Violation",s}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:o,resetWarningCache:a};return n.PropTypes=n,n}},45697:(e,t,n)=>{e.exports=n(92703)()},50414:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},64448:(e,t,n)=>{"use strict";var r=n(67294),a=n(63840);function o(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n