1 line
6.9 KiB
JavaScript
1 line
6.9 KiB
JavaScript
"use strict";(self.webpackChunkcanine_docs=self.webpackChunkcanine_docs||[]).push([[63],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>k});var n=r(7294);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<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?o(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):o(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function l(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},o=Object.keys(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var i=n.createContext({}),p=function(e){var t=n.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},c=function(e){var t=p(e.components);return n.createElement(i.Provider,{value:t},e.children)},u="mdxType",d={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,o=e.originalType,i=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),u=p(r),m=a,k=u["".concat(i,".").concat(m)]||u[m]||d[m]||o;return r?n.createElement(k,s(s({ref:t},c),{},{components:r})):n.createElement(k,s({ref:t},c))}));function k(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,s=new Array(o);s[0]=m;var l={};for(var i in t)hasOwnProperty.call(t,i)&&(l[i]=t[i]);l.originalType=e,l[u]="string"==typeof e?e:a,s[1]=l;for(var p=2;p<o;p++)s[p]=r[p];return n.createElement.apply(null,s)}return n.createElement.apply(null,r)}m.displayName="MDXCreateElement"},6960:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={sidebar_position:2},s="Jackal.js-protos / Jackal.nodejs-protos",l={unversionedId:"developers/dAppLibraries/jackal_protos",id:"developers/dAppLibraries/jackal_protos",title:"Jackal.js-protos / Jackal.nodejs-protos",description:"About",source:"@site/docs/developers/dAppLibraries/2_jackal_protos.md",sourceDirName:"developers/dAppLibraries",slug:"/developers/dAppLibraries/jackal_protos",permalink:"/docs/developers/dAppLibraries/jackal_protos",draft:!1,editUrl:"https://github.com/JackalLabs/canine-docs/blob/master/docs/developers/dAppLibraries/2_jackal_protos.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"About These Libraries",permalink:"/docs/developers/dAppLibraries/intro"},next:{title:"Jackal.js",permalink:"/docs/developers/dAppLibraries/jackal_js"}},i={},p=[{value:"About",id:"about",level:2},{value:"Quickstart",id:"quickstart",level:2},{value:"Pre-requesites",id:"pre-requesites",level:3},{value:"Setting Up",id:"setting-up",level:3},{value:"Updating Vite Config",id:"updating-vite-config",level:4},{value:"Next Steps",id:"next-steps",level:2}],c={toc:p},u="wrapper";function d(e){let{components:t,...r}=e;return(0,a.kt)(u,(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"jackaljs-protos--jackalnodejs-protos"},"Jackal.js-protos / Jackal.nodejs-protos"),(0,a.kt)("h2",{id:"about"},"About"),(0,a.kt)("p",null,'The Protos modules for Jackal.js and Jackal.nodejs ("Protos") is the conversion layer the accepts raw protobufs from the\nJackal chain and converts them to useable typescrypt code. The differences between these 2 packages are only in the\ncompatibility with either browser or Nodejs Javascript APIs and how they are packaged for consumption. Protos is\ndesigned\nfor those that wish to write their own Jackal-compatible library instead of using Jackal.js / Jackal.nodejs.'),(0,a.kt)("h2",{id:"quickstart"},"Quickstart"),(0,a.kt)("p",null,"To get started using Protos, you'll need a few things!"),(0,a.kt)("h3",{id:"pre-requesites"},"Pre-requesites"),(0,a.kt)("p",null,"Both:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Nodejs v20+"),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://www.npmjs.com/package/eciesjs"},"ECIESJS"))),(0,a.kt)("p",null,"Jackal.js-protos:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://vitejs.dev"},"Vite")),(0,a.kt)("li",{parentName:"ul"},"Chromium-family browser (Chrome, Brave, Edge, etc)"),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://www.keplr.app"},"Keplr")," or ",(0,a.kt)("a",{parentName:"li",href:"https://www.leapwallet.io/cosmos"},"Leap")," wallet extension")),(0,a.kt)("p",null,"Jackal.nodejs-protos:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"None")),(0,a.kt)("p",null,"Protos requires Node v20+. The easiest way to manage this is\nwith ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/nvm-sh/nvm#installing-and-updating"},"NVM"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-shell"},"nvm use 20\n")),(0,a.kt)("h3",{id:"setting-up"},"Setting Up"),(0,a.kt)("p",null,"To get started, make sure your Jackal.js-protos based project has ",(0,a.kt)("a",{parentName:"p",href:"https://vitejs.dev/guide"},"Vite installed"),".\nJackal.nodejs-protos\ndoes not need this."),(0,a.kt)("p",null,"Install dependencies:"),(0,a.kt)("p",null,"(Jackal.js-protos)"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-shell"},"npm create vite@latest\nnpm install jackal.js-protos eciesjs @cosmjs/launchpad @cosmjs/proto-signing @cosmjs/stargate\nnpm install -D vite-plugin-node-stdlib-browser\n")),(0,a.kt)("p",null,"OR"),(0,a.kt)("p",null,"(Jackal.nodejs-protos)"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-shell"},"npm install jackal.nodejs-protos eciesjs @cosmjs/launchpad @cosmjs/proto-signing @cosmjs/stargate\nnpm install -D @types/node typescript tscpaths\n")),(0,a.kt)("h4",{id:"updating-vite-config"},"Updating Vite Config"),(0,a.kt)("p",null,"(Jackal.js-protos)"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"// In vite.config.js:\nimport { defineConfig } from 'vite'\nimport nodePolyfills from 'vite-plugin-node-stdlib-browser'\n\nexport default defineConfig({\n plugins: [\n nodePolyfills()\n ],\n})\n")),(0,a.kt)("h2",{id:"next-steps"},"Next Steps"),(0,a.kt)("p",null,"Once everything is set up as detailed above, you are free to create as little or as much using the methods exposed by\nProtos.\nFull documentation of these methods coming soon."))}d.isMDXComponent=!0}}]); |