consider adding `toURL` method to embed best practices of serializing cid to URL

Aperta
  • Qualcosa non va?
#71 4 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
api

Direzione di ricerca

Inizia dall’interfaccia CID e dai due esempi di URL nell’issue, quindi esamina l’implementazione CID e i test esistenti nel repository per identificare il punto di ingresso appropriato. Determina il comportamento previsto per gli URL ipfs predefiniti, la gestione delle versioni CID e gli URL gateway; l’issue è completa quando queste semantiche sono concordate e coperte dai test.

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

Descrizione

There had been various discussions about the fact that in the wild we see IPFS urls to specific gateways. I think we can bake a best practice into CID implementation by adding a method like:

interface CID {
  // ... stuff we already have
  /**
   * Encodes CID into a URL object.
   *
   * @example
   * ```js
   * const cid = CID.parse('QmbrRJJNKmPDUAZ8CGwn1WNx2C7xP4J284VWoAUDaCiLaD')
   * cid.toURL().href // 'ipfs://bafybeigizayotjo4whdurcq6ge7nrgfyxox7ji7oviesmnvgrnxn3nakni/'
   * ```
   * 
   * Optionally you could provide a gateway URL to encode CID to a URL in that gateway.
   * @example
   * ```js
   * const cid = CID.parse('QmbrRJJNKmPDUAZ8CGwn1WNx2C7xP4J284VWoAUDaCiLaD')
   * cid.toURL({ gateway: new URL('https://dweb.link') }).href
   * // => 'https://dweb.link/ipfs/bafybeigizayotjo4whdurcq6ge7nrgfyxox7ji7oviesmnvgrnxn3nakni'
   * ```
   */
  toURL(options?: { gateway?: URL }):URL
}

Note that here we reinforce several of the best practices:

  1. ipfs://${cidv1} is the default that we to see.
  2. We want to encourage CID v1 because it addresses bunch of issues that we have with v0.
  3. Gateways URLs are origin separated.
Lingua principale
TypeScript
Stelle
269
Fork
58
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di multiformats/js-multiformats

Tutte le issue di multiformats/js-multiformats

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.