ourzora / zdk

MIT License
107 stars 42 forks source link

Example docs are wrong/old? #80

Closed 0xTranqui closed 1 year ago

0xTranqui commented 1 year ago

@iainnash just discovered some issues in the example docs we provide on the readme for the zdk for getting set up.

this is what we have:

const zdk = new ZDK({ endpoint: API_ENDPOINT, networks: [ { chain: Chain.Mainnet, network: Network.Ethereum, }, ], apiKey: API_KEY // optional! );

this is what it should be:

const zdk = new ZDK({ endpoint: API_ENDPOINT, networks: [ { chain: ZDKChain.Mainnet, network: ZDKNetwork.Ethereum } ] })

notice that the current version is missing the "ZDK" tag on ZDKChain and ZDKNetwork. Wiithout those (what is currently shown on the readme) you are unable to identify the correct params

0xTranqui commented 1 year ago

just realized the formatting looked completely wrong on that comment ^ so adding screenshots here for further clarification

current:

Screen Shot 2022-10-01 at 11 45 03 PM

what it should be:

Screen Shot 2022-10-01 at 11 45 20 PM

iainnash commented 1 year ago

Fixed in #81