-
Notifications
You must be signed in to change notification settings - Fork 39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
small doc changes #1547
Merged
Merged
small doc changes #1547
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
--- | ||
# Testnet Security | ||
|
||
The first Obscuro Testnet is focused on functionality and the User and Developer experience. | ||
|
||
Privacy features require special attention from the core and security audit team and will be finalised in a | ||
future version of Testnet. | ||
|
||
As a user of the "Obscuro Testnet", do not expect the data you are loading to be 100% private. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
--- | ||
# Developer quick start | ||
|
||
The only difference between an Obscuro and an Ethereum (or Arbitrum) dApp is that on Obscuro you can hide the internal | ||
state of the contract. | ||
|
||
The most obvious example is that an ERC20 token deployed on Obscuro will not respond to balance requests unless you are | ||
the account owner. | ||
|
||
In Obscuro, the internal node database is encrypted, and the contract execution is also encrypted inside the TEE. | ||
The calls to [getStorageAt](https://docs.alchemy.com/reference/eth-getstorageat) are disabled, so all data access | ||
requests will be performed through view functions which are under the control of the smart contract developer. | ||
|
||
Nobody (which includes node operators and the sequencer) can access the internal state of a contract. | ||
|
||
**The only thing you have to do when porting a dApp to Obscuro is to add a check in your view functions comparing | ||
the `tx.origing` and `msg.sender` against the accounts allowed to access that data.** | ||
|
||
The snippet below illustrates this for an [ERC20 token](https://github.com/obscuronet/sample-applications/blob/main/number-guessing-game/contracts/ERC20.sol#L25). | ||
|
||
```solidity | ||
function balanceOf(address tokenOwner) public view override returns (uint256) { | ||
require(tx.origin == tokenOwner || msg.sender == tokenOwner, "Only the token owner can see the balance."); | ||
return balances[tokenOwner]; | ||
} | ||
``` | ||
|
||
_Note that this works because in Obscuro all calls to view functions are authenticated._ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe don't mention "no SDKS", for some reason it triggers people (like at the workshop).
Either way, add 100% Solidity too as this is one of our key USPs (no new languages to learn)