emblem-vault-sdk 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/bundle.js CHANGED
@@ -684189,7 +684189,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
684189
684189
  };
684190
684190
  Object.defineProperty(exports, "__esModule", { value: true });
684191
684191
  const utils_1 = require("./utils");
684192
- const SDK_VERSION = '1.0.0';
684192
+ const SDK_VERSION = '1.1.0';
684193
684193
  class EmblemVaultSDK {
684194
684194
  constructor(apiKey, baseUrl) {
684195
684195
  this.apiKey = apiKey;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "emblem-vault-sdk",
3
- "version": "1.0.0",
3
+ "version": "1.1.0",
4
4
  "description": "",
5
5
  "main": "dist/index.js",
6
6
  "scripts": {
package/readme.md ADDED
@@ -0,0 +1,52 @@
1
+ # Emblem Vault SDK
2
+
3
+ This SDK provides a set of tools to interact with the Emblem Vault API. It includes methods for fetching curated contracts, creating vaults, and fetching metadata.
4
+
5
+ ## Installation
6
+
7
+ ```
8
+ npm i emblem-vault-sdk
9
+ ```
10
+
11
+ ## Getting Started
12
+ ```
13
+ const EmblemVaultSDK = require('emblem-vault-sdk');
14
+ const apiKey = 'YOUR_API_KEY'; // replace with your actual API key
15
+
16
+ const sdk = new EmblemVaultSDK(apiKey);
17
+ ```
18
+
19
+ ## SDK Methods
20
+ ```javascript
21
+ // Fetch curated contracts
22
+ sdk.fetchCuratedContracts().then(contracts => {
23
+ console.log(contracts);
24
+ });
25
+
26
+ // Select a contract create template
27
+ sdk.fetchCuratedContracts().then(contracts => {
28
+ const contract = contracts.find(contract => contract.name === "Ethscriptions");
29
+ const template = contract.generateCreateTemplate(contract);
30
+ console.log(template);
31
+ });
32
+
33
+ // Create a curated vault
34
+ const template = {}; // replace with your actual template
35
+ sdk.createCuratedVault(template).then(vault => {
36
+ console.log(vault);
37
+ });
38
+
39
+ // Fetch metadata
40
+ const tokenId = 'YOUR_TOKEN_ID'; // replace with your actual token id
41
+ sdk.fetchMetadata(tokenId).then(metadata => {
42
+ console.log(metadata);
43
+ });
44
+ ```
45
+
46
+ ## Simple Html Demo
47
+
48
+ <a href="./demos/index.html">Simple HTML Demo</a>
49
+
50
+
51
+
52
+