Skip to content

Commit e901471

Browse files
asajgitbook-bot
authored andcommitted
GitBook: [#63] Minor tweaks to developers section
1 parent 380ed3e commit e901471

File tree

7 files changed

+24
-13
lines changed

7 files changed

+24
-13
lines changed

developers/advanced/connection-client.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Using an `AbacusConnectionManager` allows applications to migrate to a new Abacu
2424

2525
## Abacus Connection Client
2626

27-
``[`AbacusConnectionClient`](https://github.com/abacus-network/abacus-monorepo/blob/main/solidity/app/contracts/AbacusConnectionClient.sol) is a simple mix-in contract that application developers can inherit from in order to connect to Abacus.
27+
[`AbacusConnectionClient`](https://github.com/abacus-network/abacus-monorepo/blob/main/solidity/app/contracts/AbacusConnectionClient.sol) is a simple mix-in contract that application developers can inherit from in order to connect to Abacus.
2828

2929
This contract maintains a pointer to an `AbacusConnectionManager`. Application developers can choose to deploy their own connection manager, or point to an existing contract that's managed by an entity they trust.
3030

developers/advanced/message-encoding.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ description: Recommended approaches for encoding and decoding messages
44

55
# Message encoding
66

7-
Abacus cross-chain messages are encoded as raw byte arrays. In order to send and receive messages, developers should implement functions for encoding and decoding cross-chain messages. 
7+
Abacus interchain messages are encoded as raw byte arrays. In order to send and receive messages, developers should implement functions for encoding and decoding interchain messages. 
88

9-
In this section, we describe two recommended approaches and their trade-offs.
9+
In this section, we describe two recommended approaches and their tradeoffs.
1010

1111
### General
1212

13-
In most cases, we expect that developers are sending cross-chain messages in order to call a function on a contract on remote chain. For that, it is necessary to encode and decode raw bytes to an equivalent of a function call with arguments.
13+
In most cases, we expect that developers are sending interchain messages in order to call a function on a contract on remote chain. For that, it is necessary to encode and decode raw bytes to an equivalent of a function call with arguments.
1414

1515
#### ABI Encoding
1616

developers/advanced/router-pattern.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: A pattern for building interchain applications
66

77
While patterns and best practices will evolve over time, the Router pattern has emerged as a useful model for building interchain applications.
88

9-
The Router pattern allows developers to write application logic once while deploying it to many networks. Developers can leverage this pattern by inheriting from the [`Router.sol` mix-in contract](https://github.com/abacus-network/abacus-monorepo/blob/main/solidity/app/contracts/Router.sol), and implementing functions that send and receive messages to and from remote chains.
9+
It allows developers to write application logic once while deploying it to many networks. Developers can leverage this pattern by inheriting from the [`Router.sol` mix-in contract](https://github.com/abacus-network/abacus-monorepo/blob/main/solidity/app/contracts/Router.sol), and implementing functions that send and receive messages to and from remote chains.
1010

1111
Developers then deploy their contracts on each chain that they would like their application to support. Each contract must be made aware of their counterparts on all remote chains so that they can authenticate the messages that they send between each other.
1212

developers/environments/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Throughout the Abacus Code bases exist the concept of environments to facilitate the development and testing of changes, both of the Abacus core platform as well as applications building on top of Abacus. Environments also encode the set of domains/chains that are supported. This page outlines the purpose of each environment and how developers should think about them.
44

5-
### Environment: \`test\`
5+
### Environment: "test"
66

77
The `test` environment is meant for local development. Application developers can use the `@abacus-network/hardhat` plugin's `TestAbacusDeploy` object to deploy a mocked Abacus core platform. By calling `processMessages()`, developers can simulate the processing of messages across domains without having to run any of the Agents.
88

developers/environments/interaction-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ yarn add @abacus-network/sdk
1717
The `AbacusApp` abstraction is a mapping that resolves a network namespace to a collection of [ethers Contract](https://docs.ethers.io/v5/api/contract/contract/#Contract) instances on that network. A default implementation of this collection called [`AbacusContracts`](https://github.com/abacus-network/abacus-monorepo/blob/main/typescript/sdk/src/contracts.ts#L37) is provided which should satisfy most conceivable designs. This implementation ensures your contracts collections are attached to the appropriate network providers.
1818

1919
{% hint style="info" %}
20-
Please see the [Examples section](../examples/) for a demonstration of how to leverage the `AbacusApp` abstraction`.`
20+
Please see the [Examples section](../examples/) for a demonstration of how to leverage the`AbacusApp` abstraction.
2121
{% endhint %}
2222

2323
### Interact

developers/environments/multiprovider.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Manage node providers for Abacus supported networks in one plac
44

55
# MultiProvider
66

7-
 `MultiProvider` is a network utility used throughout the Abacus Application SDK. In essence, it is a mapping that resolves a network namespace to a configured node provider.
7+
`MultiProvider` is a network utility used throughout the Abacus Application SDK. In essence, it is a mapping that resolves a network namespace to a configured node provider.
88

99
### Configuration
1010

@@ -13,11 +13,11 @@ It has a simple interface for configuring target networks that are supported by
1313
```typescript
1414
const ethereum = {
1515
provider: new UrlJsonRpcProvider('http://localhost:8545/')
16-
}
16+
};
1717
const polygon = {
1818
provider: new UrlJsonRpcProvider('https://rpc-mainnet.matic.network'),
1919
confirmations: 10, // wait 10 blocks for finality
20-
}
20+
};
2121
const multiProvider = new MultiProvider({ ethereum, polygon });
2222
```
2323

@@ -40,8 +40,8 @@ import { ethers } from 'hardhat';
4040
const [signer] = await ethers.getSigners();
4141
const testMultiProvider = new MultiProvider({
4242
test1: { signer },
43-
test2: { signer }
44-
test3: { signer }
43+
test2: { signer },
44+
test3: { signer },
4545
});
4646
```
4747

developers/examples/README.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
1-
# Example apps
1+
# Examples
22

3+
{% content-ref url="ping-pong.md" %}
4+
[ping-pong.md](ping-pong.md)
5+
{% endcontent-ref %}
6+
7+
{% content-ref url="erc20-token.md" %}
8+
[erc20-token.md](erc20-token.md)
9+
{% endcontent-ref %}
10+
11+
{% content-ref url="controller.md" %}
12+
[controller.md](controller.md)
13+
{% endcontent-ref %}

0 commit comments

Comments
 (0)