Skip to content

Commit

Permalink
Merge pull request #42 from cosmology-tech/fix-docs
Browse files Browse the repository at this point in the history
update docs
  • Loading branch information
Zetazzz authored Sep 24, 2024
2 parents 92f344a + 862206b commit 616af6c
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 16 deletions.
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: Run Ethermint E2E Tests
name: Run Injective E2E Tests

on:
workflow_dispatch:

jobs:
networks-ethermint:
networks-injective:
runs-on: ubuntu-latest

steps:
Expand All @@ -27,7 +27,7 @@ jobs:
id: starship-infra
uses: cosmology-tech/starship-action@0.5.5
with:
config: networks/ethermint/starship/configs/config.workflow.yaml
config: networks/injective/starship/configs/config.workflow.yaml

- name: Run E2E Tests
run: cd ./networks/ethermint && yarn starship:test
run: cd ./networks/injective && yarn starship:test
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ By employing this pattern, InterchainJS ensures compatibility and extensibility,
```mermaid
graph LR
signers --> cosmos_signer["Cosmos Network"]
signers --> ethermint_signer["Ethermint Network"]
signers --> injective_signer["Injective Network"]
signers --> ethereum_signer["Ethereum Network"]
signers --> implement_signer["ANY Network"]
Expand All @@ -36,9 +36,9 @@ graph LR
ethereum_signer --> ethereum_eip712["EIP712 Signer"]
ethermint_signer --> ethermint_amino["Amino Signer"]
ethermint_signer --> ethermint_direct["Direct Signer"]
ethermint_signer --> ethermint_eip712["EIP712 Signer"]
injective_signer --> injective_amino["Amino Signer"]
injective_signer --> injective_direct["Direct Signer"]
injective_signer --> injective_eip712["EIP712 Signer"]
implement_signer --> any_signer["Any Signer"]
Expand Down Expand Up @@ -82,12 +82,12 @@ We created a specific package to make it easy to migrate from `@cosmjs`.

- [interchainjs](/networks/cosmjs/README.md)

## ethermint Network
## injective Network

### Transactions

- [@interchainjs/ethermint](/networks/ethermint/README.md)
- `@interchainjs/ethermint-msgs`(on progress)
- [@interchainjs/injective](/networks/injective/README.md)
- `@interchainjs/injective-msgs`(on progress)

## Ethereum Network

Expand Down
6 changes: 3 additions & 3 deletions docs/signer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Signer

The main purpose of the `@interchainjs/cosmos`, `@interchainjs/ethereum`, `@interchainjs/ethermint` is to offer developers a way to have different `Signer` implementations on different types of Blockchains. All of these `Signer`s are implementing [`UniSigner` interface](#unisigner-interface) and extending the same `BaseSigner` class which with `Auth` object being utilized in construction.
The main purpose of the `@interchainjs/cosmos`, `@interchainjs/ethereum`, `@interchainjs/injective` is to offer developers a way to have different `Signer` implementations on different types of Blockchains. All of these `Signer`s are implementing [`UniSigner` interface](#unisigner-interface) and extending the same `BaseSigner` class which with `Auth` object being utilized in construction.

Class diagram:

Expand Down Expand Up @@ -229,15 +229,15 @@ export interface UniSigner<SignDoc, Tx> {

### InjectiveDirectSigner

- **Class**: `import { DirectSigner } from "@interchainjs/ethermint/direct"`
- **Class**: `import { DirectSigner } from "@interchainjs/injective/direct"`
- **SignDoc**: CosmosDirectDoc
- **Transaction**: CosmosTx
- **Wallet**:
- **WalletAccount**: InjectiveAccount

### InjectiveAminoSigner

- **Class**: `import { AminoSigner } from "@interchainjs/ethermint/amino"`
- **Class**: `import { AminoSigner } from "@interchainjs/injective/amino"`
- **SignDoc**: CosmosAminoDoc
- **Transaction**: CosmosTx
- **Wallet**:
Expand Down
4 changes: 2 additions & 2 deletions packages/auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ const signature = auth.sign(Uint8Array.from([1, 2, 3]));
console.log(signature.toHex());
```

It's easy to derive _cosmos/ethermint/ethereum_ network HD path (taking `cosmos` as example)
It's easy to derive _cosmos/injective/ethereum_ network HD path (taking `cosmos` as example)

```ts
// derive with Cosmos default HD path "m/44'/118'/0'/0/0"
Expand All @@ -50,7 +50,7 @@ const [auth] = Secp256k1Auth.fromMnemonic("<MNEMONIC_WORDS>", [

- [@interchainjs/cosmos](/networks/cosmos/README.md)
- [@interchainjs/ethereum](/networks/ethereum/README.md)
- [@interchainjs/ethermint](/networks/ethermint/README.md)
- [@interchainjs/injective](/networks/injective/README.md)

## Implementations

Expand Down

0 comments on commit 616af6c

Please sign in to comment.