Skip to content

Commit

Permalink
Merge pull request #870 from hashgraph/accelerator-to-studio
Browse files Browse the repository at this point in the history
Updates github links following rename and some readme references to a…
  • Loading branch information
gregscullard authored Sep 13, 2023
2 parents df9e51e + f0241e1 commit bd56aaf
Show file tree
Hide file tree
Showing 11 changed files with 45 additions and 45 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

# Abstract

The Hedera stablecoin accelerator is a comprehensive set of tools and resources designed to enable developers to build applications and services that make use of the stablecoin. The accelerator includes smart contracts, documentation, and sample code to help developers understand how to use the accelerator and other functionality provided by the platform. With the Hedera stablecoin accelerator, developers can easily integrate the stablecoin into their own applications or create new applications or services that make use of the stablecoin's unique features. Whether you're a seasoned cryptocurrency developer or new to the space, the Hedera stablecoin accelerator has everything you need to start building with stablecoins today.
The Hedera Stablecoin Studio is a comprehensive set of tools and resources designed to enable developers to build applications and services that make use of the stablecoin. The project includes smart contracts, documentation, and sample code to help developers understand how to use the project and other functionality provided by the platform. With the Hedera Stablecoin studio, developers can easily integrate the stablecoin into their own applications or create new applications or services that make use of the stablecoin's unique features. Whether you're a seasoned cryptocurrency developer or new to the space, the Hedera stablecoin accelerator has everything you need to start building with stablecoins today.

# Context

Expand Down Expand Up @@ -94,7 +94,7 @@ Each stablecoin maps to an _underlying_ Hedera Token and adds the following func
Every time a stablecoin is created, a new Hedera Token is created (the underlying token) and the following smart contracts are deployed:

