Skip to content

Commit

Permalink
fixing conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
signorecello committed May 17, 2024
1 parent 1eb4b73 commit c89fa0b
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 27 deletions.
14 changes: 5 additions & 9 deletions docs/docs/aztec/concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,7 @@ Private state works with UTXOs, or what we call notes. To keep things private, e

Public state works similarly to other chains like Ethereum, behaving like a public ledger. Public data is stored in a [public data tree](/aztec/concepts/storage/trees/index.md#public-state-tree).

<<<<<<< HEAD:docs/docs/aztec/aztec/concepts/index.md
Aztec [smart contract](/aztec/aztec/concepts/smart_contracts/index.md) developers should keep in mind that different types are used when manipulating private or public state. Working with private state is creating commitments and nullifiers to state, whereas working with public state is directly updating state.
=======
Aztec [smart contract](/aztec/concepts/smart_contracts/index.md) developers should keep in mind that different types are used when manipulating private or public state. Working with private state is creating commitments and nullifiers to state, whereas working with public state is directly updating state.
>>>>>>> fd81464071 (removing nested folders):docs/docs/aztec/concepts/index.md

## Accounts

Expand All @@ -55,12 +51,7 @@ Aztec allows private communications with Ethereum - ie no-one knows where the tr

This is achieved through portals - these are smart contracts deployed on an EVM that are related to the Ethereum smart contract you want to interact with.

<<<<<<< HEAD:docs/docs/aztec/aztec/concepts/index.md
Learn more about portals [here](/protocol-specs/l1-smart-contracts/index.md).
=======
Learn more about portals [here](/aztec/concepts/smart_contracts/communication/cross_chain_calls).
>>>>>>> fd81464071 (removing nested folders):docs/docs/aztec/concepts/index.md
## Circuits

Aztec operates on three types of circuits:
Expand All @@ -79,9 +70,14 @@ Explore the Concepts for a deeper understanding into the components that make up

### Start coding

<<<<<<< HEAD
<<<<<<< HEAD:docs/docs/aztec/aztec/concepts/index.md
Follow the [developer getting started guide](/getting_started/getting_started).
=======
Follow the [developer getting started guide](/getting_started).

>>>>>>> fd81464071 (removing nested folders):docs/docs/aztec/concepts/index.md
=======
Follow the [developer getting started guide](/getting_started).

>>>>>>> 02be02cbcb (fixing conflicts)
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ See [Private \<--\> Public execution](./public_private_calls.md) for information

## Cross-chain communication

Read the protocol specification about Cross-chain communication between Aztec and Ethereum [here](../../../../../protocol-specs/l1-smart-contracts/index.md).
Read the protocol specification about Cross-chain communication between Aztec and Ethereum [here](/protocol-specs/l1-smart-contracts/index.md).

This file was deleted.

7 changes: 7 additions & 0 deletions docs/docs/guides/smart_contracts/writing_contracts/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Portals
---

A portal is a point of contact between L1 and a contract on Aztec. For applications such as token bridges, this is the point where the tokens are held on L1 while used in L2.

As outlined in [Communication](/protocol-specs/l1-smart-contracts/index.md), an Aztec L2 contract does not have to be linked to a portal contract, but can specify an intended portal in storage. Note, that a portal doesn't actually need to be a contract, it could be any address on L1.
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Note that while the `secret` and the `content` are both hashed, they are actuall

### Token bridge example

Computing the `content` must currently be done manually, as we are still adding a number of bytes utilities. A good example exists within the [Token bridge example](../../../../../tutorials/tutorials/contract_tutorials/advanced/token_bridge/minting_on_aztec.md#consume-the-l1-message).
Computing the `content` must currently be done manually, as we are still adding a number of bytes utilities. A good example exists within the [Token bridge example](/tutorials/contract_tutorials/advanced/token_bridge/minting_on_aztec.md#consume-the-l1-message).

#include_code claim_public /noir-projects/noir-contracts/contracts/token_bridge_contract/src/main.nr rust

Expand Down
9 changes: 5 additions & 4 deletions docs/docs/reference/sandbox_reference/sandbox-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,13 @@ title: Sandbox Reference

:::tip

For a quick start, follow the [guide](/getting_started) to install the sandbox.
For a quick start, follow the [guide](/getting_started.md) to install the sandbox.

:::

## Manual Install

<<<<<<< HEAD:docs/docs/reference/reference/sandbox_reference/sandbox-reference.md
You can manually install the sandbox via the underlying script used in the [Aztec Boxes](getting_started/getting_started/index.md#run-the-npx-script).
=======

You can manually install the sandbox via the underlying script used in the [Aztec Boxes](/getting_started.md#run-the-npx-script).

### Prerequisites
Expand Down Expand Up @@ -66,6 +64,9 @@ In the terminal, you will see some logs:
You can manually install the sandbox via the underlying script used in the [Aztec Boxes](/getting_started.md#run-the-npx-script).
>>>>>>> fd81464071 (removing nested folders):docs/docs/reference/sandbox_reference/sandbox-reference.md
=======
You can manually install the sandbox via the underlying script used in the [Aztec Boxes](getting_started.md#run-the-npx-script).
>>>>>>> 02be02cbcb (fixing conflicts)
### Prerequisites
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,7 @@ title: Token Bridge

import Image from "@theme/IdealImage";

<<<<<<< HEAD:docs/docs/tutorials/tutorials/contract_tutorials/advanced/token_bridge/index.md
In this tutorial, we will learn how to build the entire flow of a cross-chain token using portals. If this is your first time hearing the word portal, you’ll want to read [this](/protocol-specs/l1-smart-contracts/index.md).
=======
In this tutorial, we will learn how to build the entire flow of a cross-chain token using portals. If this is your first time hearing the word portal, you’ll want to read [this](/aztec/concepts/smart_contracts/communication/cross_chain_calls).
>>>>>>> fd81464071 (removing nested folders):docs/docs/tutorials/contract_tutorials/advanced/token_bridge/index.md

## A refresher on Portals

Expand Down Expand Up @@ -39,11 +35,15 @@ Aztec has the following core smart contracts on L1 that we need to know about:
- `Outbox.sol` - a mailbox to the rollup for L2 to L1 messages (e.g. withdrawing tokens). Aztec contracts emit these messages and the sequencer adds these to the outbox. Portals then consume these messages.
- `Registry.sol` - just like L1, we assume there will be various versions of Aztec (due to upgrades, forks etc). In such a case messages must not be replayable in other Aztec “domains”. A portal must decide which version/ID of Aztec the message is for. The registry stores the rollup, inbox and outbox address for each version of Aztec deployments, so the portal can find out the address of the mailbox it wants to talk to

<<<<<<< HEAD
<<<<<<< HEAD:docs/docs/tutorials/tutorials/contract_tutorials/advanced/token_bridge/index.md
For more information, read [cross-chain calls](/protocol-specs/l1-smart-contracts/index.md).
=======
For more information, read [cross-chain calls](/aztec/concepts/smart_contracts/communication/cross_chain_calls).
>>>>>>> fd81464071 (removing nested folders):docs/docs/tutorials/contract_tutorials/advanced/token_bridge/index.md
=======
For more information, read [cross-chain calls](/protocol-specs/l1-smart-contracts/index.md).
>>>>>>> 02be02cbcb (fixing conflicts)
## Building a Token Bridge with Portals

Expand Down
2 changes: 1 addition & 1 deletion docs/scripts/move_processed.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
#!/usr/bin/env bash

echo "label: \"AztecJS\"" > ./docs/reference/aztecjs/_category_.yml
mv ./docs/reference/aztecjs ./processed-docs/reference/aztecjs

0 comments on commit c89fa0b

Please sign in to comment.