mirror of
https://github.com/luxfi/bridge.git
synced 2026-09-24 00:26:46 +00:00
Squash of the local main lineage onto the canonical origin/main. Net tree only (62 files): stale docs pages removed, tenant config + tests updated, minor Go fixes, refreshed opnet-watcher build. No third-party white-label branding in code or history. Co-authored-by: Hanzo Dev <[email protected]>
1 line
10 KiB
JavaScript
1 line
10 KiB
JavaScript
(self.webpackChunk_N_E=self.webpackChunk_N_E||[]).push([[405],{1464:function(e,n,s){(window.__NEXT_P=window.__NEXT_P||[]).push(["/",function(){return s(1590)}])},1590:function(e,n,s){"use strict";s.r(n),s.d(n,{__toc:function(){return o}});var i=s(5893),r=s(2673),t=s(6513),l=s(3209);s(4759);var c=s(9530);let o=[{depth:2,value:"Quick Links",id:"quick-links"},{depth:2,value:"What is Lux Bridge?",id:"what-is-lux-bridge"},{depth:2,value:"Supported Networks",id:"supported-networks"},{depth:3,value:"Layer 1",id:"layer-1"},{depth:3,value:"Layer 2",id:"layer-2"},{depth:2,value:"Getting Started",id:"getting-started"},{depth:2,value:"Documentation Structure",id:"documentation-structure"},{depth:2,value:"Need Help?",id:"need-help"}];function a(e){let n=Object.assign({h1:"h1",p:"p",h2:"h2",ul:"ul",li:"li",a:"a",strong:"strong",h3:"h3",pre:"pre",code:"code",span:"span",hr:"hr",em:"em"},(0,c.a)(),e.components);return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{children:"Lux Bridge Documentation"}),"\n",(0,i.jsx)(n.p,{children:"Welcome to the comprehensive documentation for the Lux Bridge - a decentralized cross-chain bridge infrastructure using Multi-Party Computation (MPC) for secure asset transfers."}),"\n",(0,i.jsx)(n.h2,{id:"quick-links",children:"Quick Links"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs",children:"Architecture & Design"})," - Learn about the bridge architecture"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs#api-reference",children:"API Reference"})," - Integrate with the bridge"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs#deployment-guide",children:"Deployment Guide"})," - Deploy your own instance"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs#security-best-practices",children:"Security Best Practices"})," - Keep your bridge secure"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"what-is-lux-bridge",children:"What is Lux Bridge?"}),"\n",(0,i.jsx)(n.p,{children:"The Lux Bridge is a decentralized cross-chain bridge that enables:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Secure Asset Transfers"})," - Transfer tokens between 15+ blockchain networks"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Multi-Party Computation"})," - 2-of-3 threshold signatures for maximum security"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Universal Message Passing"})," - Send arbitrary messages across chains"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Low Fees"})," - Competitive 0.3% bridge fee with caps"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Fast Finality"})," - Transfers complete in minutes, not hours"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"supported-networks",children:"Supported Networks"}),"\n",(0,i.jsx)(n.h3,{id:"layer-1",children:"Layer 1"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Lux Network"}),"\n",(0,i.jsx)(n.li,{children:"Ethereum"}),"\n",(0,i.jsx)(n.li,{children:"BNB Smart Chain"}),"\n",(0,i.jsx)(n.li,{children:"Polygon"}),"\n",(0,i.jsx)(n.li,{children:"Avalanche"}),"\n",(0,i.jsx)(n.li,{children:"Fantom"}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"layer-2",children:"Layer 2"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Arbitrum One"}),"\n",(0,i.jsx)(n.li,{children:"Optimism"}),"\n",(0,i.jsx)(n.li,{children:"zkSync Era"}),"\n",(0,i.jsx)(n.li,{children:"Polygon zkEVM"}),"\n",(0,i.jsx)(n.li,{children:"Base"}),"\n",(0,i.jsx)(n.li,{children:"Blast"}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,i.jsx)(n.pre,{"data-language":"bash","data-theme":"default",hasCopyCode:!0,children:(0,i.jsxs)(n.code,{"data-language":"bash","data-theme":"default",children:[(0,i.jsx)(n.span,{className:"line",children:(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-comment)"},children:"# Clone the repository"})}),"\n",(0,i.jsxs)(n.span,{className:"line",children:[(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-function)"},children:"git"}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-color-text)"},children:" "}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-string)"},children:"clone"}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-color-text)"},children:" "}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-string)"},children:"https://github.com/luxfi/bridge"})]}),"\n",(0,i.jsxs)(n.span,{className:"line",children:[(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-function)"},children:"cd"}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-color-text)"},children:" "}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-string)"},children:"bridge"})]}),"\n",(0,i.jsx)(n.span,{className:"line",children:" "}),"\n",(0,i.jsx)(n.span,{className:"line",children:(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-comment)"},children:"# Install dependencies"})}),"\n",(0,i.jsxs)(n.span,{className:"line",children:[(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-function)"},children:"pnpm"}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-color-text)"},children:" "}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-string)"},children:"install"})]}),"\n",(0,i.jsx)(n.span,{className:"line",children:" "}),"\n",(0,i.jsx)(n.span,{className:"line",children:(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-comment)"},children:"# Start local development"})}),"\n",(0,i.jsxs)(n.span,{className:"line",children:[(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-function)"},children:"make"}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-color-text)"},children:" "}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-string)"},children:"up"})]}),"\n",(0,i.jsxs)(n.span,{className:"line",children:[(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-function)"},children:"make"}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-color-text)"},children:" "}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-string)"},children:"start-mpc-nodes"})]}),"\n",(0,i.jsxs)(n.span,{className:"line",children:[(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-function)"},children:"cd"}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-color-text)"},children:" "}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-string)"},children:"app/bridge"}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-color-text)"},children:" "}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-punctuation)"},children:"&&"}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-color-text)"},children:" "}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-function)"},children:"pnpm"}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-color-text)"},children:" "}),(0,i.jsx)(n.span,{style:{color:"var(--shiki-token-string)"},children:"dev"})]})]})}),"\n",(0,i.jsxs)(n.p,{children:["Visit ",(0,i.jsx)(n.a,{href:"http://localhost:3000",children:"http://localhost:3000"})," to see the bridge UI."]}),"\n",(0,i.jsx)(n.h2,{id:"documentation-structure",children:"Documentation Structure"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.a,{href:"/docs",children:"Complete Documentation"})})," - Full technical documentation"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.a,{href:"/docs#integration-guide",children:"Integration Examples"})})," - Code examples and SDKs"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.a,{href:"/docs#api-reference",children:"API Reference"})})," - REST and WebSocket APIs"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.a,{href:"/docs#security-best-practices",children:"Security"})})," - Security guidelines"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"need-help",children:"Need Help?"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Join our ",(0,i.jsx)(n.a,{href:"https://discord.gg/luxnetwork",children:"Discord"})]}),"\n",(0,i.jsxs)(n.li,{children:["Follow us on ",(0,i.jsx)(n.a,{href:"https://twitter.com/luxnetwork",children:"Twitter"})]}),"\n",(0,i.jsxs)(n.li,{children:["Email support: ",(0,i.jsx)(n.a,{href:"mailto:[email protected]",children:"[email protected]"})]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.em,{children:"Version 1.0.0 - November 2024"})})]})}let d={MDXContent:function(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},{wrapper:n}=Object.assign({},(0,c.a)(),e.components);return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)},pageOpts:{filePath:"pages/index.mdx",route:"/",pageMap:[{kind:"Meta",data:{index:{title:"Home",type:"page"},docs:{title:"Documentation",type:"page"},"-- API":{type:"separator",title:"API"},api:{title:"API Reference",href:"/docs#api-reference"},"-- Guides":{type:"separator",title:"Guides"},integration:{title:"Integration Guide",href:"/docs#integration-guide"},deployment:{title:"Deployment Guide",href:"/docs#deployment-guide"},security:{title:"Security",href:"/docs#security-best-practices"}}},{kind:"MdxPage",name:"docs",route:"/docs"},{kind:"MdxPage",name:"index",route:"/"}],flexsearch:{codeblocks:!0},title:"Lux Bridge Documentation",headings:o},pageNextRoute:"/",nextraLayout:t.ZP,themeConfig:l.Z};n.default=(0,r.j)(d)},3209:function(e,n,s){"use strict";var i=s(5893);s(7294);let r={logo:(0,i.jsx)("span",{children:"Lux Bridge"}),project:{link:"https://github.com/luxfi/bridge"},chat:{link:"https://discord.gg/luxnetwork"},docsRepositoryBase:"https://github.com/luxfi/bridge/tree/main/docs",footer:{text:"Lux Bridge Documentation"},head:(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("meta",{name:"viewport",content:"width=device-width, initial-scale=1.0"}),(0,i.jsx)("meta",{property:"og:title",content:"Lux Bridge Documentation"}),(0,i.jsx)("meta",{property:"og:description",content:"Comprehensive documentation for the Lux Bridge - a decentralized cross-chain bridge using MPC"})]}),sidebar:{titleComponent(e){let{title:n,type:s}=e;return"separator"===s?(0,i.jsx)("span",{className:"cursor-default",children:n}):(0,i.jsx)(i.Fragment,{children:n})},defaultMenuCollapseLevel:1,toggleButton:!0},toc:{backToTop:!0},navigation:{prev:!0,next:!0},darkMode:!0,primaryHue:200,banner:{key:"bridge-v1",text:(0,i.jsx)("a",{href:"https://lux.network",target:"_blank",children:"\uD83D\uDE80 Lux Bridge v1.0 is now live! Learn more →"})}};n.Z=r},5789:function(){}},function(e){e.O(0,[73,888,774,179],function(){return e(e.s=1464)}),_N_E=e.O()}]); |