Skip to content
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 2 commits into from
Sep 25, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/_data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ sidebar-list:
children:
- title: Encrypted Ethereum
url: what-is-obscuro/encrypted-ethereum
- title: Developer quick start
url: what-is-obscuro/quick-start
- title: Technology
url: what-is-obscuro/technology
- title: User Experience
Expand All @@ -39,6 +41,8 @@ sidebar-list:
url: testnet/deploying-a-smart-contract-programmatically
- title: Change Log
url: testnet/changelog
- title: Security
url: testnet/security

- title: On Chain Capabilities
children:
Expand Down
10 changes: 10 additions & 0 deletions docs/_docs/testnet/security.md
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.
29 changes: 29 additions & 0 deletions docs/_docs/what-is-obscuro/quick-start.md
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._
18 changes: 16 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@
<img src="assets\images\build-with-encryption.jpg">
</p>

Welcome to Obscuro. Obscuro hyper-scales and encrypts Ethereum. No SDKs, 100% EVM.
Welcome to Obscuro - the first Ethereum L2 with private smart contract state.

On this docsite you will find useful guidance on Obscuro, how to participate in the Testnet and, if you want to go deeper, read the whitepaper using the menu above. A PDF version of the whitepaper is [available](https://whitepaper.obscu.ro/assets/images/obscuro-whitepaper-0-10-0.pdf).
Obscuro hyper-scales and encrypts Ethereum. No SDKs, 100% EVM.
Copy link
Contributor

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)


On this docsite you will find useful guidance on Obscuro, how to participate in the Testnet and, if you want to go deeper, read the whitepaper using the menu above.

The Litepaper is available to view [here](https://obscu.ro/litepaper).

A PDF version of the whitepaper is available [here](https://whitepaper.obscu.ro/assets/images/obscuro-whitepaper-0-10-0.pdf).


## Useful Resources

1. [Github](https://github.com/obscuronet/go-obscuro)
2. [Twitter](https://twitter.com/obscuronet/)
3. [Discord](https://discord.gg/7pkKv2Tyfn)
4. [Blog](https://medium.com/obscuro-labs)