Skip to content

Commit

Permalink
Merge branch 'master' into rename-subnets-blockchain
Browse files Browse the repository at this point in the history
  • Loading branch information
@laviniat1996
laviniat1996 authored Jul 31, 2024
2 parents a59b09a + 87d4db6 commit 9fc0fb7
Show file tree
Hide file tree
Showing 5 changed files with 263 additions and 77 deletions.
2 changes: 2 additions & 0 deletions .github/styles/Vocab/Products/accept.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ alloc
Alloc
alloweds
ANR's
ANCs
Ansible
API's
apis
Expand Down Expand Up @@ -150,6 +151,7 @@ infeasibly
Infura
inlined
ints
interoperate
IPCs
ipfs
IPFS
Expand Down
1 change: 0 additions & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ docs/build/cross-chain/teleporter/upgradeability.md
docs/build/cross-chain/teleporter/cli.md
docs/build/cross-chain/awm/evm-integration.md
docs/build/cross-chain/awm/relayer.md
docs/learn/acp.md

# AvalancheGo API from GH repo via docusaurus-plugin-remote-content
docs/reference/avalanchego/p-chain/api.md
Expand Down
119 changes: 43 additions & 76 deletions configs/remoteContent.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,13 +99,13 @@ const remoteContent = [
return {
filename: "deep-dive.md",
content: `---
tags: [Avalanche Warp Messaging, AWM, Cross-Subnet Communication, Cross-Chain Communication]
description: Avalanche Warp Messaging (AWM) provides a primitive for cross-subnet communication on the Avalanche Network.
keywords: [ docs, documentation, avalanche, awm, cross-subnet communication, cross-chain, cross-chain communication ]
sidebar_label: Deep Dive
sidebar_position: 1
tags: [Avalanche Warp Messaging, AWM, Cross-Subnet Communication, Cross-Chain Communication]
description: Avalanche Warp Messaging (AWM) provides a primitive for cross-subnet communication on the Avalanche Network.
keywords: [ docs, documentation, avalanche, awm, cross-subnet communication, cross-chain, cross-chain communication ]
sidebar_label: Deep Dive
sidebar_position: 1
---
${updatedContent}`,
};
}
Expand Down Expand Up @@ -138,11 +138,11 @@ ${updatedContent}`,
return {
filename: "relayer.md",
content: `---
tags: [Avalanche Warp Messaging, Relayer]
description: Reference relayer implementation for cross-chain Avalanche Warp Message delivery.
keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
sidebar_label: Run a Relayer
sidebar_position: 3
tags: [Avalanche Warp Messaging, Relayer]
description: Reference relayer implementation for cross-chain Avalanche Warp Message delivery.
keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
sidebar_label: Run a Relayer
sidebar_position: 3
---
${newContent}`,
Expand All @@ -158,15 +158,15 @@ ${newContent}`,
// /docs/build/cross-chain/teleporter/overview.md
name: "teleporter-overview",
sourceBaseUrl:
"https://raw.githubusercontent.com/ava-labs/teleporter/main/contracts/src/Teleporter/",
"https://raw.githubusercontent.com/ava-labs/teleporter/main/contracts/src/teleporter/",
documents: ["README.md"],
outDir: "docs/build/cross-chain/teleporter/",
// change file name and add metadata correct links
modifyContent(filename, content) {
if (filename.includes("README")) {
const updatedContent = replaceRelativeLinks(
content,
"https://github.com/ava-labs/teleporter/blob/main/contracts/src/Teleporter/"
"https://github.com/ava-labs/teleporter/blob/main/contracts/src/teleporter/"
);

const newContent = insertLinesAfterFirstLine(
Expand All @@ -177,11 +177,11 @@ ${newContent}`,
return {
filename: "overview.md",
content: `---
tags: [Teleporter, Cross-Subnet Communication, Cross-Chain Communication]
description: Teleporter is a messaging protocol built on top of Avalanche Warp Messaging that provides a developer-friendly interface for sending and receiving cross-chain messages from within the EVM.
keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
sidebar_label: Overview
sidebar_position: 1
tags: [Teleporter, Cross-Subnet Communication, Cross-Chain Communication]
description: Teleporter is a messaging protocol built on top of Avalanche Warp Messaging that provides a developer-friendly interface for sending and receiving cross-chain messages from within the EVM.
keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
sidebar_label: Overview
sidebar_position: 1
---
${newContent}`,
Expand Down Expand Up @@ -211,12 +211,12 @@ ${newContent}`,
return {
filename: "deep-dive.md",
content: `---
tags: [Teleporter, Cross-Subnet Communication, Cross-Chain Communication]
description: Teleporter is an EVM compatible cross-subnet communication protocol built on top of Avalanche Warp Messaging (AWM), and implemented as a Solidity smart contract. It provides a mechanism to asynchronously invoke smart contract functions on other EVM blockchains within Avalanche. Teleporter provides a handful of useful features on top of AWM, such as specifying relayer incentives for message delivery, replay protection, message delivery and execution retries, and a standard interface for sending and receiving messages within a dApp deployed across multiple subnets.
keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
sidebar_label: Deep Dive
sidebar_position: 2
title: Teleporter Deep Dive
tags: [Teleporter, Cross-Subnet Communication, Cross-Chain Communication]
description: Teleporter is an EVM compatible cross-subnet communication protocol built on top of Avalanche Warp Messaging (AWM), and implemented as a Solidity smart contract. It provides a mechanism to asynchronously invoke smart contract functions on other EVM blockchains within Avalanche. Teleporter provides a handful of useful features on top of AWM, such as specifying relayer incentives for message delivery, replay protection, message delivery and execution retries, and a standard interface for sending and receiving messages within a dApp deployed across multiple subnets.
keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
sidebar_label: Deep Dive
sidebar_position: 2
title: Teleporter Deep Dive
---
${updatedContent}`,
Expand Down Expand Up @@ -251,11 +251,11 @@ ${updatedContent}`,
return {
filename: "cli.md",
content: `---
tags: [Teleporter, Cross-Subnet Communication, Cross-Chain Communication]
description: This page the source code for the Avalanche Teleporter CLI. The CLI is a command line interface for interacting with the Teleporter contracts. It is written with [cobra](https://github.com/spf13/cobra) commands as a Go application.
keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication, teleporter cli ]
sidebar_label: CLI
sidebar_position: 6
tags: [Teleporter, Cross-Subnet Communication, Cross-Chain Communication]
description: This page the source code for the Avalanche Teleporter CLI. The CLI is a command line interface for interacting with the Teleporter contracts. It is written with [cobra](https://github.com/spf13/cobra) commands as a Go application.
keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication, teleporter cli ]
sidebar_label: CLI
sidebar_position: 6
---
${newContent}`,
Expand All @@ -271,15 +271,15 @@ ${newContent}`,
// /docs/build/cross-chain/teleporter/upgradeability.md
name: "teleporter-upgradeability",
sourceBaseUrl:
"https://raw.githubusercontent.com/ava-labs/teleporter/main/contracts/src/Teleporter/upgrades/",
"https://raw.githubusercontent.com/ava-labs/teleporter/main/contracts/src/teleporter/registry/",
documents: ["README.md"],
outDir: "docs/build/cross-chain/teleporter/",
// change file name and add metadata correct links
modifyContent(filename, content) {
if (filename.includes("README")) {
const updatedContent = replaceRelativeLinks(
content,
"https://github.com/ava-labs/teleporter/blob/main/contracts/src/Teleporter/upgrades/"
"https://github.com/ava-labs/teleporter/blob/main/contracts/src/teleporter/registry/"
);

const newContent = insertLinesAfterFirstLine(
Expand All @@ -290,11 +290,11 @@ ${newContent}`,
return {
filename: "upgradeability.md",
content: `---
tags: [Teleporter, Cross-Subnet Communication, Cross-Chain Communication]
description: Teleporter is an EVM-compatible cross-subnet communication protocol built on top of Avalanche Warp Messaging. The TeleporterMessenger contract is non-upgradable, once a version of the contract is deployed it cannot be changed. However, there could still be new versions of TeleporterMessenger contracts needed to be deployed in the future.
keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
sidebar_label: Upgradeability
sidebar_position: 5
tags: [Teleporter, Cross-Subnet Communication, Cross-Chain Communication]
description: Teleporter is an EVM-compatible cross-subnet communication protocol built on top of Avalanche Warp Messaging. The TeleporterMessenger contract is non-upgradable, once a version of the contract is deployed it cannot be changed. However, there could still be new versions of TeleporterMessenger contracts needed to be deployed in the future.
keywords: [ docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
sidebar_label: Upgradeability
sidebar_position: 5
---
${newContent}`,
Expand All @@ -310,10 +310,10 @@ ${newContent}`,
// /docs/build/cross-chain/teleporter/evm-integration.md
name: "awm-evm-integration",
sourceBaseUrl:
"https://raw.githubusercontent.com/meaghanfitzgerald/coreth/docs-integration/precompile/contracts/warp/",
"https://raw.githubusercontent.com/ava-labs/coreth/master/precompile/contracts/warp/",
documents: ["README.md"],
outDir: "docs/build/cross-chain/awm/",
// change file name and add metadata correct links
// change the file name and add metadata correct links
modifyContent(filename, content) {
if (filename.includes("README")) {
const updatedContent = replaceRelativeLinks(
Expand All @@ -323,44 +323,11 @@ ${newContent}`,
return {
filename: "evm-integration.md",
content: `---
tags: [Avalanche Warp Messaging, Coreth, Subnet-EVM, Cross-Subnet Communication, Cross-Chain Communication]
description: Avalanche Warp Messaging provides a basic primitive for signing and verifying messages between Subnets. The receiving network can verify whether an aggregation of signatures from a set of source Subnet validators represents a threshold of stake large enough for the receiving network to process the message. The Avalanche Warp Precompile enables this flow to send a message from blockchain A to blockchain B.
keywords: [ coreth, subnet-evm, docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
sidebar_label: EVM Integration
sidebar_position: 2
---
${updatedContent}`,
};
}
return undefined;
},
},
],
[
"docusaurus-plugin-remote-content",
{
// /docs/learn/acp.md
name: "acp-overview",
sourceBaseUrl:
"https://raw.githubusercontent.com/meaghanfitzgerald/ACPs/main/",
documents: ["README.md"],
outDir: "docs/learn/",
// change file name and add metadata, correct links
modifyContent(filename, content) {
if (filename.includes("README")) {
const updatedContent = replaceRelativeLinks(
content,
"https://github.com/avalanche-foundation/ACPs/blob/main/"
);
return {
filename: "acp.md",
content: `---
tags: [Avalanche Community Proposals, ACPs]
description: An Avalanche Community Proposal is a concise document that introduces a change or best practice for adoption on the Avalanche Network. ACPs should provide clear technical specifications of any proposals and a compelling rationale for their adoption. ACPs are an open framework for proposing improvements and gathering consensus around changes to the Avalanche Network. ACPs can be proposed by anyone.
keywords: [ avalanche, nodes, preference, avalanche improvements, open source, acps, avalanche community proposals ]
sidebar_label: Avalanche Community Proposals
sidebar_position: 0
tags: [Avalanche Warp Messaging, Coreth, Subnet-EVM, Cross-Subnet Communication, Cross-Chain Communication]
description: Avalanche Warp Messaging provides a basic primitive for signing and verifying messages between Subnets. The receiving network can verify whether an aggregation of signatures from a set of source Subnet validators represents a threshold of stake large enough for the receiving network to process the message. The Avalanche Warp Precompile enables this flow to send a message from blockchain A to blockchain B.
keywords: [ coreth, subnet-evm, docs, documentation, avalanche, teleporter, awm, cross-subnet communication, cross-chain, cross-chain communication ]
sidebar_label: EVM Integration
sidebar_position: 2
---
${updatedContent}`,
Expand Down
Loading

0 comments on commit 9fc0fb7

Please sign in to comment.