Skip to content

Commit 5635e02

Browse files
salmad3salmad3
authored
Merge pull request #839 from maticnetwork/move_maticjs_to_docs_polygon
uploaded Matic.js into documentation
2 parents c62faa3 + 7c7320a commit 5635e02

File tree

142 files changed

+4038
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

142 files changed

+4038
-5
lines changed

‎docs/develop/ethereum-polygon/getting-started.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ to optimise for speed and decentralisation. We consciously architected the syste
2323

2424
| | PoS Bridge(Recommended) | Plasma Bridge |
2525
| ------------------------------------ | ---------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
26-
| **Short Description** | DApp Developer's looking for flexibility and faster withdrawals with POS system security | DApp Developer's looking for increased security guarantees with Plasma exit mechanism\. |
26+
| **Short description** | DApp Developer's looking for flexibility and faster withdrawals with POS system security | DApp Developer's looking for increased security guarantees with Plasma exit mechanism\. |
2727
| **Structure** | Highly flexible | Rigid, Less Flexible |
2828
| **Deposit\(Ethereum → Polygon\)** | 3-5 mins | 3-5 mins |
2929
| **Withdrawal\(Polygon → Ethereum\)** | 1 checkpoint = ~ 20 mins to 3 hours | Call to the process-exit procedure on Ethereum's contract. |

‎docs/develop/ethereum-polygon/index.js‎

