-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Addition of new featured section * Addition of featured tools section * Update to the the developer tools page listing all the products and tools * Addition of the Litmus tool page * Addition of arch3.rs product page * Update arch3.rs menu title * Addition of the relayer exporter product page * Addition of a product page for the validator exporter * Update the relayer exporter page with link to the relayer exporter github page * Remove usage instructions * Product page for the network registry * Addition of a Keyring Go product page * Addition of the crates product page and minor modification to other product page menu titles * Re-ordered product pages * Update to product links * Correct spelling error
- Loading branch information
Showing
32 changed files
with
534 additions
and
53 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,3 +28,9 @@ | |
</div> | ||
</Link> | ||
</template> | ||
|
||
<style scoped> | ||
.heading-3 { | ||
font-size: 24px; | ||
} | ||
</style> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
<script lang="ts" setup> | ||
import { Link } from '@/components/Ui'; | ||
// Tool class definition | ||
class Tool { | ||
constructor( | ||
public title: string, | ||
public path: string, | ||
public description: string, | ||
public label: string, | ||
public image: string // Image path for the tool | ||
) {} | ||
static make(attributes: any) { | ||
return new Tool( | ||
attributes?.title || '', | ||
attributes?.path || '', | ||
attributes?.description || '', | ||
attributes?.label || '', | ||
attributes?.image || '' | ||
); | ||
} | ||
} | ||
// Array of tool objects | ||
const tools = [ | ||
new Tool( | ||
'Archway Developer CLI', | ||
'/developers/developer-tools/developer-cli', | ||
'Build, deploy, interact with smart contracts', | ||
'Archway Developer CLI', | ||
'/images/docs/tools/tools-archway-developer-cli.png' | ||
), | ||
new Tool( | ||
'Arch3.js', | ||
'/developers/developer-tools/arch3js/introduction', | ||
'JavaScript library for interacting with the Archway Protocol', | ||
'Arch3.js', | ||
'/images/docs/tools//tools-arch3js.png' | ||
), | ||
new Tool( | ||
'Litmus', | ||
'/developers/developer-tools/litmus', | ||
'Testing framework that facilitates integration and end-to-end testing of CosmWasm smart contracts', | ||
'Litmus', | ||
'/images/docs/tools//tools-litmus.png' | ||
) | ||
]; | ||
</script> | ||
|
||
<template> | ||
<div class="pt-16"> | ||
<h2 class="heading-3 pb-8">Featured Tools</h2> | ||
<div class="space-y-4"> | ||
<!-- Loop through each tool in the tools array --> | ||
<div | ||
v-for="tool in tools" | ||
:key="tool.title" | ||
class="flex space-x-3 px-4 py-4 border border-transparent rounded-2xl bg-white dark:bg-black-100 shadow-card dark:shadow-black" | ||
> | ||
<div class="flex-shrink-0 min-w-0"> | ||
<img class="w-[64px]" :src="tool.image" :alt="tool.title" /> | ||
</div> | ||
<div class="space-y-2 min-w-0"> | ||
<Link class="truncate" :href="tool.path"> | ||
<h2>{{ tool.title }}</h2> | ||
</Link> | ||
<p class="caption text-gray-600 dark:text-gray-900">{{ tool.description }}</p> | ||
</div> | ||
</div> | ||
</div> | ||
</div> | ||
</template> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
<script lang="ts" setup> | ||
import { Link } from '@/components/Ui'; | ||
// Tool class definition | ||
class Tool { | ||
constructor( | ||
public title: string, | ||
public path: string, | ||
public description: string, | ||
public label: string, | ||
public image: string // Image path for the tool | ||
) {} | ||
static make(attributes: any) { | ||
return new Tool( | ||
attributes?.title || '', | ||
attributes?.path || '', | ||
attributes?.description || '', | ||
attributes?.label || '', | ||
attributes?.image || '' | ||
); | ||
} | ||
} | ||
// Array of tool objects | ||
const tools = [ | ||
new Tool( | ||
'Archway Developer CLI', | ||
'/developers/developer-tools/developer-cli', | ||
'Build, deploy, interact with smart contracts', | ||
'Archway Developer CLI', | ||
'/images/docs/tools/tools-archway-developer-cli.png' | ||
), | ||
new Tool( | ||
'Arch3.js', | ||
'/developers/developer-tools/arch3js/introduction', | ||
'JavaScript library for interacting with the Archway Protocol', | ||
'Arch3.js', | ||
'/images/docs/tools//tools-arch3js.png' | ||
), | ||
new Tool( | ||
'Litmus', | ||
'/developers/developer-tools/litmus', | ||
'Testing framework that facilitates integration and end-to-end testing of CosmWasm smart contracts', | ||
'Litmus', | ||
'/images/docs/tools//tools-litmus.png' | ||
), | ||
new Tool( | ||
'Archwayd', | ||
'/developers/developer-tools/archwayd', | ||
'The archwayd binary is the core implementation of the Archway protocol', | ||
'Archwayd', | ||
'/images/docs/tools//tools-archwayd.png' | ||
), | ||
new Tool( | ||
'Arch3.rs', | ||
'/developers/developer-tools/arch3rs', | ||
'Rust library for interacting with the Archway Protocol', | ||
'Arch3.rs', | ||
'/images/docs/tools//tools-arch3rs.png' | ||
), | ||
new Tool( | ||
'Relayer Exporter', | ||
'/developers/developer-tools/relayer-exporter', | ||
'Monitor and export key metrics for IBC relayers on the Archway blockchain.', | ||
'Relayer Exporter', | ||
'/images/docs/tools//tools-relayer-exporter.png' | ||
), | ||
new Tool( | ||
'Validator Exporter', | ||
'/developers/developer-tools/validator-exporter', | ||
'Monitoring tool for Archway blockchain validators', | ||
'Validator Exporter', | ||
'/images/docs/tools//tools-validator-exporter.png' | ||
), | ||
new Tool( | ||
'Network Registry', | ||
'/developers/developer-tools/network-registry', | ||
'JavaScript library for interacting with the Archway Protocol', | ||
'Network Registry', | ||
'/images/docs/tools//tools-network-registry.png' | ||
), | ||
new Tool( | ||
'Archway Multisig', | ||
'/developers/guides/multisig/archway-multisig-hub', | ||
'The archwayd binary is the core implementation of the Archway protocol', | ||
'Archway Multisig', | ||
'/images/docs/tools//tools-archway-multisig.png' | ||
), | ||
new Tool( | ||
'Keyring Go', | ||
'/developers/developer-tools/keyring-go', | ||
'Go-based library designed to provide secure storage and handling of cryptographic keys', | ||
'Keyring Go', | ||
'/images/docs/tools//tools-keyring-go.png' | ||
), | ||
new Tool( | ||
'Crates', | ||
'/developers/developer-tools/crates', | ||
'Rust packages that offer reusable code to streamline the development of smart contracts', | ||
'Crates', | ||
'/images/docs/tools//tools-archway-crates.png' | ||
), | ||
]; | ||
</script> | ||
|
||
<template> | ||
<div class="pt-16"> | ||
<div class="space-y-4"> | ||
<div class="grid grid-cols-1 lg:grid-cols-2 gap-x-8 gap-y-4"> | ||
<!-- Loop through each tool in the tools array --> | ||
<div | ||
v-for="tool in tools" | ||
:key="tool.title" | ||
class="px-4 py-4 border border-transparent rounded-2xl bg-white dark:bg-black-100 shadow-card dark:shadow-black" | ||
> | ||
<div class="flex-shrink-0 min-w-0"> | ||
<img class="w-[64px] my-0" :src="tool.image" :alt="tool.title" /> | ||
</div> | ||
<div class=""> | ||
<Link class="no-underline" :href="tool.path"> | ||
<h3>{{ tool.title }}</h3> | ||
</Link> | ||
<p class="caption text-gray-600 dark:text-gray-900">{{ tool.description }}</p> | ||
</div> | ||
</div> | ||
</div> | ||
</div> | ||
</div> | ||
</template> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
--- | ||
objectID: developers_developer-tools_crates | ||
title: Crates | ||
description: Rust packages that offer reusable code to streamline the development of smart contracts on the Archway blockchain | ||
parentSection: Developers | ||
parentSectionPath: /developers | ||
--- | ||
|
||
# Crates | ||
|
||
The Archway team has developed a comprehensive suite of crates to help with building smart contracts on Archway. These crates provide a wide range of features, from metadata support and marketplace capabilities to permissioned access and updatable tokens. Below is an introduction to each crate and its purpose. | ||
|
||
--- | ||
|
||
## 1. cw721-metadata | ||
|
||
- **Repository:** [GitHub](https://github.com/archway-network/cw721-metadata) | ||
- **Description:** This crate extends the standard CW721 contract with support for rich metadata. It enables developers to attach and manage additional information, such as artwork or detailed descriptions, to each NFT. | ||
- **Use Case:** Ideal for projects that require enhanced NFT metadata management, such as art collections, gaming assets, or digital certificates. | ||
|
||
--- | ||
|
||
## 2. cw721-marketplace | ||
|
||
- **Repository:** [Crates.io](https://crates.io/crates/cw721-marketplace) | ||
- **Description:** A marketplace implementation for trading CW721 NFTs. This crate allows developers to create decentralized marketplaces where users can list, buy, and sell NFTs in a trustless manner. | ||
- **Use Case:** Useful for developers building NFT trading platforms or adding marketplace functionality to existing projects. | ||
|
||
--- | ||
|
||
## 3. cw721-marketplace-utils | ||
|
||
- **Repository:** [Crates.io](https://crates.io/crates/cw721-marketplace-utils) | ||
- **Description:** A set of utilities designed to support the CW721 marketplace. This crate provides helpful tools for managing and interacting with the marketplace contract, streamlining the development process. | ||
- **Use Case:** Developers working with CW721 marketplaces can use this crate to simplify interactions with marketplace contracts. | ||
|
||
--- | ||
|
||
## 4. cw721-marketplace-permissioned | ||
|
||
- **Repository:** [Crates.io](https://crates.io/crates/cw721-marketplace-permissioned/0.1.6/dependencies) | ||
- **Description:** A permissioned version of the CW721 marketplace, allowing only approved parties to list and trade NFTs. This provides additional control over who can participate in the marketplace, making it suitable for curated or closed ecosystems. | ||
- **Use Case:** Ideal for use cases where marketplace participation needs to be restricted, such as exclusive art galleries or private NFT clubs. | ||
|
||
--- | ||
|
||
## 5. cw721 Single Collection Marketplace | ||
|
||
- **Repository:** [Crates.io](https://crates.io/crates/cw721-marketplace-single-collection) | ||
- **Description:** A marketplace focused on a single NFT collection. This crate simplifies the creation of marketplaces tailored for specific collections, making it easier to manage and showcase individual NFT projects. | ||
- **Use Case:** Perfect for developers who want to create a dedicated marketplace for a single NFT collection, offering a streamlined, focused trading experience. | ||
|
||
--- | ||
|
||
## 6. cw721-soulbound | ||
|
||
- **Repository:** [Crates.io](https://crates.io/crates/cw721-soulbound) | ||
- **Description:** This crate introduces **soulbound tokens**—NFTs that are permanently tied to a specific wallet address. Soulbound tokens cannot be transferred, making them ideal for use cases like personal achievements, certifications, or digital identity. | ||
- **Use Case:** Ideal for projects that require NFTs that cannot be traded or sold, such as awards or personal milestones. | ||
|
||
--- | ||
|
||
## 7. CW721 Base (Soulbound) | ||
- **Repository:** [Crates.io](https://crates.io/crates/cw721-base-soulbound) | ||
- **Description:** A base contract for implementing **soulbound tokens** within the CW721 framework. This crate provides a foundation for creating non-transferable NFTs, built on top of the standard CW721 contract. | ||
- **Use Case:** Developers building NFT-based applications that require non-transferable tokens for identity, reputation, or achievements. | ||
|
||
--- | ||
|
||
## 8. cw721-updatable | ||
|
||
- **Repository:** [Crates.io](https://crates.io/crates/cw721-updatable) | ||
- **Description:** A CW721 extension that allows for updating NFT metadata after the token has been minted. This functionality is useful in cases where the properties of an NFT need to evolve over time, such as in gaming or dynamic art. | ||
- **Use Case:** Suitable for applications requiring NFTs with updatable attributes, such as evolving in-game characters or assets. | ||
|
||
--- | ||
|
||
## 9. CW721 Base (Updatable) | ||
|
||
- **Repository:** [Crates.io](https://crates.io/crates/cw721-base-updatable) | ||
- **Description:** A base contract for implementing **updatable NFTs**. This crate extends the standard CW721 functionality to allow for changes in token metadata post-minting. | ||
- **Use Case:** Ideal for developers who need to create NFTs with dynamic or evolving properties, such as in-game items or adaptive art. | ||
|
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.