@paymechain/sdk 1.0.0 → 1.0.2

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 (62) hide show
  1. package/README.md +40 -100
  2. package/dist/example.d.ts +2 -0
  3. package/dist/example.d.ts.map +1 -0
  4. package/dist/example.js +36 -0
  5. package/dist/example.js.map +1 -0
  6. package/dist/models/index.d.ts +24 -12
  7. package/dist/models/index.d.ts.map +1 -1
  8. package/dist/models/index.js +0 -8
  9. package/dist/models/index.js.map +1 -1
  10. package/dist/payme-client.d.ts +1 -18
  11. package/dist/payme-client.d.ts.map +1 -1
  12. package/dist/payme-client.js +6 -39
  13. package/dist/payme-client.js.map +1 -1
  14. package/dist/services/account.service.d.ts +22 -6
  15. package/dist/services/account.service.d.ts.map +1 -1
  16. package/dist/services/account.service.js +22 -13
  17. package/dist/services/account.service.js.map +1 -1
  18. package/dist/services/base.service.d.ts +5 -7
  19. package/dist/services/base.service.d.ts.map +1 -1
  20. package/dist/services/base.service.js +21 -28
  21. package/dist/services/base.service.js.map +1 -1
  22. package/dist/services/block.service.d.ts +8 -6
  23. package/dist/services/block.service.d.ts.map +1 -1
  24. package/dist/services/block.service.js +9 -7
  25. package/dist/services/block.service.js.map +1 -1
  26. package/dist/services/explorer.service.d.ts +14 -2
  27. package/dist/services/explorer.service.d.ts.map +1 -1
  28. package/dist/services/explorer.service.js +16 -4
  29. package/dist/services/explorer.service.js.map +1 -1
  30. package/dist/services/index.d.ts +0 -3
  31. package/dist/services/index.d.ts.map +1 -1
  32. package/dist/services/index.js +0 -3
  33. package/dist/services/index.js.map +1 -1
  34. package/dist/services/light-client.service.d.ts +14 -2
  35. package/dist/services/light-client.service.d.ts.map +1 -1
  36. package/dist/services/light-client.service.js +16 -4
  37. package/dist/services/light-client.service.js.map +1 -1
  38. package/dist/services/staking.service.d.ts +17 -4
  39. package/dist/services/staking.service.d.ts.map +1 -1
  40. package/dist/services/staking.service.js +21 -4
  41. package/dist/services/staking.service.js.map +1 -1
  42. package/dist/services/statistics.service.d.ts +5 -1
  43. package/dist/services/statistics.service.d.ts.map +1 -1
  44. package/dist/services/statistics.service.js +6 -2
  45. package/dist/services/statistics.service.js.map +1 -1
  46. package/dist/services/token.service.d.ts +11 -2
  47. package/dist/services/token.service.d.ts.map +1 -1
  48. package/dist/services/token.service.js +13 -4
  49. package/dist/services/token.service.js.map +1 -1
  50. package/dist/services/transaction.service.d.ts +14 -3
  51. package/dist/services/transaction.service.d.ts.map +1 -1
  52. package/dist/services/transaction.service.js +14 -4
  53. package/dist/services/transaction.service.js.map +1 -1
  54. package/dist/services/validator.service.d.ts +7 -5
  55. package/dist/services/validator.service.d.ts.map +1 -1
  56. package/dist/services/validator.service.js +9 -7
  57. package/dist/services/validator.service.js.map +1 -1
  58. package/dist/services/wallet.service.d.ts +35 -5
  59. package/dist/services/wallet.service.d.ts.map +1 -1
  60. package/dist/services/wallet.service.js +40 -9
  61. package/dist/services/wallet.service.js.map +1 -1
  62. package/package.json +2 -4
@@ -6,17 +6,19 @@ class ValidatorService {
6
6
  this.baseService = baseService;
7
7
  }