Lines changed: 381 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,381 @@
1+
module.exports = [
2+
{
3+
text: 'Get Started',
4+
url: 'get-started',
5+
},
6+
{
7+
text: 'Installation',
8+
url: 'installation',
9+
},
10+
{
11+
text: 'Setup',
12+
url: 'setup',
13+
// expand: true,
14+
children: [
15+
{
16+
text: 'Web3.js',
17+
url: 'web3js',
18+
},
19+
{
20+
text: 'Ethers',
21+
url: 'ethers',
22+
},
23+
],
24+
},
25+
{
26+
text: 'API Architecture',
27+
url: 'api-architecture',
28+
},
29+
{
30+
text: 'POS',
31+
url: 'pos',
32+
children: [
33+
{
34+
text: 'ERC20',
35+
url: 'erc20',
36+
37+
children: [
38+
{
39+
text: 'getBalance',
40+
url: 'get-balance',
41+
},
42+
{
43+
text: 'approve',
44+
url: 'approve',
45+
},
46+
{
47+
text: 'approveMax',
48+
url: 'approve-max',
49+
},
50+
{
51+
text: 'getAllowance',
52+
url: 'get-allowance',
53+
},
54+
{
55+
text: 'deposit',
56+
url: 'deposit',
57+
},
58+
{
59+
text: 'transfer',
60+
url: 'transfer',
61+
},
62+
{
63+
text: 'withdrawStart',
64+
url: 'withdraw-start',
65+
},
66+
{
67+
text: 'withdrawExit',
68+
url: 'withdraw-exit',
69+
},
70+
{
71+
text: 'withdrawExitFaster',
72+
url: 'withdraw-exit-faster',
73+
},
74+
{
75+
text: 'isWithdrawExited',
76+
url: 'is-withdraw-exited',
77+
},
78+
],
79+
},
80+
{
81+
text: 'ERC721',
82+
url: 'erc721',
83+
children: [
84+
{
85+
text: 'getTokensCount',
86+
url: 'get-tokens-count',
87+
},
88+
{
89+
text: 'getTokenIdAtIndexForUser',
90+
url: 'get-token-id-at-index-for-user',
91+
},
92+
{
93+
text: 'getAllTokens',
94+
url: 'get-all-tokens',
95+
},
96+
{
97+
text: 'isApproved',
98+
url: 'is-approved',
99+
},
100+
{
101+
text: 'isApprovedAll',
102+
url: 'is-approved-all',
103+
},
104+
{
105+
text: 'approve',
106+
url: 'approve',
107+
},
108+
{
109+
text: 'approveAll',
110+
url: 'approve-all',
111+
},
112+
{
113+
text: 'deposit',
114+
url: 'deposit',
115+
},
116+
{
117+
text: 'depositMany',
118+
url: 'deposit-many',
119+
},
120+
{
121+
text: 'withdrawStart',
122+
url: 'withdraw-start',
123+
},
124+
{
125+
text: 'withdrawStartMany',
126+
url: 'withdraw-start-many',
127+
},
128+
{
129+
text: 'withdrawExit',
130+
url: 'withdraw-exit',
131+
},
132+
{
133+
text: 'withdrawExitMany',
134+
url: 'withdraw-exit-many',
135+
},
136+
{
137+
text: 'withdrawExitFaster',
138+
url: 'withdraw-exit-faster',
139+
},
140+
{
141+
text: 'withdrawExitFasterMany',
142+
url: 'withdraw-exit-faster-many',
143+
},
144+
{
145+
text: 'isWithdrawExited',
146+
url: 'is-withdraw-exited',
147+
},
148+
{
149+
text: 'isWithdrawExitedMany',
150+
url: 'is-withdraw-exited-many',
151+
},
152+
{
153+
text: 'transfer',
154+
url: 'transfer',
155+
},
156+
{
157+
text: 'withdrawStartWithMetaData',
158+
url: 'withdraw-start-with-meta-data',
159+
},
160+
],
161+
},
162+
{
163+
text: 'ERC1155',
164+
url: 'erc1155',
165+
children: [
166+
{
167+
text: 'getBalance',
168+
url: 'get-balance',
169+
},
170+
{
171+
text: 'approveAll',
172+
url: 'approve-all',
173+
},
174+
{
175+
text: 'approveAllForMintable',
176+
url: 'approve-all-for-mintable',
177+
},
178+
{
179+
text: 'isApprovedAll',
180+
url: 'is-approved-all',
181+
},
182+
{
183+
text: 'deposit',
184+
url: 'deposit',
185+
},
186+
{
187+
text: 'depositMany',
188+
url: 'deposit-many',
189+
},
190+
{
191+
text: 'withdrawStart',
192+
url: 'withdraw-start',
193+
},
194+
{
195+
text: 'withdrawStartMany',
196+
url: 'withdraw-start-many',
197+
},
198+
{
199+
text: 'withdrawExit',
200+
url: 'withdraw-exit',
201+
},
202+
{
203+
text: 'withdrawExitFaster',
204+
url: 'withdraw-exit-faster',
205+
},
206+
{
207+
text: 'withdrawExitMany',
208+
url: 'withdraw-exit-many',
209+
},
210+
{
211+
text: 'withdrawExitFasterMany',
212+
url: 'withdraw-exit-faster-many',
213+
},
214+
{
215+
text: 'isWithdrawExited',
216+
url: 'is-withdraw-exited',
217+
},
218+
{
219+
text: 'isWithdrawExitedMany',
220+
url: 'is-withdraw-exited-many',
221+
},
222+
{
223+
text: 'transfer',
224+
url: 'transfer',
225+
},
226+
]
227+
},
228+
{
229+
text: 'isCheckPointed',
230+
url: 'is-check-pointed',
231+
},
232+
{
233+
text: 'isDeposited',
234+
url: 'is-deposited',
235+
},
236+
{
237+
text: 'depositEther',
238+
url: 'deposit-ether',
239+
},
240+
],
241+
},
242+
{
243+
text: 'Plasma',
244+
url: 'plasma',
245+
children: [
246+
{
247+
text: 'ERC20',
248+
url: 'erc20',
249+
250+
children: [
251+
{
252+
text: 'getBalance',
253+
url: 'get-balance',
254+
},
255+
{
256+
text: 'approve',
257+
url: 'approve',
258+
},
259+
{
260+
text: 'approveMax',
261+
url: 'approve-max',
262+
},
263+
{
264+
text: 'getAllowance',
265+
url: 'get-allowance',
266+
},
267+
{
268+
text: 'deposit',
269+
url: 'deposit',
270+
},
271+
{
272+
text: 'transfer',
273+
url: 'transfer',
274+
},
275+
{
276+
text: 'withdrawStart',
277+
url: 'withdraw-start',
278+
},
279+
{
280+
text: 'withdrawConfirm',
281+
url: 'withdraw-confirm',
282+
},
283+
{
284+
text: 'withdrawConfirmFaster',
285+
url: 'withdraw-confirm-faster',
286+
},
287+
{
288+
text: 'withdrawExit',
289+
url: 'withdraw-exit',
290+
},
291+
],
292+
},
293+
{
294+
text: 'ERC721',
295+
url: 'erc721',
296+
children: [
297+
{
298+
text: 'getTokensCount',
299+
url: 'get-tokens-count',
300+
},
301+
{
302+
text: 'getTokenIdAtIndexForUser',
303+
url: 'get-token-id-at-index-for-user',
304+
},
305+
{
306+
text: 'getAllTokens',
307+
url: 'get-all-tokens',
308+
},
309+
{
310+
text: 'safeDeposit',
311+
url: 'safe-deposit',
312+
},
313+
{
314+
text: 'withdrawStart',
315+
url: 'withdraw-start',
316+
},
317+
{
318+
text: 'withdrawConfirm',
319+
url: 'withdraw-confirm',
320+
},
321+
{
322+
text: 'withdrawConfirmFaster',
323+
url: 'withdraw-confirm-faster',
324+
},
325+
{
326+
text: 'withdrawExit',
327+
url: 'withdraw-exit',
328+
},
329+
{
330+
text: 'transfer',
331+
url: 'transfer',
332+
},
333+
],
334+
},
335+
{
336+
text: 'isDeposited',
337+
url: 'is-deposited',
338+
},
339+
{
340+
text: 'isCheckPointed',
341+
url: 'is-check-pointed',
342+
},
343+
{
344+
text: 'withdrawExit',
345+
url: 'withdraw-exit',
346+
},
347+
{
348+
text: 'depositEther',
349+
url: 'deposit-ether',
350+
},
351+
],
352+
},
353+
{
354+
text: 'FxPortal',
355+
url: 'fx-portal',
356+
},
357+
{
358+
text: 'setProofApi',
359+
url: 'set-proof-api',
360+
},
361+
{
362+
text: 'Advanced',
363+
url: 'advanced',
364+
expand: true,
365+
366+
children: [
367+
{
368+
text: 'ABIManager',
369+
url: 'abi-manager',
370+
},
371+
{
372+
text: 'Plugin',
373+
url: 'plugin',
374+
},
375+
{
376+
text: 'ExitUtil',
377+
url: 'exit-util',
378+
},
379+
],
380+
},
381+
]

0 commit comments

Comments
 (0)