Skip to content

Commit 616af6c

Browse files
authored
Merge pull request #42 from cosmology-tech/fix-docs
update docs
2 parents 92f344a + 862206b commit 616af6c

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

.github/workflows/ethermint-e2e-tests.yaml renamed to .github/workflows/injective-e2e-tests.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
name: Run Ethermint E2E Tests
1+
name: Run Injective E2E Tests
22

33
on:
44
workflow_dispatch:
55

66
jobs:
7-
networks-ethermint:
7+
networks-injective:
88
runs-on: ubuntu-latest
99

1010
steps:
@@ -27,7 +27,7 @@ jobs:
2727
id: starship-infra
2828
uses: cosmology-tech/[email protected]
2929
with:
30-
config: networks/ethermint/starship/configs/config.workflow.yaml
30+
config: networks/injective/starship/configs/config.workflow.yaml
3131

3232
- name: Run E2E Tests
33-
run: cd ./networks/ethermint && yarn starship:test
33+
run: cd ./networks/injective && yarn starship:test

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ By employing this pattern, InterchainJS ensures compatibility and extensibility,
2727
```mermaid
2828
graph LR
2929
signers --> cosmos_signer["Cosmos Network"]
30-
signers --> ethermint_signer["Ethermint Network"]
30+
signers --> injective_signer["Injective Network"]
3131
signers --> ethereum_signer["Ethereum Network"]
3232
signers --> implement_signer["ANY Network"]
3333
@@ -36,9 +36,9 @@ graph LR
3636
3737
ethereum_signer --> ethereum_eip712["EIP712 Signer"]
3838
39-
ethermint_signer --> ethermint_amino["Amino Signer"]
40-
ethermint_signer --> ethermint_direct["Direct Signer"]
41-
ethermint_signer --> ethermint_eip712["EIP712 Signer"]
39+
injective_signer --> injective_amino["Amino Signer"]
40+
injective_signer --> injective_direct["Direct Signer"]
41+
injective_signer --> injective_eip712["EIP712 Signer"]
4242
4343
implement_signer --> any_signer["Any Signer"]
4444
@@ -82,12 +82,12 @@ We created a specific package to make it easy to migrate from `@cosmjs`.
8282

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

85-
## ethermint Network
85+
## injective Network
8686

8787
### Transactions
8888

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

9292
## Ethereum Network
9393

docs/signer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Signer
22

3-
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.
3+
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.
44

55
Class diagram:
66

@@ -229,15 +229,15 @@ export interface UniSigner<SignDoc, Tx> {
229229

230230
### InjectiveDirectSigner
231231

232-
- **Class**: `import { DirectSigner } from "@interchainjs/ethermint/direct"`
232+
- **Class**: `import { DirectSigner } from "@interchainjs/injective/direct"`
233233
- **SignDoc**: CosmosDirectDoc
234234
- **Transaction**: CosmosTx
235235
- **Wallet**:
236236
- **WalletAccount**: InjectiveAccount
237237

238238
### InjectiveAminoSigner
239239

240-
- **Class**: `import { AminoSigner } from "@interchainjs/ethermint/amino"`
240+
- **Class**: `import { AminoSigner } from "@interchainjs/injective/amino"`
241241
- **SignDoc**: CosmosAminoDoc
242242
- **Transaction**: CosmosTx
243243
- **Wallet**:

packages/auth/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ const signature = auth.sign(Uint8Array.from([1, 2, 3]));
3333
console.log(signature.toHex());
3434
```
3535

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

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

5151
- [@interchainjs/cosmos](/networks/cosmos/README.md)
5252
- [@interchainjs/ethereum](/networks/ethereum/README.md)
53-
- [@interchainjs/ethermint](/networks/ethermint/README.md)
53+
- [@interchainjs/injective](/networks/injective/README.md)
5454

5555
## Implementations
5656

0 commit comments

Comments
 (0)