Skip to content

Commit b3f7b12

Browse files
Le-CaignecLe-Caignec
committed
refactor(docs): update iApp references in SDK documentation for consistency
1 parent a69ccb4 commit b3f7b12

File tree

8 files changed

+100
-100
lines changed

8 files changed

+100
-100
lines changed

‎src/references/iapp-generator/sdk/getGrantedAccess.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ the object is a string representation of an ethereum address or ENS name
2222
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
2323

2424
const web3Provider = getWeb3Provider('PRIVATE_KEY');
25-
const dataProtectorCore = new IExecIApp(web3Provider);
25+
const iapp = new IExecIApp(web3Provider);
2626
// ---cut---
27-
const listGrantedAccess = await dataProtectorCore.getGrantedAccess({
27+
const listGrantedAccess = await iapp.getGrantedAccess({
2828
iapp: '0x123abc...',
2929
authorizedProtectedData: '0x456def...',
3030
authorizedUser: '0x789cba...',
@@ -54,9 +54,9 @@ access for any iApp.
5454
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
5555

5656
const web3Provider = getWeb3Provider('PRIVATE_KEY');
57-
const dataProtectorCore = new IExecIApp(web3Provider);
57+
const iapp = new IExecIApp(web3Provider);
5858
// ---cut---
59-
const listGrantedAccess = await dataProtectorCore.getGrantedAccess({
59+
const listGrantedAccess = await iapp.getGrantedAccess({
6060
iapp: '0x123abc...', // [!code focus]
6161
});
6262
```
@@ -76,9 +76,9 @@ access for any protected data.
7676
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
7777

7878
const web3Provider = getWeb3Provider('PRIVATE_KEY');
79-
const dataProtectorCore = new IExecIApp(web3Provider);
79+
const iapp = new IExecIApp(web3Provider);
8080
// ---cut---
81-
const listGrantedAccess = await dataProtectorCore.getGrantedAccess({
81+
const listGrantedAccess = await iapp.getGrantedAccess({
8282
authorizedProtectedData: '0x456def...', // [!code focus]
8383
});
8484
```
@@ -110,9 +110,9 @@ access for any user.
110110
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
111111

112112
const web3Provider = getWeb3Provider('PRIVATE_KEY');
113-
const dataProtectorCore = new IExecIApp(web3Provider);
113+
const iapp = new IExecIApp(web3Provider);
114114
// ---cut---
115-
const listGrantedAccess = await dataProtectorCore.getGrantedAccess({
115+
const listGrantedAccess = await iapp.getGrantedAccess({
116116
authorizedUser: '0x789cba...', // [!code focus]
117117
});
118118
```
@@ -129,10 +129,10 @@ specified user. Authorizations made for `any` user are not returned.
129129
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
130130

131131
const web3Provider = getWeb3Provider('PRIVATE_KEY');
132-
const dataProtectorCore = new IExecIApp(web3Provider);
132+
const iapp = new IExecIApp(web3Provider);
133133
// ---cut---
134134

135-
const listGrantedAccess = await dataProtectorCore.getGrantedAccess({
135+
const listGrantedAccess = await iapp.getGrantedAccess({
136136
iapp: '0x123abc...',
137137
authorizedProtectedData: '0x456def...',
138138
authorizedUser: '0x789cba...',
@@ -157,9 +157,9 @@ first page (page 0) containing `20` elements.
157157
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
158158

159159
const web3Provider = getWeb3Provider('PRIVATE_KEY');
160-
const dataProtectorCore = new IExecIApp(web3Provider);
160+
const iapp = new IExecIApp(web3Provider);
161161
// ---cut---
162-
const listGrantedAccess = await dataProtectorCore.getGrantedAccess({
162+
const listGrantedAccess = await iapp.getGrantedAccess({
163163
iapp: '0x123abc...',
164164
page: 1, // [!code focus]
165165
pageSize: 100,
@@ -182,9 +182,9 @@ each page.
182182
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
183183

184184
const web3Provider = getWeb3Provider('PRIVATE_KEY');
185-
const dataProtectorCore = new IExecIApp(web3Provider);
185+
const iapp = new IExecIApp(web3Provider);
186186
// ---cut---
187-
const listGrantedAccess = await dataProtectorCore.getGrantedAccess({
187+
const listGrantedAccess = await iapp.getGrantedAccess({
188188
iapp: '0x123abc...',
189189
page: 1,
190190
pageSize: 100, // [!code focus]

‎src/references/iapp-generator/sdk/getIApp.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ The method returns iApp metadata including name, address, owner, and creation ti
2525
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
2626

2727
const web3Provider = getWeb3Provider('PRIVATE_KEY');
28-
const dataProtectorCore = new IExecIApp(web3Provider);
28+
const iapp = new IExecIApp(web3Provider);
2929
// ---cut---
30-
const listIApps = await dataProtectorCore.getIApp({
30+
const listIApps = await iapp.getIApp({
3131
owner: '0xa0c15e...',
3232
createdAfterTimestamp: 1640995200,
3333
page: 1,
@@ -52,9 +52,9 @@ Returns an empty array if the iApp is not found.
5252
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
5353

5454
const web3Provider = getWeb3Provider('PRIVATE_KEY');
55-
const dataProtectorCore = new IExecIApp(web3Provider);
55+
const iapp = new IExecIApp(web3Provider);
5656
// ---cut---
57-
const oneIApp = await dataProtectorCore.getIApp({
57+
const oneIApp = await iapp.getIApp({
5858
iapp: '0x123abc...', // [!code focus]
5959
});
6060
```
@@ -69,9 +69,9 @@ Returns all iApps owned by this address.
6969
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
7070

7171
const web3Provider = getWeb3Provider('PRIVATE_KEY');
72-
const dataProtectorCore = new IExecIApp(web3Provider);
72+
const iapp = new IExecIApp(web3Provider);
7373
// ---cut---
74-
const iAppsByOwner = await dataProtectorCore.getIApp({
74+
const iAppsByOwner = await iapp.getIApp({
7575
owner: '0xa0c15e...', // [!code focus]
7676
});
7777
### createdAfterTimestamp <OptionalBadge />
@@ -84,9 +84,9 @@ Returns all iApps created after this timestamp (Unix timestamp in seconds).
8484
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
8585
8686
const web3Provider = getWeb3Provider('PRIVATE_KEY');
87-
const dataProtectorCore = new IExecIApp(web3Provider);
87+
const iapp = new IExecIApp(web3Provider);
8888
// ---cut---
89-
const recentIApps = await dataProtectorCore.getIApp({
89+
const recentIApps = await iapp.getIApp({
9090
createdAfterTimestamp: 1640995200, // [!code focus]
9191
});
9292
```
@@ -102,9 +102,9 @@ Specifies the page number of the result set to return. Pages are zero-based inde
102102
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
103103
104104
const web3Provider = getWeb3Provider('PRIVATE_KEY');
105-
const dataProtectorCore = new IExecIApp(web3Provider);
105+
const iapp = new IExecIApp(web3Provider);
106106
// ---cut---
107-
const iAppsPage = await dataProtectorCore.getIApp({
107+
const iAppsPage = await iapp.getIApp({
108108
page: 1, // [!code focus]
109109
pageSize: 20,
110110
});
@@ -121,9 +121,9 @@ Specifies the number of records to include in each page of the result set.
121121
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
122122
123123
const web3Provider = getWeb3Provider('PRIVATE_KEY');
124-
const dataProtectorCore = new IExecIApp(web3Provider);
124+
const iapp = new IExecIApp(web3Provider);
125125
// ---cut---
126-
const iAppsPage = await dataProtectorCore.getIApp({
126+
const iAppsPage = await iapp.getIApp({
127127
page: 1,
128128
pageSize: 50, // [!code focus]
129129
});

‎src/references/iapp-generator/sdk/getResultFromCompletedTask.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Method to get the result of a completed task.
1616
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
1717

1818
const web3Provider = getWeb3Provider('PRIVATE_KEY');
19-
const dataProtectorCore = new IExecIApp(web3Provider);
19+
const iapp = new IExecIApp(web3Provider);
2020
// ---cut---
21-
const completedTaskResult = await dataProtectorCore.getResultFromCompletedTask({
21+
const completedTaskResult = await iapp.getResultFromCompletedTask({
2222
taskId: '0x7ac398...',
2323
});
2424
```
@@ -39,9 +39,9 @@ Address of the task ID data you'd like to get the result from.
3939
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
4040

4141
const web3Provider = getWeb3Provider('PRIVATE_KEY');
42-
const dataProtectorCore = new IExecIApp(web3Provider);
42+
const iapp = new IExecIApp(web3Provider);
4343
// ---cut---
44-
const completedTaskResult = await dataProtectorCore.getResultFromCompletedTask({
44+
const completedTaskResult = await iapp.getResultFromCompletedTask({
4545
taskId: '0x7ac398...', // [!code focus]
4646
});
4747
```
@@ -58,9 +58,9 @@ you, and only the desired file will be given as the `result`.
5858
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
5959

6060
const web3Provider = getWeb3Provider('PRIVATE_KEY');
61-
const dataProtectorCore = new IExecIApp(web3Provider);
61+
const iapp = new IExecIApp(web3Provider);
6262
// ---cut---
63-
const completedTaskResult = await dataProtectorCore.getResultFromCompletedTask({
63+
const completedTaskResult = await iapp.getResultFromCompletedTask({
6464
taskId: '0x7ac398...',
6565
path: 'content', // [!code focus]
6666
});
@@ -80,9 +80,9 @@ encrypt the protected data.
8080
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
8181

8282
const web3Provider = getWeb3Provider('PRIVATE_KEY');
83-
const dataProtectorCore = new IExecIApp(web3Provider);
83+
const iapp = new IExecIApp(web3Provider);
8484
// ---cut---
85-
const completedTaskResult = await dataProtectorCore.getResultFromCompletedTask({
85+
const completedTaskResult = await iapp.getResultFromCompletedTask({
8686
taskId: '0x7ac398...',
8787
pemPrivateKey: '-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----', // [!code focus]
8888
});
@@ -102,10 +102,10 @@ import {
102102
} from '@mage-sombre/iapp';
103103

104104
const web3Provider = getWeb3Provider('PRIVATE_KEY');
105-
const dataProtectorCore = new IExecIApp(web3Provider);
105+
const iapp = new IExecIApp(web3Provider);
106106
// ---cut---
107107
const completedTaskResult =
108-
await dataProtectorCore.getResultFromCompletedTask({
108+
await iapp.getResultFromCompletedTask({
109109
taskId: '0x7ac398...',
110110
onStatusUpdate: ({ title, isDone }) => { // [!code focus]
111111
console.log(title, isDone); // [!code focus]

‎src/references/iapp-generator/sdk/grantAccess.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ protected data (or a designated list of protected data).
1919
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
2020

2121
const web3Provider = getWeb3Provider('PRIVATE_KEY');
22-
const dataProtectorCore = new IExecIApp(web3Provider);
22+
const iapp = new IExecIApp(web3Provider);
2323
// ---cut---
24-
const grantedAccess = await dataProtectorCore.grantAccess({
24+
const grantedAccess = await iapp.grantAccess({
2525
iapp: '0x123abc...',
2626
authorizedProtectedData: '0x456def...',
2727
authorizedUser: '0x789cba...',
@@ -49,9 +49,9 @@ The ethereum address of the iApp you wish to grant access to. **You must own thi
4949
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
5050

5151
const web3Provider = getWeb3Provider('PRIVATE_KEY');
52-
const dataProtectorCore = new IExecIApp(web3Provider);
52+
const iapp = new IExecIApp(web3Provider);
5353
// ---cut---
54-
const grantedAccess = await dataProtectorCore.grantAccess({
54+
const grantedAccess = await iapp.grantAccess({
5555
iapp: '0x123abc...', // [!code focus]
5656
authorizedProtectedData: '0x456def...',
5757
authorizedUser: '0x789cba...',
@@ -75,9 +75,9 @@ access for the `protectedData` each time you do so.
7575
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
7676

7777
const web3Provider = getWeb3Provider('PRIVATE_KEY');
78-
const dataProtectorCore = new IExecIApp(web3Provider);
78+
const iapp = new IExecIApp(web3Provider);
7979
// ---cut---
80-
const grantedAccess = await dataProtectorCore.grantAccess({
80+
const grantedAccess = await iapp.grantAccess({
8181
iapp: '0x123abc...',
8282
authorizedProtectedData: '0x456def...', // [!code focus]
8383
authorizedUser: '0x789cba...',
@@ -110,9 +110,9 @@ permission for the user to submit the protected data to the iApp.
110110
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
111111

112112
const web3Provider = getWeb3Provider('PRIVATE_KEY');
113-
const dataProtectorCore = new IExecIApp(web3Provider);
113+
const iapp = new IExecIApp(web3Provider);
114114
// ---cut---
115-
const grantedAccess = await dataProtectorCore.grantAccess({
115+
const grantedAccess = await iapp.grantAccess({
116116
iapp: '0x123abc...',
117117
authorizedProtectedData: '0x456def...',
118118
authorizedUser: '0x789cba...', // [!code focus]
@@ -146,9 +146,9 @@ The fee is paid to the owner of the iApp.
146146
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
147147

148148
const web3Provider = getWeb3Provider('PRIVATE_KEY');
149-
const dataProtectorCore = new IExecIApp(web3Provider);
149+
const iapp = new IExecIApp(web3Provider);
150150
// ---cut---
151-
const grantedAccess = await dataProtectorCore.grantAccess({
151+
const grantedAccess = await iapp.grantAccess({
152152
iapp: '0x123abc...',
153153
authorizedProtectedData: '0x456def...',
154154
authorizedUser: '0x789cba...',
@@ -191,9 +191,9 @@ the `grantAccess` method.
191191
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
192192

193193
const web3Provider = getWeb3Provider('PRIVATE_KEY');
194-
const dataProtectorCore = new IExecIApp(web3Provider);
194+
const iapp = new IExecIApp(web3Provider);
195195
// ---cut---
196-
const grantedAccess = await dataProtectorCore.grantAccess({
196+
const grantedAccess = await iapp.grantAccess({
197197
iapp: '0x123abc...',
198198
authorizedProtectedData: '0x456def...',
199199
authorizedUser: '0x789cba...',
@@ -213,9 +213,9 @@ Callback function to be notified at intermediate steps.
213213
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
214214

215215
const web3Provider = getWeb3Provider('PRIVATE_KEY');
216-
const dataProtectorCore = new IExecIApp(web3Provider);
216+
const iapp = new IExecIApp(web3Provider);
217217
// ---cut---
218-
const grantedAccess = await dataProtectorCore.grantAccess({
218+
const grantedAccess = await iapp.grantAccess({
219219
protectedData: '0x123abc...',
220220
authorizedApp: '0x456def...',
221221
authorizedUser: '0x789cba...',

‎src/references/iapp-generator/sdk/revokeAllAccess.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ all done.
2727
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
2828

2929
const web3Provider = getWeb3Provider('PRIVATE_KEY');
30-
const dataProtectorCore = new IExecIApp(web3Provider);
30+
const iapp = new IExecIApp(web3Provider);
3131
// ---cut---
32-
const revokeAllAccessResult = await dataProtectorCore.revokeAllAccess({
32+
const revokeAllAccessResult = await iapp.revokeAllAccess({
3333
iapp: '0x123abc...',
3434
authorizedProtectedData: '0x456def...',
3535
authorizedUser: '0x789cba...',
@@ -52,9 +52,9 @@ The address of the `iApp` subject to access revocation.
5252
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
5353

5454
const web3Provider = getWeb3Provider('PRIVATE_KEY');
55-
const dataProtectorCore = new IExecIApp(web3Provider);
55+
const iapp = new IExecIApp(web3Provider);
5656
// ---cut---
57-
const revokeAllAccessResult = await dataProtectorCore.revokeAllAccess({
57+
const revokeAllAccessResult = await iapp.revokeAllAccess({
5858
iapp: '0x123abc...', // [!code focus]
5959
});
6060
```
@@ -71,9 +71,9 @@ from the iApp, regardless of the protected data.
7171
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
7272

7373
const web3Provider = getWeb3Provider('PRIVATE_KEY');
74-
const dataProtectorCore = new IExecIApp(web3Provider);
74+
const iapp = new IExecIApp(web3Provider);
7575
// ---cut---
76-
const revokeAllAccessResult = await dataProtectorCore.revokeAllAccess({
76+
const revokeAllAccessResult = await iapp.revokeAllAccess({
7777
iapp: '0x123abc...',
7878
authorizedProtectedData: '0x456def...', // [!code focus]
7979
authorizedUser: '0x789cba...',
@@ -92,9 +92,9 @@ iApp, regardless of the authorized user.
9292
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
9393

9494
const web3Provider = getWeb3Provider('PRIVATE_KEY');
95-
const dataProtectorCore = new IExecIApp(web3Provider);
95+
const iapp = new IExecIApp(web3Provider);
9696
// ---cut---
97-
const revokeAllAccessResult = await dataProtectorCore.revokeAllAccess({
97+
const revokeAllAccessResult = await iapp.revokeAllAccess({
9898
iapp: '0x123abc...',
9999
authorizedProtectedData: '0x456def...',
100100
authorizedUser: '0x789cba...', // [!code focus]
@@ -112,9 +112,9 @@ Callback function to be notified at intermediate steps.
112112
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
113113

114114
const web3Provider = getWeb3Provider('PRIVATE_KEY');
115-
const dataProtectorCore = new IExecIApp(web3Provider);
115+
const iapp = new IExecIApp(web3Provider);
116116
// ---cut---
117-
const revokeAllAccessResult = await dataProtectorCore.revokeAllAccess({
117+
const revokeAllAccessResult = await iapp.revokeAllAccess({
118118
iapp: '0x123abc...',
119119
authorizedProtectedData: '0x456def...',
120120
authorizedUser: '0x789cba...',

‎src/references/iapp-generator/sdk/revokeOneAccess.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ method.
2727
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
2828

2929
const web3Provider = getWeb3Provider('PRIVATE_KEY');
30-
const dataProtectorCore = new IExecIApp(web3Provider);
30+
const iapp = new IExecIApp(web3Provider);
3131
// ---cut---
32-
const revokeAccess = await dataProtectorCore.revokeOneAccess({
32+
const revokeAccess = await iapp.revokeOneAccess({
3333
app: '0xea...',
3434
appprice: '0',
3535
volume: '1',
@@ -60,9 +60,9 @@ This is the complete `granted access` object retrieved from an invocation of
6060
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
6161

6262
const web3Provider = getWeb3Provider('PRIVATE_KEY');
63-
const dataProtectorCore = new IExecIApp(web3Provider);
63+
const iapp = new IExecIApp(web3Provider);
6464
// ---cut---
65-
const revokeAccess = await dataProtectorCore.revokeOneAccess({
65+
const revokeAccess = await iapp.revokeOneAccess({
6666
app: '0xea...', // [!code focus]
6767
appprice: '0', // [!code focus]
6868
volume: '1', // [!code focus]

0 commit comments

Comments
 (0)