Skip to content

Commit 9b27adc

Browse files
authored
Merge pull request #65 from idexo/zksynctest
added zksynctest and updated README
2 parents 6ba922f + ae0f0e7 commit 9b27adc

File tree

2 files changed

+29
-21
lines changed

2 files changed

+29
-21
lines changed

README.md

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ Idexo's multi-blockchain development SDK is the easiest way to create, deploy an
44

55
The SDK offers simplified methods that accomplish exactly what you are looking to do (i.e. leverage specific features) of different blockchains in your application.
66

7-
For example, upload plain text permanently to the Arweave permaweb:
7+
For example, creating a Royalty NFT collection that is capped to 100 NFTs to be deployed on your preferred blockchain network:
88

99
```javascript
1010
const ido = require("idexo-sdk")
1111

12-
const plainText = "Hello World"
13-
14-
ido.Storage.uploadPlain('arweave', plainText).then(res => console.log(res.data))
12+
ido.NFTs.createCappedRoyalty(apiKey, networkName, NFTCollectionName, NFTCollectionSymbol,
13+
RoyaltyCollectorWalletAddress, RoyaltyBasisPoints, 100) //100 is Cap value
14+
.then((res) => console.log(res.data))
1515
```
1616

1717
## Installing
@@ -28,6 +28,12 @@ Using yarn:
2828
$ yarn add idexo-sdk
2929
```
3030

31+
To use these methods you need credits that you can obtain in the idexo dashboard at https://app.idexo.io/register.
32+
33+
For information on how to purchase and use transaction and method credits with this SDK, see https://docs.idexo.com/master.
34+
35+
Find your API key under Account -> API.
36+
3137
## Available Methods
3238

3339
Methods below are categorized by the general use case.
@@ -136,25 +142,26 @@ getTransactionsByFunction(apiKey, function_name)
136142

137143
## Available Networks
138144

139-
The following mainnet networks are currently supported:
140-
141-
* Arbitrum
142-
* Arbitrum Nova
143-
* Arweave
144-
* Avalanche
145-
* BNBchain (fka Binance Smart Chain)
146-
* Dogechain
147-
* Ethereum
148-
* Fantom
149-
* Filecoin
150-
* OKC
151-
* Polygon
152-
* Solana
153-
* zkSync
145+
The following mainnet networks are currently supported [values to set for network in brackets]:
146+
147+
* Arbitrum [arbitrum]
148+
* Arbitrum Nova [arbitrumnova]
149+
* Arweave [arweave]
150+
* Avalanche [avalanche]
151+
* BNBchain (fka Binance Smart Chain) [bnbchain]
152+
* Dogechain [dogechain]
153+
* Ethereum [etherum]
154+
* Fantom [fantom]
155+
* Filecoin [filecoin]
156+
* OKC [okc]
157+
* Polygon [polygon]
158+
* Solana [solana]
159+
* zkSync [zksync]
154160

155161
The following testnet networks are currently supporded:
156162

157-
* Mumbai (polygon testnet)
163+
* Mumbai (polygon testnet) [mumbai]
164+
* zkSync Testnet [zksynctest]
158165

159166

160167
### Documentation

index.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ const chainURLs = {
1616
okc: "https://okc.idexo.io",
1717
polygon: "https://polygon.idexo.io",
1818
solana: "https://solana.idexo.io",
19-
utilsUrl: "https://transactions.idexo.io"
19+
utilsUrl: "https://transactions.idexo.io",
20+
zksynctest: "https://zksynctest.idexo.io"
2021
}
2122

2223
function headers(apiKey) {

0 commit comments

Comments
 (0)