updates

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Linkdrop SDK
 
 ## 2.0.10
-- 
+- apiKey added
 
 ## 2.0.9
 - added src param to link (src=d)

README.md

@@ -1,4 +1,4 @@
-# Linkdrop SDK
+# Linkdrop Batch SDK
 
 Linkdrop provides tools to distribute NFTs with links, QR codes or claim codes. The Linkdrop SDK is a Typescript library that can be used to automate creating and managing claim links.   
 
@@ -24,19 +24,21 @@ Create a campaign using Linkdrop Dashboard. When creating a campaign you will ne
 
 First, import SDK into your code:
 ```ts
-import LinkdropSDK from 'linkdrop-sdk'
+import LinkdropBatchSDK from 'linkdrop-sdk'
 // or
 // const LinkdropSDK = require('linkdrop-sdk').default
 ```
 To use SDK on a tesnet:
 ```ts
+const apiKey = /* to request an API key, please contact us at [email protected] */
 // initializing Linkdrop SDK on a testnet (Goerli or Mumbai)
-const sdk = new LinkdropSDK({ mode: 'testnets' });
+const sdk = new LinkdropBatchSDK({ mode: 'testnets', apiKey });
 ```
 To use SDK on a production network (Ethereum Mainnet or Polygon): 
 ```ts
+const apiKey = /* to request an API key, please contact us at [email protected] */
 // initializing Linkdrop SDK on a production network 
-const sdk = new LinkdropSDK();
+const sdk = new LinkdropBatchSDK({ apiKey });
 ```
 
 ## Claim methods (Can be used on Front-end & Back-end)

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "linkdrop-sdk",
+  "name": "linkdrop-batch-sdk",
   "version": "2.0.10",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,18 +12,18 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/LinkdropHQ/linkdrop-sdk.git"
+    "url": "git+https://github.com/LinkdropHQ/linkdrop-batch-sdk.git"
   },
   "author": "spacehaz <[email protected]>",
   "license": "MIT",
   "description": "",
   "bugs": {
-    "url": "https://github.com/LinkdropHQ/linkdrop-sdk/issues"
+    "url": "https://github.com/LinkdropHQ/linkdrop-batch-sdk/issues"
   },
   "engines": {
     "node": ">=16.x"
   },
-  "homepage": "https://github.com/LinkdropHQ/linkdrop-sdk#readme",
+  "homepage": "https://github.com/LinkdropHQ/linkdrop-batch-sdk#readme",
   "keywords": [],
   "dependencies": {
     "@stablelib/x25519": "^1.0.3",

src/api/link/index.ts

@@ -10,7 +10,7 @@ const requests: TRequests = {
   ) => {
     const headers = defineRequestKeyHeader(apiKey)
 
-    return axios.get(`${apiHost}/api/v2/claim-links/${linkId}`)
+    return axios.get(`${apiHost}/api/v2/claim-links/${linkId}`, { headers })
   },
   getStatus: (
     apiHost,
@@ -19,7 +19,7 @@ const requests: TRequests = {
   ) => {
     const headers = defineRequestKeyHeader(apiKey)
 
-    return axios.get(`${apiHost}/api/v2/claim-links/${linkId}/status`)
+    return axios.get(`${apiHost}/api/v2/claim-links/${linkId}/status`, { headers })
   },
   deactivateLink: (
     apiHost,
@@ -54,7 +54,7 @@ const requests: TRequests = {
     return axios.post(`${apiHost}/api/v2/claim-links/${linkId}/claim`, {
       receiver_address: receiverAddress,
       receiver_signature: receiverSignature
-    })
+    }, { headers })
   }
 }
 

src/helpers/redeem-link.ts