8
8
  /**
9
- * Retorna uma lista de todos os validadores ativos da rede, juntamente com suas informações de stake.
9
+ * Gets a list of all active validators in the network.
10
+ * @returns Array of ValidatorModel
10
11
  */
11
- async getAllValidators(language) {
12
- return this.baseService.get(`/api/validators`, {}, language);
12
+ async getAllValidators() {
13
+ return this.baseService.get(`/api/validator`);
13
14
  }
14
15
  /**
15
- * Retorna os detalhes de um validador específico pelo seu endereço.
16
- * @param address O endereço do validador a ser consultado.
16
+ * Gets the details of a specific validator by its address.
17
+ * @param address The address of the validator.
18
+ * @returns ValidatorModel
17
19
  */
18
- async getValidator(address, language) {
19
- return this.baseService.get(`/api/validators/${address}`, {}, language);
20
+ async getValidatorByAddress(address) {
21
+ return this.baseService.get(`/api/validator/${address}`);
20
22
  }
21
23
  }
22
24
  exports.ValidatorService = ValidatorService;
@@ -1 +1 @@
1
- {"version":3,"file":"validator.service.js","sourceRoot":"","sources":["../../src/services/validator.service.ts"],"names":[],"mappings":";;;AAIA,MAAa,gBAAgB;IAC3B,YAAoB,WAAwB;QAAxB,gBAAW,GAAX,WAAW,CAAa;IAAG,CAAC;IAEhD;;OAEG;IACH,KAAK,CAAC,gBAAgB,CAAC,QAAiB;QACtC,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAmB,iBAAiB,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;IACjF,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,OAAe,EAAE,QAAiB;QACnD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAiB,mBAAmB,OAAO,EAAE,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC1F,CAAC;CACF;AAjBD,4CAiBC"}
1
+ {"version":3,"file":"validator.service.js","sourceRoot":"","sources":["../../src/services/validator.service.ts"],"names":[],"mappings":";;;AAIA,MAAa,gBAAgB;IAC3B,YAAoB,WAAwB;QAAxB,gBAAW,GAAX,WAAW,CAAa;IAAG,CAAC;IAEhD;;;OAGG;IACH,KAAK,CAAC,gBAAgB;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAmB,gBAAgB,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,qBAAqB,CAAC,OAAe;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAiB,kBAAkB,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF;AAnBD,4CAmBC"}
@@ -1,11 +1,41 @@
1
1
  import { BaseService } from './base.service';
2
- import { CreateWalletViewModel, DeriveAddressRequest, SendTransactionRequest, TransactionIdViewModel, WalletTransactionHistoryViewModel } from '../models';
2
+ import { CreateWalletViewModel, DeriveAddressViewModel, // Corrected return type for deriveAddress
3
+ SendTransactionRequest, SubmitTransactionResponse, WalletAccountBalanceViewModel, // Assuming this is the return type for SendTransaction from the gateway
4
+ WalletTransactionHistoryViewModel } from '../models';
3
5
  export declare class WalletService {
4
6
  private baseService;
5
7
  constructor(baseService: BaseService);
6
- createWallet(language?: string): Promise<CreateWalletViewModel>;
7
- deriveAddress(request: DeriveAddressRequest, language?: string): Promise<CreateWalletViewModel>;
8
- getWalletHistory(address: string, tokenId: string, language?: string): Promise<WalletTransactionHistoryViewModel[]>;
9
- sendTransaction(request: SendTransactionRequest, language?: string): Promise<TransactionIdViewModel>;
8
+ /**
9
+ * Creates a new wallet.
10
+ * @returns CreateWalletViewModel
11
+ */
12
+ createWallet(): Promise<CreateWalletViewModel>;
13
+ /**
14
+ * Derives an address from a mnemonic phrase and index.
15
+ * @param mnemonic The mnemonic phrase.
16
+ * @param index The derivation index.
17
+ * @returns DeriveAddressViewModel
18
+ */
19
+ deriveAddress(mnemonic: string, index: number): Promise<DeriveAddressViewModel>;
20
+ /**
21
+ * Gets the balance for a specific wallet address.
22
+ * @param address The wallet address.
23
+ * @returns Array of WalletAccountBalanceViewModel
24
+ */
25
+ getWalletBalance(address: string): Promise<WalletAccountBalanceViewModel[]>;
26
+ /**
27
+ * Gets the transaction history for a specific wallet address and token ID.
28
+ * Note: This method is currently in AccountService in the .NET gateway, but logically belongs here.
29
+ * @param address The wallet address.
30
+ * @param tokenId The token identifier.
31
+ * @returns Array of WalletTransactionHistoryViewModel
32
+ */
33
+ getWalletHistory(address: string, tokenId: string): Promise<WalletTransactionHistoryViewModel[]>;
34
+ /**
35
+ * Sends a transaction from the wallet.
36
+ * @param request The send transaction request object.
37
+ * @returns SubmitTransactionResponse
38
+ */
39
+ sendTransaction(request: SendTransactionRequest): Promise<SubmitTransactionResponse>;
10
40
  }
11
41
  //# sourceMappingURL=wallet.service.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"wallet.service.d.ts","sourceRoot":"","sources":["../../src/services/wallet.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EACH,qBAAqB,EACrB,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACtB,iCAAiC,EACpC,MAAM,WAAW,CAAC;AAEnB,qBAAa,aAAa;IACZ,OAAO,CAAC,WAAW;gBAAX,WAAW,EAAE,WAAW;IAEtC,YAAY,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAI/D,aAAa,CAAC,OAAO,EAAE,oBAAoB,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAK/F,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iCAAiC,EAAE,CAAC;IAInH,eAAe,CAAC,OAAO,EAAE,sBAAsB,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;CAG3G"}
1
+ {"version":3,"file":"wallet.service.d.ts","sourceRoot":"","sources":["../../src/services/wallet.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EACH,qBAAqB,EACrB,sBAAsB,EAAE,0CAA0C;AAClE,sBAAsB,EACtB,yBAAyB,EAAE,6BAA6B,EAAE,wEAAwE;AAClI,iCAAiC,EACpC,MAAM,WAAW,CAAC;AAEnB,qBAAa,aAAa;IACZ,OAAO,CAAC,WAAW;gBAAX,WAAW,EAAE,WAAW;IAE5C;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAIpD;;;;;OAKG;IACG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAKrF;;;;OAIG;IACG,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,6BAA6B,EAAE,CAAC;IAIjF;;;;;;OAMG;IACG,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,iCAAiC,EAAE,CAAC;IAKtG;;;;OAIG;IACG,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,yBAAyB,CAAC;CAG3F"}
@@ -5,18 +5,49 @@ class WalletService {
5
5
  constructor(baseService) {
6
6
  this.baseService = baseService;
7
7
  }
8
- async createWallet(language) {
9
- return this.baseService.post('/api/wallet/create', {}, {}, language);
8
+ /**
9
+ * Creates a new wallet.
10
+ * @returns CreateWalletViewModel
11
+ */
12
+ async createWallet() {
13
+ return this.baseService.post('/api/wallet/create');
10
14
  }
11
- async deriveAddress(request, language) {
12
- // The endpoint returns the same shape as creating a new wallet, but without the mnemonic
13
- return this.baseService.post('/api/wallet/derive', request, {}, language);
15
+ /**
16
+ * Derives an address from a mnemonic phrase and index.
17
+ * @param mnemonic The mnemonic phrase.
18
+ * @param index The derivation index.
19
+ * @returns DeriveAddressViewModel
20
+ */
21
+ async deriveAddress(mnemonic, index) {
22
+ const params = { mnemonic, index };
23
+ return this.baseService.get('/api/wallet/derive-address', params);
14
24
  }
15
- async getWalletHistory(address, tokenId, language) {
16
- return this.baseService.get(`/api/wallet/${address}/history/${tokenId}`, {}, language);
25
+ /**
26
+ * Gets the balance for a specific wallet address.
27
+ * @param address The wallet address.
28
+ * @returns Array of WalletAccountBalanceViewModel
29
+ */
30
+ async getWalletBalance(address) {
31
+ return this.baseService.get(`/api/wallet/${address}/balance`);
17
32
  }
18
- async sendTransaction(request, language) {
19
- return this.baseService.post('/api/wallet/send', request, {}, language);
33
+ /**
34
+ * Gets the transaction history for a specific wallet address and token ID.
35
+ * Note: This method is currently in AccountService in the .NET gateway, but logically belongs here.
36
+ * @param address The wallet address.
37
+ * @param tokenId The token identifier.
38
+ * @returns Array of WalletTransactionHistoryViewModel
39
+ */
40
+ async getWalletHistory(address, tokenId) {
41
+ const params = { tokenId }; // Address is part of the path
42
+ return this.baseService.get(`/api/wallet/${address}/history/${tokenId}`, params);
43
+ }
44
+ /**
45
+ * Sends a transaction from the wallet.
46
+ * @param request The send transaction request object.
47
+ * @returns SubmitTransactionResponse
48
+ */
49
+ async sendTransaction(request) {
50
+ return this.baseService.post('/api/wallet/send-transaction', request);
20
51
  }
21
52
  }
22
53
  exports.WalletService = WalletService;
@@ -1 +1 @@
1
- {"version":3,"file":"wallet.service.js","sourceRoot":"","sources":["../../src/services/wallet.service.ts"],"names":[],"mappings":";;;AASA,MAAa,aAAa;IACxB,YAAoB,WAAwB;QAAxB,gBAAW,GAAX,WAAW,CAAa;IAAG,CAAC;IAEhD,KAAK,CAAC,YAAY,CAAC,QAAiB;QAClC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAwB,oBAAoB,EAAE,EAAE,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC9F,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAA6B,EAAE,QAAiB;QAClE,yFAAyF;QACzF,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAwB,oBAAoB,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;IACnG,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,OAAe,EAAE,OAAe,EAAE,QAAiB;QACxE,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAsC,eAAe,OAAO,YAAY,OAAO,EAAE,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC9H,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,OAA+B,EAAE,QAAiB;QACtE,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAyB,kBAAkB,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;IAClG,CAAC;CACF;AAnBD,sCAmBC"}
1
+ {"version":3,"file":"wallet.service.js","sourceRoot":"","sources":["../../src/services/wallet.service.ts"],"names":[],"mappings":";;;AASA,MAAa,aAAa;IACxB,YAAoB,WAAwB;QAAxB,gBAAW,GAAX,WAAW,CAAa;IAAG,CAAC;IAEhD;;;OAGG;IACH,KAAK,CAAC,YAAY;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAwB,oBAAoB,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,QAAgB,EAAE,KAAa;QACjD,MAAM,MAAM,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;QACnC,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAyB,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAC5F,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CAAC,OAAe;QACpC,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAkC,eAAe,OAAO,UAAU,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CAAC,OAAe,EAAE,OAAe;QACrD,MAAM,MAAM,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC,8BAA8B;QAC1D,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAsC,eAAe,OAAO,YAAY,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC;IACxH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAC,OAA+B;QACnD,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAA4B,8BAA8B,EAAE,OAAO,CAAC,CAAC;IACnG,CAAC;CACF;AAnDD,sCAmDC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@paymechain/sdk",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "Official TypeScript SDK for the PaymeChain blockchain. Provides a resilient, framework-agnostic client for interacting with network nodes, managing accounts, submitting transactions, and subscribing to real-time events.",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -35,9 +35,7 @@
35
35
  "access": "public"
36
36
  },
37
37
  "dependencies": {
38
- "@microsoft/signalr": "^8.0.0",
39
- "axios": "^1.6.2",
40
- "events": "^3.3.0"
38
+ "axios": "^1.6.2"
41
39
  },
42
40
  "devDependencies": {
43
41
  "@types/node": "^20.10.4",