Skip to content

Commit dd8773b

Browse files
gregnazariogregnazario
authored
Merge branch 'main' into igor/maps_docs
2 parents 55c81dd + f9865d1 commit dd8773b

File tree

5 files changed

+11
-17
lines changed

5 files changed

+11
-17
lines changed

‎apps/nextra/pages/en/build/indexer/indexer-sdk/documentation/create-processor.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { IndexerBetaNotice } from '@components/index';
99
This guide will walk you through setting up the basic template for a new processor.
1010

1111
## Pre-requisites
12-
You've already set up your environment and have the Indexer SDK `aptos-indexer-sdk` and `aptos-indexer-sdk-server-framework` installed.
12+
You've already set up your environment and have the Indexer SDK `aptos-indexer-sdk` installed.
1313
If you haven't, follow the [Indexer SDK installation guide](./setup.mdx).
1414

1515
## Overview
@@ -25,9 +25,9 @@ The next section goes through each of these pieces more explicitly and provides
2525
The `IndexerProcessorConfig` defines the base configuration for all processors that you'll be running.
2626
It should include configuration for things that are shared across multiple processors, like the database configuration and [Transaction Stream](../../txn-stream.mdx) configuration.
2727

28-
[`ServerArgs`](https://github.com/aptos-labs/aptos-indexer-processor-sdk/blob/main/aptos-indexer-processors-sdk/sdk-server-framework/src/lib.rs#L26) parses a `config.yaml` file and bootstraps a server with all the common pieces to run a processor.
28+
`ServerArgs` parses a `config.yaml` file and bootstraps a server with all the common pieces to run a processor.
2929

30-
To setup the configuration for your processor and make it work with `ServerArgs`, you'll need to define a `IndexerProcessorConfig` that implements the [`RunnableConfig`](https://github.com/aptos-labs/aptos-indexer-processor-sdk/blob/main/aptos-indexer-processors-sdk/sdk-server-framework/src/lib.rs#L102) trait.
30+
To setup the configuration for your processor and make it work with `ServerArgs`, you'll need to define a `IndexerProcessorConfig` that implements the `RunnableConfig` trait.
3131
It also triggers a run method, which can be invoked in `main.rs`.
3232

3333
For basic cases, you can copy the [`IndexerProcessorConfig` from the `aptos-indexer-processor-example`](https://github.com/aptos-labs/aptos-indexer-processor-example/blob/main/aptos-indexer-processor-example/src/config/indexer_processor_config.rs) repository and modify it to fit your needs.

‎apps/nextra/pages/en/build/indexer/indexer-sdk/documentation/setup.mdx

+5-10
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,15 @@ The quickstart guide provides a template processor and includes all of this setu
99

1010
If you're migrating an existing processor to the Indexer SDK, follow the steps below.
1111

12-
The Indexer SDK provides several Rust crates:
13-
1. [`aptos-indexer-processor-sdk`](https://github.com/aptos-labs/aptos-indexer-processor-sdk/tree/main/aptos-indexer-processors-sdk/sdk) - The core SDK that provides the building blocks for writing a processor.
14-
2. [`aptos-indexer-processor-sdk-server-framework`](https://github.com/aptos-labs/aptos-indexer-processor-sdk/tree/main/aptos-indexer-processors-sdk/sdk-server-framework) - A server framework for creating a server that runs the processor and includes health checks and metrics logging probes.
15-
If you're setting up a server to host your processor, you will need to include this crate.
16-
3. [`aptos-indexer-testing-framework`](https://github.com/aptos-labs/aptos-indexer-processor-sdk/tree/main/aptos-indexer-processors-sdk/testing-framework) - An e2e testing framework for testing processors.
17-
If you want to write tests for your processor, you will need to include this crate.
18-
19-
Depending on your use case, you can import the crates to your `Cargo.toml`.
12+
Add `aptos-indexer-processor-sdk` to your `Cargo.toml`.
2013

2114
```toml
2215
[dependencies]
2316
aptos-indexer-processor-sdk = { git = "https://github.com/aptos-labs/aptos-indexer-processor-sdk.git", rev = "aptos-indexer-processor-sdk-v1.0.0" }
24-
aptos-indexer-processor-sdk-server-framework = { git = "https://github.com/aptos-labs/aptos-indexer-processor-sdk.git", rev = "aptos-indexer-processor-sdk-v1.0.0" }
25-
aptos-indexer-testing-framework = { git = "https://github.com/aptos-labs/aptos-indexer-processor-sdk.git", rev = "aptos-indexer-processor-sdk-v1.0.0" }
2617
```
2718

19+
`aptos-indexer-processor-sdk` includes the following features:
20+
1. `postgres_full` - Interface layer to integrate Postgres with your processor.
21+
2. `testing_framework` - An e2e testing framework for testing processors. If you want to write tests for your processor, add this feature to the crate.
22+
2823
{/* <!-- Add list of SDK releases once we have that --> */}

‎apps/nextra/pages/en/build/smart-contracts/cryptography.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ For more use cases of the `crypto_algebra` module, check out some Move examples:
207207

208208
### Veiled coins
209209

210-
The [`veiled_coin` example](https://github.com/aptos-labs/aptos-core/tree/main/aptos-move/move-examples/veiled_coin/sources) demonstrates how to use [the Ristretto255 modules from above](#ristretto255-arithmetic) to add a reasonable layer of confidentiality to coin balances and transactions.
210+
The [`veiled_coin` example](https://github.com/aptos-labs/aptos-core/tree/main/aptos-move/framework-experimental/veiled_coin) demonstrates how to use [the Ristretto255 modules from above](#ristretto255-arithmetic) to add a reasonable layer of confidentiality to coin balances and transactions.
211211

212212
Specifically, users can **veil** their balance, keeping it hidden from everyone, including validators.
213213
Furthermore, a user can send a **veiled transaction** that hides the transaction amount from everybody, including validators.

‎apps/nextra/pages/en/network/blockchain/txns-states.mdx

+1-2
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,8 @@ A signed transaction on the blockchain contains the following information:
5151
- **Sender public key**: The public authentication key that corresponds to the private authentication key used to sign the transaction.
5252
- **Payload**: Indicates an action or set of actions Alice's behalf. In the case this is a Move function, it directly calls into Move bytecode on the chain. Alternatively, it may be Move bytecode peer-to-peer [transaction script](../glossary.mdx#transaction-script). It also contains a list of inputs to the function or script. For this example, it is a function call to transfer an amount of Aptos Coins from Alice account to Bob's account, where Alice's account is implied by sending the transaction and Bob's account and the amount are specified as transaction inputs.
5353
- [**Gas unit price**](../glossary.mdx#gas-unit-price): The amount the sender is willing to pay per unit of gas, to execute the transaction. This is represented in [Octas](../glossary.mdx#octa).
54-
- [**Maximum gas amount**](../glossary.mdx#maximum-gas-amount): The maximum gas amount in APT the sender is willing to pay for this transaction. Gas charges are equal to the base gas cost covered by computation and IO multiplied by the gas price. Gas costs also include storage with an APT-fixed priced storage model. This is represented as [Octas](../glossary.mdx#octa).
54+
- [**Maximum gas amount**](../glossary.mdx#maximum-gas-amount): The [maximum gas amount](gas-txn-fee.mdx#specifying-gas-fees-within-a-transaction) in APT the sender is willing to pay for this transaction. Gas charges are equal to the base gas cost covered by computation and IO multiplied by the gas price. Gas costs also include storage with an APT-fixed priced storage model. This is represented as [Octas](../glossary.mdx#octa).
5555
- **Gas price** (in specified gas units): This is the amount the sender is willing to pay per unit of [gas](gas-txn-fee.mdx) to execute the transaction. [Gas](gas-txn-fee.mdx) is a way to pay for computation and storage. A gas unit is an abstract measurement of computation with no inherent real-world value.
56-
- **Maximum gas amount**: The [maximum gas amount](gas-txn-fee.mdx#specifying-gas-fees-within-a-transaction) is the maximum gas units the transaction is allowed to consume.
5756
- **Sequence number**: This is an unsigned integer that must be equal to the sender's account [sequence number](accounts.mdx#account-sequence-number) at the time of execution.
5857
- **Expiration time**: A timestamp after which the transaction ceases to be valid (i.e., expires).
5958

‎apps/nextra/pages/zh/build/smart-contracts/cryptography.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ For more use cases of the `crypto_algebra` module, check out some Move examples:
207207

208208
### Veiled coins
209209

210-
The [`veiled_coin` example](https://github.com/aptos-labs/aptos-core/tree/main/aptos-move/move-examples/veiled_coin/sources) demonstrates how to use [the Ristretto255 modules from above](#ristretto255-arithmetic) to add a reasonable layer of confidentiality to coin balances and transactions.
210+
The [`veiled_coin` example](https://github.com/aptos-labs/aptos-core/tree/main/aptos-move/framework-experimental/veiled_coin) demonstrates how to use [the Ristretto255 modules from above](#ristretto255-arithmetic) to add a reasonable layer of confidentiality to coin balances and transactions.
211211

212212
Specifically, users can **veil** their balance, keeping it hidden from everyone, including validators.
213213
Furthermore, a user can send a **veiled transaction** that hides the transaction amount from everybody, including validators.

0 commit comments

Comments
 (0)