@arcblock/nft 1.15.6 → 1.16.1

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.
Files changed (3) hide show
  1. package/README.md +7 -4
  2. package/lib/index.d.ts +43 -159
  3. package/package.json +7 -7
package/README.md CHANGED
@@ -6,12 +6,13 @@
6
6
 
7
7
  > Utility to create standard assets that can be rendered in [DID Wallet](https://www.abtwallet.io)
8
8
 
9
+
9
10
  ## Table of Contents
10
11
 
11
- - [Table of Contents](#table-of-contents)
12
- - [Install](#install)
13
- - [Usage](#usage)
14
- - [Documentation](#documentation)
12
+ * [Install](#install)
13
+ * [Usage](#usage)
14
+ * [Documentation](#documentation)
15
+
15
16
 
16
17
  ## Install
17
18
 
@@ -21,6 +22,7 @@ npm install @arcblock/nft
21
22
  yarn add @arcblock/nft
22
23
  ```
23
24
 
25
+
24
26
  ## Usage
25
27
 
26
28
  ```js
@@ -58,6 +60,7 @@ const [asset, hash] = await factory.createTicket({
58
60
  });
59
61
  ```
60
62
 
63
+
61
64
  ## Documentation
62
65
 
63
66
  For full documentation, checkout [https://asset-chain.netlify.com](https://asset-chain.netlify.com/)
package/lib/index.d.ts CHANGED
@@ -1,8 +1,6 @@
1
1
  // Generate by [js2dts@0.3.3](https://github.com/whxaxes/js2dts#readme)
2
2
 
3
3
  declare class NFTIssuer {
4
- wallet: any;
5
- attributes: _Lib.T104;
6
4
  /**
7
5
  * Creates an instance of NFTIssuer.
8
6
  *
@@ -13,11 +11,11 @@ declare class NFTIssuer {
13
11
  * @param {string} attributes.logo - issuer logo image url or logo base64
14
12
  */
15
13
  constructor(T102: _Lib.T103);
14
+ wallet: any;
15
+ attributes: _Lib.T104;
16
16
  toJSON(): _Lib.T105;
17
17
  }
18
18
  declare class NFTRecipient {
19
- wallet: any;
20
- attributes: _Lib.T108;
21
19
  /**
22
20
  * Creates an instance of NFTRecipient.
23
21
  *
@@ -27,146 +25,10 @@ declare class NFTRecipient {
27
25
  * @param {string} attributes.location - recipient website
28
26
  */
29
27
  constructor(T106: _Lib.T107);
28
+ wallet: any;
29
+ attributes: _Lib.T108;
30
30
  toJSON(): _Lib.T109;
31
31
  }
32
- declare class GraphQLClient {
33
- config: any;
34
- schema: void;
35
- constructor(httpEndpoint: string);
36
- getQueries(): string[];
37
- getSubscriptions(): string[];
38
- getMutations(): string[];
39
- /**
40
- * Send raw query to forge and return results
41
- *
42
- * @param {*} query
43
- * @memberof GraphQLClient
44
- * @return Promise
45
- */
46
- doRawQuery(query: any, requestOptions?: any): Promise<any>;
47
- doRawSubscription(query: any): Promise<any>;
48
- doBatchQuery(queries: object, requestOptions?: any): Promise<object>;
49
- fromUnitToToken(value: string): Promise<string>;
50
- fromTokenToUnit(amount: number): Promise<any>;
51
- getTxSendMethods(): string[];
52
- getTxSignMethods(): string[];
53
- getTxMultiSignMethods(): string[];
54
- getType(x: string): Object;
55
- decodeTx(input: string | any): object;
56
- declare(params: object, extra: any): Promise<string>;
57
- migrateAccount(params: object, extra: any): Promise<string>;
58
- delegate(params: object, extra: any): Promise<string>;
59
- revokeDelegate(params: object, extra: any): Promise<string>;
60
- createAsset(params: object, extra: any): Promise<string>;
61
- updateAsset(params: object, extra: any): Promise<string>;
62
- consumeAsset(params: object, extra: any): Promise<string>;
63
- createAssetFactory(params: object, extra: any): Promise<string>;
64
- acquireAsset(params: object, extra: any): Promise<string>;
65
- upgradeNode(params: object, extra: any): Promise<string>;
66
- transfer(params: object, extra: any): Promise<string>;
67
- prepareExchange(params: object, extra: any): Promise<string>;
68
- finalizeExchange(params: object, extra: any): Promise<string>;
69
- exchange(params: object, extra: any): Promise<string>;
70
- generateQueryFns(): void;
71
- generateSubscriptionFns(): void;
72
- generateMutationFns(): void;
73
- sendAcquireAssetV2Tx(param: TxParam<AcquireAssetV2Tx>): Promise<ResponseSendTx>;
74
- sendCreateAssetTx(param: TxParam<CreateAssetTx>): Promise<ResponseSendTx>;
75
- sendCreateFactoryTx(param: TxParam<CreateFactoryTx>): Promise<ResponseSendTx>;
76
- sendMintAssetTx(param: TxParam<MintAssetTx>): Promise<ResponseSendTx>;
77
- sendUpdateAssetTx(param: TxParam<UpdateAssetTx>): Promise<ResponseSendTx>;
78
- sendAccountMigrateTx(param: TxParam<AccountMigrateTx>): Promise<ResponseSendTx>;
79
- sendApproveWithdrawTx(param: TxParam<any>): Promise<ResponseSendTx>;
80
- sendCreateTokenTx(param: TxParam<CreateTokenTx>): Promise<ResponseSendTx>;
81
- sendDeclareTx(param: TxParam<DeclareTx>): Promise<ResponseSendTx>;
82
- sendDelegateTx(param: TxParam<DelegateTx>): Promise<ResponseSendTx>;
83
- sendDepositTokenV2Tx(param: TxParam<any>): Promise<ResponseSendTx>;
84
- sendExchangeTx(param: TxParam<ExchangeTx>): Promise<ResponseSendTx>;
85
- sendExchangeV2Tx(param: TxParam<ExchangeV2Tx>): Promise<ResponseSendTx>;
86
- sendRevokeDelegateTx(param: TxParam<RevokeDelegateTx>): Promise<ResponseSendTx>;
87
- sendRevokeWithdrawTx(param: TxParam<any>): Promise<ResponseSendTx>;
88
- sendTransferTx(param: TxParam<TransferTx>): Promise<ResponseSendTx>;
89
- sendTransferV2Tx(param: TxParam<TransferV2Tx>): Promise<ResponseSendTx>;
90
- sendUpdateConsensusParamsTx(param: TxParam<any>): Promise<ResponseSendTx>;
91
- sendUpgradeNodeTx(param: TxParam<UpgradeNodeTx>): Promise<ResponseSendTx>;
92
- sendWithdrawTokenV2Tx(param: TxParam<any>): Promise<ResponseSendTx>;
93
- encodeAcquireAssetV2Tx(param: TxParam<AcquireAssetV2Tx>): Promise<EncodeTxResult>;
94
- encodeCreateAssetTx(param: TxParam<CreateAssetTx>): Promise<EncodeTxResult>;
95
- encodeCreateFactoryTx(param: TxParam<CreateFactoryTx>): Promise<EncodeTxResult>;
96
- encodeMintAssetTx(param: TxParam<MintAssetTx>): Promise<EncodeTxResult>;
97
- encodeUpdateAssetTx(param: TxParam<UpdateAssetTx>): Promise<EncodeTxResult>;
98
- encodeAccountMigrateTx(param: TxParam<AccountMigrateTx>): Promise<EncodeTxResult>;
99
- encodeApproveWithdrawTx(param: TxParam<any>): Promise<EncodeTxResult>;
100
- encodeCreateTokenTx(param: TxParam<CreateTokenTx>): Promise<EncodeTxResult>;
101
- encodeDeclareTx(param: TxParam<DeclareTx>): Promise<EncodeTxResult>;
102
- encodeDelegateTx(param: TxParam<DelegateTx>): Promise<EncodeTxResult>;
103
- encodeDepositTokenTx(param: TxParam<any>): Promise<EncodeTxResult>;
104
- encodeExchangeTx(param: TxParam<ExchangeTx>): Promise<EncodeTxResult>;
105
- encodeExchangeV2Tx(param: TxParam<ExchangeV2Tx>): Promise<EncodeTxResult>;
106
- encodeRevokeDelegateTx(param: TxParam<RevokeDelegateTx>): Promise<EncodeTxResult>;
107
- encodeRevokeWithdrawTx(param: TxParam<any>): Promise<EncodeTxResult>;
108
- encodeTransferTx(param: TxParam<TransferTx>): Promise<EncodeTxResult>;
109
- encodeTransferV2Tx(param: TxParam<TransferV2Tx>): Promise<EncodeTxResult>;
110
- encodeUpdateConsensusParamsTx(param: TxParam<any>): Promise<EncodeTxResult>;
111
- encodeUpgradeNodeTx(param: TxParam<UpgradeNodeTx>): Promise<EncodeTxResult>;
112
- encodeWithdrawTokenTx(param: TxParam<any>): Promise<EncodeTxResult>;
113
- signAcquireAssetV2Tx(param: TxParam<AcquireAssetV2Tx>): Promise<Transaction>;
114
- signCreateAssetTx(param: TxParam<CreateAssetTx>): Promise<Transaction>;
115
- signCreateFactoryTx(param: TxParam<CreateFactoryTx>): Promise<Transaction>;
116
- signMintAssetTx(param: TxParam<MintAssetTx>): Promise<Transaction>;
117
- signUpdateAssetTx(param: TxParam<UpdateAssetTx>): Promise<Transaction>;
118
- signAccountMigrateTx(param: TxParam<AccountMigrateTx>): Promise<Transaction>;
119
- signApproveWithdrawTx(param: TxParam<any>): Promise<Transaction>;
120
- signCreateTokenTx(param: TxParam<CreateTokenTx>): Promise<Transaction>;
121
- signDeclareTx(param: TxParam<DeclareTx>): Promise<Transaction>;
122
- signDelegateTx(param: TxParam<DelegateTx>): Promise<Transaction>;
123
- signDepositTokenV2Tx(param: TxParam<any>): Promise<Transaction>;
124
- signExchangeTx(param: TxParam<ExchangeTx>): Promise<Transaction>;
125
- signExchangeV2Tx(param: TxParam<ExchangeV2Tx>): Promise<Transaction>;
126
- signRevokeDelegateTx(param: TxParam<RevokeDelegateTx>): Promise<Transaction>;
127
- signRevokeWithdrawTx(param: TxParam<any>): Promise<Transaction>;
128
- signTransferTx(param: TxParam<TransferTx>): Promise<Transaction>;
129
- signTransferV2Tx(param: TxParam<TransferV2Tx>): Promise<Transaction>;
130
- signUpdateConsensusParamsTx(param: TxParam<any>): Promise<Transaction>;
131
- signUpgradeNodeTx(param: TxParam<UpgradeNodeTx>): Promise<Transaction>;
132
- signWithdrawTokenV2Tx(param: TxParam<any>): Promise<Transaction>;
133
- multiSignExchangeTx(param: TxParam<ExchangeTx>): Promise<Transaction>;
134
- multiSignExchangeV2Tx(param: TxParam<ExchangeV2Tx>): Promise<Transaction>;
135
- getAccountState(params: GetAccountStateParams): QueryResult<ResponseGetAccountState>;
136
- getAssetState(params: GetAssetStateParams): QueryResult<ResponseGetAssetState>;
137
- getFactoryState(params: GetFactoryStateParams): QueryResult<ResponseGetFactoryState>;
138
- getDelegateState(params: GetDelegateStateParams): QueryResult<ResponseGetDelegateState>;
139
- getTokenState(params: GetTokenStateParams): QueryResult<ResponseGetTokenState>;
140
- getSwapState(params: GetSwapStateParams): QueryResult<ResponseGetSwapState>;
141
- getForgeState(params: GetForgeStateParams): QueryResult<ResponseGetForgeState>;
142
- getTx(params: GetTxParams): QueryResult<ResponseGetTx>;
143
- getBlock(params: GetBlockParams): QueryResult<ResponseGetBlock>;
144
- getBlocks(params: GetBlocksParams): QueryResult<ResponseGetBlocks>;
145
- getUnconfirmedTxs(params: GetUnconfirmedTxsParams): QueryResult<ResponseGetUnconfirmedTxs>;
146
- getChainInfo(): QueryResult<ResponseGetChainInfo>;
147
- getConfig(params: GetConfigParams): QueryResult<ResponseGetConfig>;
148
- getHealthStatus(): QueryResult<ResponseGetHealthStatus>;
149
- getNetInfo(): QueryResult<ResponseGetNetInfo>;
150
- getNodeInfo(): QueryResult<ResponseGetNodeInfo>;
151
- getValidatorsInfo(): QueryResult<ResponseGetValidatorsInfo>;
152
- getForgeStats(): QueryResult<ResponseGetForgeStats>;
153
- getForgeStatsByDay(params: GetForgeStatsByDayParams): QueryResult<ResponseGetForgeStats>;
154
- getForgeStatsByHour(params: GetForgeStatsByHourParams): QueryResult<ResponseGetForgeStats>;
155
- getSwapStatistics(params: GetSwapStatisticsParams): QueryResult<ResponseGetSwapStatistics>;
156
- listAssetTransactions(params: ListAssetTransactionsParams): QueryResult<ResponseListAssetTransactions>;
157
- listAssets(params: ListAssetsParams): QueryResult<ResponseListAssets>;
158
- listBlocks(params: ListBlocksParams): QueryResult<ResponseListBlocks>;
159
- listStakes(params: ListStakesParams): QueryResult<ResponseListStakes>;
160
- listSwap(params: ListSwapParams): QueryResult<ResponseListSwap>;
161
- listTopAccounts(params: ListTopAccountsParams): QueryResult<ResponseListTopAccounts>;
162
- listTransactions(params: ListTransactionsParams): QueryResult<ResponseListTransactions>;
163
- listTokens(params: ListTokensParams): QueryResult<ResponseListTokens>;
164
- listFactories(params: ListFactoriesParams): QueryResult<ResponseListFactories>;
165
- getAccountTokens(params: GetAccountTokensParams): QueryResult<ResponseGetAccountTokens>;
166
- sendTx(params: SendTxParams): QueryResult<ResponseSendTx>;
167
- unsubscribe(params: UnsubscribeParams): QueryResult<ResponseUnsubscribe>;
168
- subscribe(params: SubscribeParams): SubscriptionResult<ResponseSubscribe>;
169
- }
170
32
  /**
171
33
  * Used to create standard asset on forge powered blockchain
172
34
  * All assets are signed assets, eg, the asset data are self approvable
@@ -174,10 +36,6 @@ declare class GraphQLClient {
174
36
  * @class NFTFactory
175
37
  */
176
38
  declare class NFTFactory {
177
- chainHost: string;
178
- client: GraphQLClient;
179
- wallet: any;
180
- issuer: NFTIssuer;
181
39
  /**
182
40
  * Creates an instance of NFTFactory.
183
41
  * @param {object} params
@@ -187,6 +45,10 @@ declare class NFTFactory {
187
45
  * @memberof NFTFactory
188
46
  */
189
47
  constructor(T110: _Lib.T111);
48
+ chainHost: string;
49
+ client: Client;
50
+ wallet: any;
51
+ issuer: NFTIssuer_1;
190
52
  /**
191
53
  * Create a ticket
192
54
  *
@@ -225,7 +87,7 @@ declare class NFTFactory {
225
87
  * Create a coupon asset
226
88
  *
227
89
  * @param {object} params
228
- * @param {string} params.display - display of the certificate { type, content }
90
+ * @param {string} params.display - display of the coupon { type, content }
229
91
  * @param {object} params.data - asset payload
230
92
  * @param {string} params.data.name - certificate name
231
93
  * @param {string} params.data.description - certificate description
@@ -243,7 +105,7 @@ declare class NFTFactory {
243
105
  * Create a badge
244
106
  *
245
107
  * @param {object} params
246
- * @param {string} params.display - display of the certificate { type, content }
108
+ * @param {string} params.display - display of the badge { type, content }
247
109
  * @param {object} params.data - asset payload
248
110
  * @param {string} params.data.name - certificate name
249
111
  * @param {string} params.data.description - certificate description
@@ -253,10 +115,24 @@ declare class NFTFactory {
253
115
  * @memberof NFTFactory
254
116
  */
255
117
  createBadge(T121: _Lib.T123): Promise<any>;
118
+ /**
119
+ * Create a passport
120
+ *
121
+ * @param {object} params
122
+ * @param {string} params.display - display of the passport { type, content }
123
+ * @param {object} params.passport - asset payload
124
+ * @param {string} params.passport.name - passport name
125
+ * @param {string} params.passport.title - passport title
126
+ * @param {NFTRecipient} params.data.recipient - certificate recipient
127
+ * @param {object} params.attributes - asset attributes
128
+ * @returns {Promise} - the `[asset, hash]` on resolved
129
+ * @memberof NFTFactory
130
+ */
131
+ createPassport(T124: _Lib.T126): Promise<any>;
256
132
  createSignedAsset(payload: any, attributes: any): Promise<any[]>;
257
133
  getVCBody(asset: any): any;
258
134
  }
259
- declare const _Lib: _Lib.T124;
135
+ declare const _Lib: _Lib.T127;
260
136
  declare namespace _Lib {
261
137
  export interface T100 {
262
138
  normal: number;
@@ -292,7 +168,7 @@ declare namespace _Lib {
292
168
  url: string;
293
169
  logo: string;
294
170
  did: any;
295
- pk: any;
171
+ pk: string;
296
172
  }
297
173
  export interface T107 {
298
174
  wallet: any;
@@ -307,12 +183,12 @@ declare namespace _Lib {
307
183
  name: string;
308
184
  location: string;
309
185
  did: any;
310
- pk: any;
186
+ pk: string;
311
187
  }
312
188
  export interface T111 {
313
189
  chainHost: string;
314
190
  wallet: any;
315
- issuer: any;
191
+ issuer: object;
316
192
  }
317
193
  export interface T113 {
318
194
  name: string;
@@ -324,7 +200,7 @@ declare namespace _Lib {
324
200
  export interface T114 {
325
201
  display: string;
326
202
  data: _Lib.T113;
327
- attributes: any;
203
+ attributes: object;
328
204
  }
329
205
  export interface T116 {
330
206
  name: string;
@@ -338,33 +214,41 @@ declare namespace _Lib {
338
214
  export interface T117 {
339
215
  display: string;
340
216
  data: _Lib.T116;
341
- attributes: any;
217
+ attributes: object;
342
218
  }
343
219
  export interface T119 {
344
220
  name: string;
345
221
  description: string;
346
222
  reason: string;
347
223
  logoUrl: string;
348
- recipient: NFTRecipient;
224
+ recipient: NFTRecipient_1;
349
225
  issueTime: number;
350
226
  expireTime: number;
351
227
  }
352
228
  export interface T120 {
353
229
  display: string;
354
230
  data: _Lib.T119;
355
- attributes: any;
231
+ attributes: object;
356
232
  }
357
233
  export interface T122 {
358
234
  name: string;
359
235
  description: string;
360
- recipient: NFTRecipient;
236
+ recipient: NFTRecipient_1;
361
237
  }
362
238
  export interface T123 {
363
239
  display: string;
364
240
  data: _Lib.T122;
365
- attributes: any;
241
+ attributes: object;
242
+ }
243
+ export interface T125 {
244
+ name: string;
245
+ title: string;
246
+ }
247
+ export interface T126 {
248
+ display: string;
249
+ passport: _Lib.T125;
366
250
  }
367
- export interface T124 {
251
+ export interface T127 {
368
252
  NFTStatus: Readonly<_Lib.T100>;
369
253
  NFTType: Readonly<_Lib.T101>;
370
254
  NFTIssuer: typeof NFTIssuer;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@arcblock/nft",
3
3
  "description": "Utility to create standard asset on forge powered blockchain",
4
- "version": "1.15.6",
4
+ "version": "1.16.1",
5
5
  "author": {
6
6
  "name": "wangshijun",
7
7
  "email": "shijun@arcblock.io",
@@ -15,11 +15,11 @@
15
15
  "access": "public"
16
16
  },
17
17
  "dependencies": {
18
- "@arcblock/did-util": "1.15.6",
19
- "@arcblock/vc": "1.15.6",
20
- "@ocap/client": "1.15.6",
21
- "@ocap/util": "1.15.6",
22
- "@ocap/wallet": "1.15.6",
18
+ "@arcblock/did-util": "1.16.1",
19
+ "@arcblock/vc": "1.16.1",
20
+ "@ocap/client": "1.16.1",
21
+ "@ocap/util": "1.16.1",
22
+ "@ocap/wallet": "1.16.1",
23
23
  "debug": "^4.3.3",
24
24
  "json-stable-stringify": "^1.0.1",
25
25
  "lodash": "^4.17.21",
@@ -70,5 +70,5 @@
70
70
  "test": "jest --forceExit --detectOpenHandles",
71
71
  "coverage": "yarn test -- --coverage"
72
72
  },
73
- "gitHead": "866970f65d02e32255f909a3e3a5d1d3a87ec89a"
73
+ "gitHead": "9d396112e1a0bdabea753d6104117ca9e1fede26"
74
74
  }