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

feat(docs): DIP1: Extract Explanations #4228

Merged
merged 8 commits into from
Jan 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
15 changes: 0 additions & 15 deletions docs/docs/about_aztec/history/differences_to_aztec_connect.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/docs/concepts/advanced/circuits/kernels/main.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/docs/concepts/advanced/data_structures/main.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/docs/concepts/advanced/main.md

This file was deleted.

88 changes: 0 additions & 88 deletions docs/docs/dev_docs/getting_started/core-concepts.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/docs/developers/apis/accounts/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
label: "API"
2 changes: 2 additions & 0 deletions docs/docs/developers/apis/accounts/classes/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
label: "Classes"
position: 3
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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`
Loading
Loading