@@ -5,13 +5,15 @@ import { signReceiverAddress } from '../utils'
 const redeemLink = async (
   code: string,
   receiverAddress: string,
-  apiHost: string
+  apiHost: string,
+  apiKey: string
 ) => {
   const linkKey = ethers.utils.id(code)
   const wallet = new ethers.Wallet(linkKey)
   const receiverSignature = await signReceiverAddress(wallet, receiverAddress)
   const claimLink = await linkApi.redeemLink(
     apiHost,
+    apiKey,
     wallet.address,
     receiverAddress,
     receiverSignature

src/modules/batch/index.ts

@@ -15,6 +15,7 @@ class Batch implements IBatch {
   claimHostUrl: string
   campaignData: TCampaignItem
   signerKey: string
+  apiKey: string
 
   constructor (
     batchId: string,
@@ -25,7 +26,8 @@ class Batch implements IBatch {
     campaignData: TCampaignItem,
     signerKey: string,
     campaignSig: string,
-    apiHost: string
+    apiHost: string,
+    apiKey: string
   ) {
     this.batchId = batchId
     this.data = data
@@ -36,6 +38,7 @@ class Batch implements IBatch {
     this.claimHostUrl = claimHostUrl
     this.campaignData = campaignData
     this.signerKey = signerKey
+    this.apiKey = apiKey
   }
 
   addLinks: TAddLinks = async (
@@ -66,6 +69,7 @@ class Batch implements IBatch {
     if (!transformedAssets) { return alert('Error with assets') }
     return await batchesApi.addLinks(
       this.apiHost,
+      this.apiKey,
       this.campaignSig,
       this.campaignData.campaign_id,
       this.batchId,

src/modules/campaign/index.ts

@@ -19,6 +19,7 @@ class Campaign implements ICampaign {
   apiHost: string
   claimHostUrl: string
   campaignSig: string
+  apiKey: string
 
   constructor (
     campaignId: string,
@@ -27,8 +28,11 @@ class Campaign implements ICampaign {
     data: TCampaignItem,
     claimHostUrl: string,
     campaignSig: string,
-    apiHost: string
+    apiHost: string,
+    apiKey: string
+
   ) {
+    this.apiKey = apiKey
     this.campaignId = campaignId
     this.signerKey = signerKey
     this.encryptionKey = encryptionKey
@@ -41,6 +45,7 @@ class Campaign implements ICampaign {
   getBatches: TGetBatches = async () => {
     const campaignData = await batchesApi.getBatches(
       this.apiHost,
+      this.apiKey,
       this.campaignSig,
       this.campaignId
     )
@@ -59,6 +64,7 @@ class Campaign implements ICampaign {
   ) => {
     const campaignData = await batchesApi.getBatch(
       this.apiHost,
+      this.apiKey,
       this.campaignSig,
       this.campaignId,
       batchId
@@ -75,7 +81,8 @@ class Campaign implements ICampaign {
         this.data,
         this.signerKey,
         this.campaignSig,
-        this.apiHost
+        this.apiHost,
+        this.apiKey
       )
     }
   }
@@ -110,6 +117,7 @@ class Campaign implements ICampaign {
     if (!transformedAssets) { return alert('Error with assets') }
     const response = await batchesApi.createBatch(
       this.apiHost,
+      this.apiKey,
       this.campaignSig,
       this.data.campaign_id,
       transformedAssets,
@@ -139,6 +147,7 @@ class Campaign implements ICampaign {
 
     const linkData = await linkApi.reactivateLink(
       this.apiHost,
+      this.apiKey,
       this.campaignSig,
       wallet.address
     )
@@ -157,6 +166,7 @@ class Campaign implements ICampaign {
 
     const linkData = await linkApi.deactivateLink(
       this.apiHost,
+      this.apiKey,
       this.campaignSig,
       wallet.address
     )

src/modules/linkdrop-sdk/index.ts

@@ -14,6 +14,8 @@ class LinkdropSDK implements ILinkdropSDK {
   chain: TNetworkName
   apiHost: string
   claimHostUrl: string
+  apiKey: string
+
   utils = {
     createLink,
     computeProxyAddress,
@@ -23,13 +25,20 @@ class LinkdropSDK implements ILinkdropSDK {
   constructor ({
     apiHost,
     mode,
-    claimHostUrl
+    claimHostUrl,
+    apiKey
   }: {
+    apiKey?: string,
     apiHost?: string,
     mode?: 'testnets',
     claimHostUrl?: string
   } = {}) {
     this.claimHostUrl = claimHostUrl || ''
+    if (!apiKey) {
+      throw new Error('ApiKey required')
+    } else {
+      this.apiKey = apiKey
+    }
     if (apiHost) {
       this.apiHost = apiHost
     } else {
@@ -58,6 +67,7 @@ class LinkdropSDK implements ILinkdropSDK {
     )
     const campaignData = await campaignsApi.getCampaign(
       this.apiHost,
+      this.apiKey,
       campaignSig,
       campaignId
     )
@@ -71,7 +81,8 @@ class LinkdropSDK implements ILinkdropSDK {
         campaign,
         this.claimHostUrl,
         campaignSig,
-        this.apiHost
+        this.apiHost,
+        this.apiKey
       )
     }
   }
@@ -82,7 +93,8 @@ class LinkdropSDK implements ILinkdropSDK {
     const result = await redeemLink(
       claimCode,
       destination,
-      this.apiHost
+      this.apiHost,
+      this.apiKey,
     )
     if (!result) {
       throw new Error('Link claim failed')
@@ -98,6 +110,7 @@ class LinkdropSDK implements ILinkdropSDK {
   ) {
     return await getLinkParams(
       this.apiHost,
+      this.apiKey,
       claimCode
     )
   }
@@ -107,6 +120,7 @@ class LinkdropSDK implements ILinkdropSDK {
   ) {
     const result = await getLinkStatus(
       this.apiHost,
+      this.apiKey,
       claimCode
     )
     if (!result) {