CodeChain-io / CodeChain-io/codechain-sdk-js

SDK assumes networkID as tc if not specified.

Aperta
#405 0 commenti 1 reazione 0 assegnatari Vedi su GitHub
Lingua principale
TypeScript
Stelle
26
Fork
14
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Assuming `tc` as default `networkID` is not problem.

But in the first example code of [codechain sdk document](https://api.codechain.io/2.0.1/index.html),
`networkID` is not specified while constructing SDK object.

This might cause confusion because sdk also assumes `networkID` as `tc` in the case below.
```javascript
var sdk = new SDK({ server: "https://corgi-rpc.codechain.io" });
```

To set networkId to `wc`, we should specify it
```javascript
var sdk = new SDK({ server: "https://corgi-rpc.codechain.io"
networkId: "wc"});
```

So I think we should change document or change assuming logic.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Inizia con il primo esempio di costruzione dell’SDK nella documentazione di CodeChain SDK e ispeziona il costruttore dell’SDK o la logica di assegnazione predefinita di networkID a cui fa riferimento l’issue. Verifica come si comporta l’esempio senza networkID e confrontalo con l’esempio wc. Il lavoro è completato quando la documentazione o il comportamento di assegnazione predefinita evita chiaramente la confusione segnalata sulla selezione della rete.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, typescript
Ambito
api, documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.