1"use strict";(globalThis.webpackChunkdocs=globalThis.webpackChunkdocs||[]).push([[2833],{15111(e,r,n){n.r(r),n.d(r,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>s,toc:()=>o});const s=JSON.parse('{"id":"reference/NoirJS/noir_js/classes/Noir","title":"Class: Noir","description":"Constructors","source":"@site/processed-docs/reference/NoirJS/noir_js/classes/Noir.md","sourceDirName":"reference/NoirJS/noir_js/classes","slug":"/reference/NoirJS/noir_js/classes/Noir","permalink":"/docs/dev/reference/NoirJS/noir_js/classes/Noir","draft":false,"unlisted":false,"editUrl":"https://github.com/noir-lang/noir/edit/master/docs/docs/reference/NoirJS/noir_js/classes/Noir.md","tags":[],"version":"current","frontMatter":{},"sidebar":"sidebar","previous":{"title":"noir_js","permalink":"/docs/dev/reference/NoirJS/noir_js/"},"next":{"title":"Type Alias: ErrorWithPayload","permalink":"/docs/dev/reference/NoirJS/noir_js/type-aliases/ErrorWithPayload"}}');var t=n(74848),i=n(28453);const c={},d="Class: Noir",l={},o=[{value:"Constructors",id:"constructors",level:2},{value:"Constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Methods",id:"methods",level:2},{value:"execute()",id:"execute",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Description",id:"description",level:4},{value:"Example",id:"example",level:4}];function a(e){const r={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.header,{children:(0,t.jsx)(r.h1,{id:"class-noir",children:"Class: Noir"})}),"\n",(0,t.jsx)(r.h2,{id:"constructors",children:"Constructors"}),"\n",(0,t.jsx)(r.h3,{id:"constructor",children:"Constructor"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:"new Noir(circuit): Noir;\n"})}),"\n",(0,t.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,t.jsxs)(r.table,{children:[(0,t.jsx)(r.thead,{children:(0,t.jsxs)(r.tr,{children:[(0,t.jsx)(r.th,{children:"Parameter"}),(0,t.jsx)(r.th,{children:"Type"})]})}),(0,t.jsx)(r.tbody,{children:(0,t.jsxs)(r.tr,{children:[(0,t.jsx)(r.td,{children:(0,t.jsx)(r.code,{children:"circuit"})}),(0,t.jsx)(r.td,{children:(0,t.jsx)(r.code,{children:"CompiledCircuit"})})]})})]}),"\n",(0,t.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.code,{children:"Noir"})}),"\n",(0,t.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(r.h3,{id:"execute",children:"execute()"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:"execute(inputs, foreignCallHandler?): Promise<{\n returnValue: InputValue;\n witness: Uint8Array;\n}>;\n"})}),"\n",(0,t.jsx)(r.h4,{id:"parameters-1",children:"Parameters"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,t.jsxs)(r.table,{children:[(0,t.jsx)(r.thead,{children:(0,t.jsxs)(r.tr,{children:[(0,t.jsx)(r.th,{children:"Parameter"}),(0,t.jsx)(r.th,{children:"Type"})]})}),(0,t.jsxs)(r.tbody,{children:[(0,t.jsxs)(r.tr,{children:[(0,t.jsx)(r.td,{children:(0,t.jsx)(r.code,{children:"inputs"})}),(0,t.jsx)(r.td,{children:(0,t.jsx)(r.code,{children:"InputMap"})})]}),(0,t.jsxs)(r.tr,{children:[(0,t.jsx)(r.td,{children:(0,t.jsx)(r.code,{children:"foreignCallHandler?"})}),(0,t.jsx)(r.td,{children:(0,t.jsx)(r.code,{children:"any"})})]})]})]}),"\n",(0,t.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.code,{children:"Promise"}),"<{\n",(0,t.jsx)(r.code,{children:"returnValue"}),": ",(0,t.jsx)(r.code,{children:"InputValue"}),";\n",(0,t.jsx)(r.code,{children:"witness"}),": ",(0,t.jsx)(r.code,{children:"Uint8Array"}),";\n}>"]}),"\n",(0,t.jsx)(r.h4,{id:"description",children:"Description"}),"\n",(0,t.jsx)(r.p,{children:"Allows to execute a circuit to get its witness and return value."}),"\n",(0,t.jsx)(r.h4,{id:"example",children:"Example"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-typescript",children:"async execute(inputs)\n"})})]})}function h(e={}){const{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},28453(e,r,n){n.d(r,{R:()=>c,x:()=>d});var s=n(96540);const t={},i=s.createContext(t);function c(e){const r=s.useContext(i);return s.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function d(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:r},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.