Skip to content

Commit 841ed30

Browse files
committed
fix(docs): update transferOwnership and types documentation to reflect iApp terminology
1 parent d34e91f commit 841ed30

File tree

2 files changed

+22
-22
lines changed

2 files changed

+22
-22
lines changed

src/references/iapp-generator/sdk/transferOwnership.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
22
title: transferOwnership
33
description:
4-
Transfer ownership of protected data to a new owner with iExec's
5-
transferOwnership method. Securely update data ownership and automatically
4+
Transfer ownership of an iApp to a new owner with iExec's
5+
transferOwnership method. Securely update iApp ownership and automatically
66
revoke previous access permissions.
77
---
88

99
# transferOwnership
1010

11-
Allows transferring ownership of a `protectedData` entity to a new owner,
11+
Allows transferring ownership of an `iApp` entity to a new owner,
1212
identified by their ETH address. The return value provides a transaction hash
13-
and confirmation of the new owner of the `protectedData`. Only the current owner
14-
of the `protectedData` may invoke this method.
13+
and confirmation of the new owner of the `iApp`. Only the current owner
14+
of the `iApp` may invoke this method.
1515

16-
When transferring the `protectedData`, the grantedAccess created by the previous
16+
When transferring the `iApp`, the grantedAccess created by the previous
1717
owner are revoked automatically.
1818

19-
Ownership of the `protectedData` can be renounced by transferring it to the burn
19+
Ownership of the `iApp` can be renounced by transferring it to the burn
2020
address `0x000000000000000000000000000000000000dEaD`.
2121

2222
## Usage
@@ -28,7 +28,7 @@ const web3Provider = getWeb3Provider('PRIVATE_KEY');
2828
const dataProtectorCore = new IExecIApp(web3Provider);
2929
// ---cut---
3030
const transferResponse = await dataProtectorCore.transferOwnership({
31-
protectedData: '0x123abc...',
31+
iapp: '0x123abc...',
3232
newOwner: '0xc5e9f4...',
3333
});
3434
```
@@ -39,11 +39,11 @@ const transferResponse = await dataProtectorCore.transferOwnership({
3939
import { type TransferParams } from '@mage-sombre/iapp';
4040
```
4141

42-
### protectedData <RequiredBadge />
42+
### iapp <RequiredBadge />
4343

4444
**Type:** `AddressOrENS`
4545

46-
ETH address of the `protectedData` owned by you which is to be transferred to a
46+
ETH address of the `iApp` owned by you which is to be transferred to a
4747
new owner.
4848

4949
```ts twoslash
@@ -53,7 +53,7 @@ const web3Provider = getWeb3Provider('PRIVATE_KEY');
5353
const dataProtectorCore = new IExecIApp(web3Provider);
5454
// ---cut---
5555
const transferResponse = await dataProtectorCore.transferOwnership({
56-
protectedData: '0x123abc...', // [!code focus]
56+
iapp: '0x123abc...', // [!code focus]
5757
newOwner: '0xc5e9f4...',
5858
});
5959
```
@@ -62,7 +62,7 @@ const transferResponse = await dataProtectorCore.transferOwnership({
6262

6363
**Type:** `AddressOrENS`
6464

65-
ETH address for the new owner for the `protectedData`.
65+
ETH address for the new owner for the `iApp`.
6666

6767
```ts twoslash
6868
import { IExecIApp, getWeb3Provider } from '@mage-sombre/iapp';
@@ -71,7 +71,7 @@ const web3Provider = getWeb3Provider('PRIVATE_KEY');
7171
const dataProtectorCore = new IExecIApp(web3Provider);
7272
// ---cut---
7373
const transferResponse = await dataProtectorCore.transferOwnership({
74-
protectedData: '0x123abc...',
74+
iapp: '0x123abc...',
7575
newOwner: '0xc5e9f4...', // [!code focus]
7676
});
7777
```
@@ -89,13 +89,13 @@ objects contain the three fields:
8989

9090
`Address`
9191

92-
The ETH address of the `protectedData` you transferred.
92+
The ETH address of the `iApp` you transferred.
9393

9494
### to
9595

9696
`AddressOrENS`
9797

98-
The ETH address of the new owner of the `protectedData`.
98+
The ETH address of the new owner of the `iApp`.
9999

100100
### txHash
101101

src/references/iapp-generator/sdk/types.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Types
33
description:
4-
Complete reference for iApp types including GrantedAccess,
5-
ProtectedData, Collection, and other essential data structures.
4+
Complete reference for iApp Generator SDK types including GrantedAccess,
5+
IApp and other essential data structures.
66
---
77

88
# Types
99

10-
Types in DataProtector.
10+
Types in iApp Generator SDK.
1111

1212
## 🔑 GrantedAccess
1313

@@ -30,18 +30,18 @@ Types in DataProtector.
3030

3131
### tag: <span class="text-yellow">`string`</span>
3232

33-
- Defines whether a `protectedData` is usable in a TEE environment; `0x00` is
33+
- Defines whether an `iApp` is usable in a TEE environment; `0x00` is
3434
TEE while `0x03` is non-TEE
3535

3636
### datasetrestrict: <span class="text-yellow">`string`</span>
3737

3838
- Address of the authorized protected data; a value of 0x0 indicates any
39-
protected data may run with this iapp
39+
protected data may run with this iApp
4040

4141
### requesterrestrict: <span class="text-yellow">`string`</span>
4242

43-
- Address of the requester authorized to run this `iapp` in workloads;
44-
a value of 0x0 indicates any requester may use this data
43+
- Address of the requester authorized to run this `iApp` in workloads;
44+
a value of 0x0 indicates any requester may use this iApp
4545

4646
### workerpoolrestrict: <span class="text-yellow">`string`</span>
4747

0 commit comments

Comments
 (0)