feat(docs): DIP1: Extract Explanations (AztecProtocol#4228)

[ x ] Learn / Concepts section more organized [ x ] Take explanations out of Build/dev docs into Concepts/Learn section and link to it --------- Co-authored-by: José Pedro Sousa <jose@aztecprotocol.com>
Swoir · Jan 29, 2024 · 3b25737 · 3b25737
1 parent 8338f39
commit 3b25737
Show file tree

Hide file tree

Showing 175 changed files with 3,891 additions and 451 deletions.
diff --git a/docs/docs/about_aztec/history/differences_to_aztec_connect.md b/docs/docs/about_aztec/history/differences_to_aztec_connect.md
diff --git a/docs/docs/concepts/advanced/circuits/kernels/main.md b/docs/docs/concepts/advanced/circuits/kernels/main.md
diff --git a/docs/docs/concepts/advanced/data_structures/main.md b/docs/docs/concepts/advanced/data_structures/main.md
diff --git a/docs/docs/concepts/advanced/main.md b/docs/docs/concepts/advanced/main.md
diff --git a/docs/docs/dev_docs/getting_started/core-concepts.md b/docs/docs/dev_docs/getting_started/core-concepts.md
diff --git a/docs/docs/developers/apis/accounts/_category_.yml b/docs/docs/developers/apis/accounts/_category_.yml
@@ -0,0 +1 @@
+label: "API"
diff --git a/docs/docs/developers/apis/accounts/classes/_category_.yml b/docs/docs/developers/apis/accounts/classes/_category_.yml
@@ -0,0 +1,2 @@
+label: "Classes"
+position: 3
diff --git a/docs/docs/developers/apis/accounts/classes/defaults.DefaultAccountContract.md b/docs/docs/developers/apis/accounts/classes/defaults.DefaultAccountContract.md
@@ -0,0 +1,112 @@
+---
+id: "defaults.DefaultAccountContract"
+title: "Class: DefaultAccountContract"
+sidebar_label: "DefaultAccountContract"
+custom_edit_url: null
+---
+
+[defaults](../modules/defaults.md).DefaultAccountContract
+
+Base class for implementing an account contract. Requires that the account uses the
+default entrypoint method signature.
+
+## Hierarchy
+
+- **`DefaultAccountContract`**
+
+  ↳ [`EcdsaAccountContract`](ecdsa.EcdsaAccountContract.md)
+
+  ↳ [`SchnorrAccountContract`](schnorr.SchnorrAccountContract.md)
+
+  ↳ [`SingleKeyAccountContract`](single_key.SingleKeyAccountContract.md)
+
+## Implements
+
+- `AccountContract`
+
+## Constructors
+
+### constructor
+
+• **new DefaultAccountContract**(`artifact`): [`DefaultAccountContract`](defaults.DefaultAccountContract.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `artifact` | `ContractArtifact` |
+
+#### Returns
+
+[`DefaultAccountContract`](defaults.DefaultAccountContract.md)
+
+## Properties
+
+### artifact
+
+• `Private` **artifact**: `ContractArtifact`
+
+## Methods
+
+### getAuthWitnessProvider
+
+▸ **getAuthWitnessProvider**(`address`): `AuthWitnessProvider`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `address` | `CompleteAddress` |
+
+#### Returns
+
+`AuthWitnessProvider`
+
+___
+
+### getContractArtifact
+
+▸ **getContractArtifact**(): `ContractArtifact`
+
+#### Returns
+
+`ContractArtifact`
+
+#### Implementation of
+
+AccountContract.getContractArtifact
+
+___
+
+### getDeploymentArgs
+
+▸ **getDeploymentArgs**(): `any`[]
+
+#### Returns
+
+`any`[]
+
+#### Implementation of
+
+AccountContract.getDeploymentArgs
+
+___
+
+### getInterface
+
+▸ **getInterface**(`address`, `nodeInfo`): `AccountInterface`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `address` | `CompleteAddress` |
+| `nodeInfo` | `NodeInfo` |
+
+#### Returns
+
+`AccountInterface`
+
+#### Implementation of
+
+AccountContract.getInterface
diff --git a/docs/docs/developers/apis/accounts/classes/defaults.DefaultAccountEntrypoint.md b/docs/docs/developers/apis/accounts/classes/defaults.DefaultAccountEntrypoint.md
@@ -0,0 +1,88 @@
+---
+id: "defaults.DefaultAccountEntrypoint"
+title: "Class: DefaultAccountEntrypoint"
+sidebar_label: "DefaultAccountEntrypoint"
+custom_edit_url: null
+---
+
+[defaults](../modules/defaults.md).DefaultAccountEntrypoint
+
+Implementation for an entrypoint interface that follows the default entrypoint signature
+for an account, which accepts an EntrypointPayload as defined in noir-libs/aztec-noir/src/entrypoint.nr.
+
+## Implements
+
+- `EntrypointInterface`
+
+## Constructors
+
+### constructor
+
+• **new DefaultAccountEntrypoint**(`address`, `auth`, `chainId?`, `version?`): [`DefaultAccountEntrypoint`](defaults.DefaultAccountEntrypoint.md)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `address` | `AztecAddress` | `undefined` |
+| `auth` | `AuthWitnessProvider` | `undefined` |
+| `chainId` | `number` | `DEFAULT_CHAIN_ID` |
+| `version` | `number` | `DEFAULT_VERSION` |
+
+#### Returns
+
+[`DefaultAccountEntrypoint`](defaults.DefaultAccountEntrypoint.md)
+
+## Properties
+
+### address
+
+• `Private` **address**: `AztecAddress`
+
+___
+
+### auth
+
+• `Private` **auth**: `AuthWitnessProvider`
+
+___
+
+### chainId
+
+• `Private` **chainId**: `number` = `DEFAULT_CHAIN_ID`
+
+___
+
+### version
+
+• `Private` **version**: `number` = `DEFAULT_VERSION`
+
+## Methods
+
+### createTxExecutionRequest
+
+▸ **createTxExecutionRequest**(`executions`): `Promise`\<`TxExecutionRequest`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `executions` | `FunctionCall`[] |
+
+#### Returns
+
+`Promise`\<`TxExecutionRequest`\>
+
+#### Implementation of
+
+EntrypointInterface.createTxExecutionRequest
+
+___
+
+### getEntrypointAbi
+
+▸ **getEntrypointAbi**(): `FunctionAbi`
+
+#### Returns
+
+`FunctionAbi`