Skip to content

Commit a64da08

Browse files
codebycarsoncodebycarson
authored
Updated READMEs to point to docs (#274)
* Updated READMEs to point to docs * Added changeset to update homepages on NPM to the new README files
1 parent 93c3acc commit a64da08

6 files changed

Lines changed: 102 additions & 728 deletions

File tree

‎.changeset/sharp-seas-fix.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
"@sei-js/create-sei": patch
3+
"@sei-js/ledger": patch
4+
"@sei-js/mcp-server": patch
5+
"@sei-js/precompiles": patch
6+
"@sei-js/sei-global-wallet": patch
7+
---
8+
9+
Update README files in NPM

‎packages/create-sei/README.md‎

Lines changed: 16 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,27 @@
1-
# Create Sei App
1+
<div align="center">
22

3-
This repository contains various templates for kick-starting a Sei application out of the box, as well as a CLI (Command Line Interface) tool that can be used to create projects using the given templates.
3+
# @sei-js/create-sei
44

5-
You can use either:
6-
- Next.js
7-
- Vite.js
5+
[![npm version](https://badge.fury.io/js/@sei-js%2Fcreate-sei.svg)](https://badge.fury.io/js/@sei-js%2Fcreate-sei)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7+
[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
8+
[![Sei Network](https://img.shields.io/badge/Sei-Network-red)](https://sei.io)
89

9-
to scaffold your project.
10+
**Scaffold new Sei applications with pre-configured templates and tooling**
1011

11-
## Scaffold your project
12-
Simply run `npx @sei-js/create-sei app` to run the setup wizard and choose the template you want to use.
12+
[Documentation](https://sei-js.docs.sei.io/create-sei/welcome) • [GitHub](https://github.com/sei-protocol/sei-js) • [NPM](https://www.npmjs.com/package/@sei-js/create-sei) • [Telegram](https://t.me/+LPW_1djQwRQwMzlk)
1313

14-
## EVM Applications (Recommended)
15-
Building on our EVM (Ethereum Virtual Machine) is the easiest way to get your dApp kick-started on Sei! The mature EVM ecosystem provides many tools out of the box to help developers build faster, including deploying smart contracts and other helpful connection libraries.
14+
</div>
1615

17-
This tool will offer multiple variants of EVM tooling, including
18-
- [Wagmi](https://wagmi.sh/core/getting-started) ([Viem](https://viem.sh/)): Recommended
19-
- [Ethers](https://docs.ethers.org/v6/)
16+
## 🚀 Quick Start
2017

21-
Both variants use [@sei-js/evm](https://sei-protocol.github.io/sei-js/modules/evm.html)
18+
```bash
19+
npx @sei-js/create-sei app -n my-sei-app
20+
```
2221

23-
If you are new to Web3 development, we recommend using Wagmi since it provides helpful hooks out of the box.
22+
## 📚 Documentation
2423

25-
## Cosmos Applications
26-
Cosmos based Sei Applications interact with the CosmWasm VM on the chain. Use this if you are a seasoned CosmWasm developer, or if you intend to interact with CosmWasm Smart Contracts, as well as other chains in the Cosmos ecosystem.
24+
For complete documentation, examples, and guides, visit:
25+
**[sei-js.docs.sei.io/create-sei](https://sei-js.docs.sei.io/create-sei/welcome)**
2726

28-
If you think your app might require interaction with native Cosmos modules, you should check the list of [precompiles](https://www.docs.sei.io/dev-interoperability/precompiles/addr) to determine if the same support can be offered by the EVM.
2927

30-
Cosmos Applications use
31-
- [CosmosKit](https://hyperweb.io/stack/cosmos-kit)
32-
- [@sei-js/cosmjs](https://sei-protocol.github.io/sei-js/modules/cosmjs.html)
33-
- [Cosmjs](https://github.com/cosmos/cosmjs)
34-
35-
## Contributing
36-
We love contributions from the amazing Sei community! If you have a dApp template to contribute, do make a Pull Request into the [sei-js](https://github.com/sei-protocol/sei-js) repository.

‎packages/ledger/README.md‎

Lines changed: 15 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -1,151 +1,27 @@
1-
# @sei-js/ledger
2-
3-
## Table of Contents
4-
- [Installation](#installation)
5-
- [Usage](#usage)
6-
- [createTransportAndApp](#createtransportandapp)
7-
- [Parameters](#createTransportAndApp-parameters)
8-
- [getAddresses](#getaddresses)
9-
- [Parameters](#getAddresses-parameters)
10-
- [SeiLedgerOfflineAminoSigner](#seiledgerofflineaminosigner)
11-
- [Constructor](#SeiLedgerOfflineAminoSigner-constructor)
12-
- [getAccounts](#SeiLedgerOfflineAminoSigner-getAccounts)
13-
- [signAmino](#SeiLedgerOfflineAminoSigner-signAmino)
14-
- [removeLeadingZeros](#removeleadingzeros)
15-
- [Parameters](#removeLeadingZeros-parameters)
16-
17-
## Installation
18-
```bash
19-
yarn add @sei-js/ledger
20-
```
21-
22-
## Example Usage
23-
```typescript
24-
import {
25-
coins,
26-
SigningStargateClient,
27-
StdFee
28-
} from "@cosmjs/stargate";
29-
30-
import {
31-
createTransportAndApp,
32-
getAddresses,
33-
SeiLedgerOfflineAminoSigner
34-
} from "@sei-js/ledger";
35-
36-
const testApp = async () => {
37-
const validatorAddress = "seivaloper1sq7x0r2mf3gvwr2l9amtlye0yd3c6dqa4th95v";
38-
const rpcUrl = "https://rpc-testnet.sei-apis.com/";
39-
const memo = "Delegation";
40-
const path = "m/44'/60'/0'/0/0";
41-
42-
const {app} = await createTransportAndApp();
43-
const {nativeAddress} = await getAddresses(app, path);
44-
const ledgerSigner = new SeiLedgerOfflineAminoSigner(app, path)
45-
const signingStargateClient = await SigningStargateClient.connectWithSigner(rpcUrl, ledgerSigner)
46-
47-
const msgDelegate = {
48-
typeUrl: "/cosmos.staking.v1beta1.MsgDelegate",
49-
value: {
50-
delegatorAddress: nativeAddress.address,
51-
validatorAddress: validatorAddress,
52-
amount: coins(500, "usei"),
53-
},
54-
};
55-
56-
const fee: StdFee = {
57-
amount: [{denom: "usei", amount: "20000"}],
58-
gas: "200000",
59-
};
60-
61-
const result = await signingStargateClient.signAndBroadcast(nativeAddress.address, [msgDelegate], fee, memo)
62-
console.log("Broadcast result:", result);
63-
};
64-
65-
testApp();
66-
```
67-
68-
69-
## createTransportAndApp
70-
71-
### Parameters:
72-
- None.
73-
74-
### Returns:
75-
- `Promise<{transport: Transport, app: SeiApp}>`: A promise that resolves to an object containing the `transport` and `app` instances.
1+
<div align="center">
762

77-
### Usage:
78-
```typescript
79-
import { createTransportAndApp } from '@sei-js/ledger';
80-
81-
const { transport, app } = await createTransportAndApp();
82-
console.log(transport, app);
83-
```
84-
85-
## getAddresses
86-
87-
### Parameters:
88-
- `app` (`SeiApp`): An instance of the Ledger Sei app.
89-
- `path` (`string`): The HD derivation path (e.g., `"m/44'/60'/0'/0/0"`).
90-
91-
### Returns:
92-
- `Promise<{evmAddress: string, nativeAddress: string}>`: A promise that resolves to an object containing the EVM and Cosmos addresses.
93-
94-
### Usage:
95-
```typescript
96-
import { getAddresses } from '@sei-js/ledger';
97-
98-
const { evmAddress, nativeAddress } = await getAddresses(app, "m/44'/60'/0'/0/0");
99-
console.log(evmAddress, nativeAddress);
100-
```
101-
102-
## SeiLedgerOfflineAminoSigner
103-
104-
### Constructor
105-
106-
```typescript
107-
new SeiLedgerOfflineAminoSigner(app: SeiApp, path: string)
108-
```
3+
# @sei-js/ledger
1094

110-
#### Parameters:
111-
- `app` (`SeiApp`): An instance of the Ledger Sei app.
112-
- `path` (`string`): The HD derivation path (e.g., `"m/44'/60'/0'/0/0"`).
5+
[![npm version](https://badge.fury.io/js/@sei-js%2Fledger.svg)](https://badge.fury.io/js/@sei-js%2Fledger)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7+
[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
8+
[![Sei Network](https://img.shields.io/badge/Sei-Network-red)](https://sei.io)
1139

114-
#### Usage:
115-
```typescript
116-
import { SeiLedgerOfflineAminoSigner } from '@sei-js/ledger';
10+
**Hardware wallet integration for secure transaction signing**
11711

118-
const ledgerSigner = new SeiLedgerOfflineAminoSigner(app, "m/44'/60'/0'/0/0");
119-
```
12+
[Documentation](https://sei-js.docs.sei.io/ledger/introduction) • [GitHub](https://github.com/sei-protocol/sei-js) • [NPM](https://www.npmjs.com/package/@sei-js/ledger) • [Telegram](https://t.me/+LPW_1djQwRQwMzlk)
12013

121-
### getAccounts
14+
</div>
12215

123-
#### Returns:
124-
- `Promise<readonly AccountData[]>`: A promise that resolves to an array of `AccountData` objects containing the address and public key.
16+
## 🚀 Quick Start
12517

126-
#### Usage:
127-
```typescript
128-
import { SeiLedgerOfflineAminoSigner } from '@sei-js/ledger';
129-
130-
const accounts = await ledgerSigner.getAccounts();
131-
console.log(accounts); // { address: 'sei1...', pubkey: { type: 'tendermint/PubKeySecp256k1', value: '...' } }
18+
```bash
19+
npm install @sei-js/ledger
13220
```
13321

134-
### signAmino
22+
## 📚 Documentation
13523

136-
#### Parameters:
137-
- `_signerAddress` (`string`): The address of the signer (unused in this method).
138-
- `signDoc` (`StdSignDoc`): The sign document to be signed.
24+
For complete documentation, examples, and guides, visit:
25+
**[sei-js.docs.sei.io/ledger](https://sei-js.docs.sei.io/ledger/introduction)**
13926

140-
#### Returns:
141-
- `Promise<AminoSignResponse>`: A promise that resolves to an object containing the signed document and the signature.
14227

143-
#### Usage:
144-
```typescript
145-
import { SeiLedgerOfflineAminoSigner } from '@sei-js/ledger';
146-
import { StdSignDoc } from '@cosmjs/amino';
147-
148-
const signDoc: StdSignDoc = { /* your StdSignDoc object */ };
149-
const signResponse = await ledgerSigner.signAmino('sei123...', signDoc);
150-
console.log(signResponse.signed, signResponse.signature);
151-
```

0 commit comments

Comments
 (0)