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

SDK assumes networkID as tc if not specified.

Aberta
#405 0 comentários 1 reação 0 responsáveis Ver no GitHub
Linguagem predominante
TypeScript
Estrelas
26
Forks
14
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

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.

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Direção de pesquisa

Comece com o primeiro exemplo de construção do SDK na documentação do CodeChain SDK e inspecione o construtor do SDK ou a lógica de definição padrão de networkID referenciada pela issue. Confirme como o exemplo se comporta sem networkID e compare-o com o exemplo wc. A tarefa estará concluída quando a documentação ou o comportamento de definição padrão evitar claramente a confusão relatada sobre a seleção da rede.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
javascript, typescript
Domínio
api, documentation
Tipo de issue
Documentação
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
42/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.