- The stablecoin proxy smart contract: pointing to the `HederaTokenManager` logic smart contract that was passed as an input argument(\*). Proxies are used to make stablecoins upgradable.
- The stablecoin proxy admin smart contract: this contract will act as an intermediary to upgrade the stablecoin proxy implementation. For more information on this, check the [contract module's README](https://github.com/hashgraph/hedera-accelerator-stablecoin/tree/main/contracts/README.md).
- The stablecoin proxy admin smart contract: this contract will act as an intermediary to upgrade the stablecoin proxy implementation. For more information on this, check the [contract module's README](https://github.com/hashgraph/stablecoin-studio/tree/main/contracts/README.md).

An smart contract, named `StablecoinFactory`, must be previously deployed since implements the flow to create a new stablecoin in a single transaction. A default `StablecoinFactory` is deployed, but any user will be able to [deploy their own factory](#deploying-the-stablecoin-factories).

Expand Down
20 changes: 10 additions & 10 deletions cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Stablecoin Studio - Command Line Interface (CLI)

[![CLI - Test](https://github.com/hashgraph/hedera-accelerator-stablecoin/actions/workflows/cli.test.yml/badge.svg)](https://github.com/hashgraph/hedera-accelerator-stablecoin/actions/workflows/cli.test.yml)
[![CLI - Test](https://github.com/hashgraph/stablecoin-studio/actions/workflows/cli.test.yml/badge.svg)](https://github.com/hashgraph/stablecoin-studio/actions/workflows/cli.test.yml)

</div>

Expand Down Expand Up @@ -69,9 +69,9 @@ You must have installed

Then you must install and build the following projects :

1. [Contract installation](https://github.com/hashgraph/hedera-accelerator-stablecoin/blob/main/contracts/README.md#installation)
2. [SDK installation](https://github.com/hashgraph/hedera-accelerator-stablecoin/blob/main/sdk/README.md#installation)
3. [Hashconnect installation](https://github.com/hashgraph/hedera-accelerator-stablecoin/blob/main/hashconnect/lib/README.md#installation)
1. [Contract installation](https://github.com/hashgraph/stablecoin-studio/blob/main/contracts/README.md#installation)
2. [SDK installation](https://github.com/hashgraph/stablecoin-studio/blob/main/sdk/README.md#installation)
3. [Hashconnect installation](https://github.com/hashgraph/stablecoin-studio/blob/main/hashconnect/lib/README.md#installation)

## Steps

Expand All @@ -87,7 +87,7 @@ From the root of the CLI project workspace:

The first time you execute the `accelerator wizard` command in your terminal, if you haven't added your default configuration path the interface will ask you whether you want to create a new configuration file in the default path. When the configuration file is created you must configure the default network, operating accounts and the factory contract id. In order to create the default account you can use [HashPack](https://www.hashpack.app/download) or the [Hedera Developer Portal](https://portal.hedera.com/register).

https://github.com/hashgraph/hedera-accelerator-stablecoin/assets/108128685/73c2ed6c-ebc4-4717-b837-c4595c007ba0
https://github.com/hashgraph/stablecoin-studio/assets/108128685/73c2ed6c-ebc4-4717-b837-c4595c007ba0

_Note that for testing purpose you should create a **Testnet** account instead of Mainnet account. Everything executed on Mainnet will incur a cost with real money._

Expand Down Expand Up @@ -216,7 +216,7 @@ When your configuration file is set up and at least one account is added and sel
#### Create a new stablecoin

In order to use this option you must set a factory first.
You can check our factories deployed in [our documentation](https://github.com/hashgraph/hedera-accelerator-stablecoin#deploying-the-stable-coin-factories).
You can check our factories deployed in [our documentation](https://github.com/hashgraph/stablecoin-studio#deploying-the-stable-coin-factories).

With this option you are able to create a new stablecoin adding the mandatory details like name and symbol.

Expand Down Expand Up @@ -251,7 +251,7 @@ The request will then be submitted to the SDK and the stablecoin will be created

> When the configuration file is first created, the factory contract added to the "testnet" network are the default one (pre-deployed contract). However, users are free to deploy and use their own contracts, in order to do that, the configuration file must be updated with the new factory contract id.
https://github.com/hashgraph/hedera-accelerator-stablecoin/assets/108128685/dde74619-8c48-40b7-a0ff-3553214fa819
https://github.com/hashgraph/stablecoin-studio/assets/108128685/dde74619-8c48-40b7-a0ff-3553214fa819

#### Manage imported tokens

Expand Down Expand Up @@ -291,15 +291,15 @@ https://user-images.githubusercontent.com/102601367/205074235-32145a1b-4ce0-4913

- **Rescue HBAR**: transfers HBAR from the treasury account to a rescue account. This option is only available through the smart contract.

https://github.com/hashgraph/hedera-accelerator-stablecoin/assets/108128685/e09a9389-8f29-4869-a696-58b25d99a6f3
https://github.com/hashgraph/stablecoin-studio/assets/108128685/e09a9389-8f29-4869-a696-58b25d99a6f3

- **Freeze Management**: freezes/unfreezes an account for a token or checks if an account is frozen/unfrozen. If an account is frozen, it will not be able to transfer any tokens.

https://user-images.githubusercontent.com/114951681/228851899-8a63b255-8e97-4705-8765-f59c01fc928b.mp4

- **FeeS Management**: creats/removes custom fees for a token or lists existing ones. Fees are applied when the token is transferred.

https://github.com/hashgraph/hedera-accelerator-stablecoin/assets/108128685/a18f8723-d161-4283-a867-81d0d204e015
https://github.com/hashgraph/stablecoin-studio/assets/108128685/a18f8723-d161-4283-a867-81d0d204e015

- **KYC Management**: grants/revokes KYC to/from an account or checks an account's kyc status. If an account is granted KYC, it can be involved in any token transfer.

Expand Down Expand Up @@ -336,7 +336,7 @@ This last option allows the user to display the current configuration file, modi

- **Accounts**: Allows the user to change the current account, see all configured accounts and also add new accounts and remove existing ones.
- **Mirror nodes**: Allows the user to change the current mirror node, see all configured mirror nodes for the selected Hedera network, add new mirror nodes and remove existing ones except for the one that is being used.
- **JSON-RPC-Relay services**: Allows the user to change the current JSON-RPC-Relay service, see all configured services for the selected Hedera network, add new JSON-RPC-Relay servies and remove existing ones except for the one that is being used. You can check the available JSON-RPC relays [here](https://github.com/hashgraph/hedera-accelerator-stablecoin/blob/main/README.md#JSON-RPC-Relays)
- **JSON-RPC-Relay services**: Allows the user to change the current JSON-RPC-Relay service, see all configured services for the selected Hedera network, add new JSON-RPC-Relay servies and remove existing ones except for the one that is being used. You can check the available JSON-RPC relays [here](https://github.com/hashgraph/stablecoin-studio/blob/main/README.md#JSON-RPC-Relays)
- **Factory**: Allows the user to change the factory id of the selected Hedera network in the configuration file, to upgrade the factory's proxy, to change the factory's proxy admin owner account and, finally, to view de current factory implementation contract address as well as the factory owner account previously commented.

# Testing
Expand Down
4 changes: 2 additions & 2 deletions cli/src/resources/config/language.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export const english = {
AccountsConfigurationMessage: 'You will now configure your accounts:',
askAccountId: 'Enter the account id',
askConfigurateFactories:
'Do you want to config your factories? Check the documentation for more information : https://github.com/hashgraph/hedera-accelerator-stablecoin#deploying-the-stable-coin-factories',
'Do you want to config your factories? Check the documentation for more information : https://github.com/hashgraph/stablecoin-studio#deploying-the-stable-coin-factories',
askConfigurateDefaultMirrorsAndRPCs:
'Do you want to use default mirror node/JSON-RPC-Relay services? (y/n)',
askNetworkAccount: 'Which network does this account belong to?',
Expand Down Expand Up @@ -130,7 +130,7 @@ export const english = {
},
stablecoin: {
noFactories:
"You don't have configured your factory and HederaTokenManager address. Without this configuration you cannot create an stablecoin. Check the following link for more information. https://github.com/hashgraph/hedera-accelerator-stablecoin/tree/main/cli#creating-a-config-file",
"You don't have configured your factory and HederaTokenManager address. Without this configuration you cannot create an stablecoin. Check the following link for more information. https://github.com/hashgraph/stablecoin-studio/tree/main/cli#creating-a-config-file",
askConfirmCreation:
'Are you sure you want to create the stablecoin with these parameters?',
description: 'Creating Stablecoin',
Expand Down
2 changes: 1 addition & 1 deletion contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The remaining smart contracts have been implemented for this project:

## Overall architecture

![StableCoinOverallArchitecture](https://github.com/hashgraph/hedera-accelerator-stablecoin/assets/108128685/218702f9-a0af-4e9a-901a-ffdd97a28b12)
![StableCoinOverallArchitecture](https://github.com/hashgraph/stablecoin-studio/assets/108128685/218702f9-a0af-4e9a-901a-ffdd97a28b12)

## Detailed architecture

Expand Down
2 changes: 1 addition & 1 deletion defenders/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Accelerator Integration with OZ Defender
# Studio Integration with OZ Defender

### Table of Contents
- **[Introduction](#Introduction)**<br>
Expand Down
6 changes: 3 additions & 3 deletions sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

# Stablecoin Studio SDK

[![SDK - Test](https://github.com/hashgraph/hedera-accelerator-stablecoin/actions/workflows/sdk.test.yml/badge.svg)](https://github.com/hashgraph/hedera-accelerator-stablecoin/actions/workflows/sdk.test.yml)
[![Latest Version](https://img.shields.io/github/v/tag/hashgraph/hedera-accelerator-stablecoin?sort=semver&label=version)](README.md)
[![SDK - Test](https://github.com/hashgraph/stablecoin-studio/actions/workflows/sdk.test.yml/badge.svg)](https://github.com/hashgraph/stablecoin-studio/actions/workflows/sdk.test.yml)
[![Latest Version](https://img.shields.io/github/v/tag/hashgraph/stablecoin-studio?sort=semver&label=version)](README.md)
[![License](https://img.shields.io/badge/license-apache2-blue.svg)](LICENSE)

</div>
Expand Down Expand Up @@ -1415,7 +1415,7 @@ All events use the [standard node event emitting system](https://nodejs.dev/es/l

**Example:**

Check out [Router.tsx](https://github.com/hashgraph/hedera-accelerator-stablecoin/blob/main/web/src/Router/Router.tsx) from the web repository for a comprehensive example in React of how to subscribe to events.
Check out [Router.tsx](https://github.com/hashgraph/stablecoin-studio/blob/main/web/src/Router/Router.tsx) from the web repository for a comprehensive example in React of how to subscribe to events.

## Account

Expand Down
Loading

1 comment on commit bd56aaf

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage report for cli

St.
Category Percentage Covered / Total
🟡 Statements 79.07% 2225/2814
🟡 Branches 67.49% 629/932
🟡 Functions 79.48% 457/575
🟡 Lines 79.58% 2213/2781

Test suite run success

162 tests passing in 38 suites.

Report generated by 🧪jest coverage report action from bd56aaf

Please sign in to comment.