@taquito/rpc 20.2.0-beta.0 → 21.0.0-beta.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.
@@ -15,6 +15,9 @@ var RPCMethodName;
15
15
  RPCMethodName["GET_BLOCK_HEADER"] = "getBlockHeader";
16
16
  RPCMethodName["GET_BLOCK_METADATA"] = "getBlockMetadata";
17
17
  RPCMethodName["GET_BALANCE"] = "getBalance";
18
+ RPCMethodName["GET_SPENDABLE"] = "getSpendable";
19
+ RPCMethodName["GET_BALANCE_AND_FROZEN_BONDS"] = "getBalanceAndFrozenBonds";
20
+ RPCMethodName["GET_SPENDABLE_AND_FROZEN_BONDS"] = "getSpendableAndFrozenBonds";
18
21
  RPCMethodName["GET_FULL_BALANCE"] = "getFullBalance";
19
22
  RPCMethodName["GET_STAKED_BALANCE"] = "getStakedBalance";
20
23
  RPCMethodName["GET_UNSTAKED_FINALIZABLE_BALANCE"] = "getUnstakedFinalizableBalance";
@@ -35,7 +35,7 @@ class RpcClientCache {
35
35
  * @param rpcClient rpcClient responsible of the interaction with Tezos network through an rpc node
36
36
  * @param ttl number representing the time to live (default 1000 milliseconds)
37
37
  *
38
- * @example new RpcClientCache(new RpcClient('https://mainnet.ecadinfra.com/'))
38
+ * @example new RpcClientCache(new RpcClient('https://mainnet.tezos.ecadinfra.com/'))
39
39
  */
40
40
  constructor(rpcClient, ttl = defaultTtl) {
41
41
  this.rpcClient = rpcClient;
@@ -136,9 +136,9 @@ class RpcClientCache {
136
136
  });
137
137
  }
138
138
  /**
139
- * @param address address from which we want to retrieve the balance
139
+ * @param address address from which we want to retrieve the spendable balance
140
140
  * @param options contains generic configuration for rpc calls to specified block (default to head)
141
- * @description Access the spendable balance of a contract, excluding frozen bonds
141
+ * @description The spendable balance of a contract (in mutez), also known as liquid balance. Corresponds to tez owned by the contract that are neither staked, nor in unstaked requests, nor in frozen bonds. Identical to the 'spendable' RPC.
142
142
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-balance
143
143
  */
144
144
  getBalance(address_1) {
@@ -158,6 +158,66 @@ class RpcClientCache {
158
158
  }
159
159
  });
160
160
  }
161
+ /**
162
+ * @param address address from which we want to retrieve the balance
163
+ * @param options contains generic configuration for rpc calls to specified block (default to head)
164
+ * @description The spendable balance of a contract (in mutez), also known as liquid balance. Corresponds to tez owned by the contract that are neither staked, nor in unstaked requests, nor in frozen bonds. Identical to the 'balance' RPC.
165
+ */
166
+ getSpendable(address_1) {
167
+ return __awaiter(this, arguments, void 0, function* (address, { block } = rpc_client_interface_2.defaultRPCOptions) {
168
+ this.validateAddress(address);
169
+ const key = this.formatCacheKey(this.rpcClient.getRpcUrl(), rpc_client_interface_1.RPCMethodName.GET_SPENDABLE, [
170
+ block,
171
+ address,
172
+ ]);
173
+ if (this.has(key)) {
174
+ return this.get(key);
175
+ }
176
+ else {
177
+ const response = this.rpcClient.getSpendable(address, { block });
178
+ this.put(key, response);
179
+ return response;
180
+ }
181
+ });
182
+ }
183
+ /**
184
+ * @param address address from which we want to retrieve balance and frozen bonds
185
+ * @param options contains generic configuration for rpc calls to specified block (default to head)
186
+ * @description The sum (in mutez) of the spendable balance and frozen bonds of a contract. Corresponds to the contract's full balance from which staked funds and unstake requests have been excluded. Identical to the 'spendable_and_frozen_bonds' RPC.
187
+ */
188
+ getBalanceAndFrozenBonds(address_1) {
189
+ return __awaiter(this, arguments, void 0, function* (address, { block } = rpc_client_interface_2.defaultRPCOptions) {
190
+ this.validateAddress(address);
191
+ const key = this.formatCacheKey(this.rpcClient.getRpcUrl(), rpc_client_interface_1.RPCMethodName.GET_BALANCE_AND_FROZEN_BONDS, [block, address]);
192
+ if (this.has(key)) {
193
+ return this.get(key);
194
+ }
195
+ else {
196
+ const response = this.rpcClient.getBalanceAndFrozenBonds(address, { block });
197
+ this.put(key, response);
198
+ return response;
199
+ }
200
+ });
201
+ }
202
+ /**
203
+ * @param address address from which we want to retrieve spendable and frozen bonds
204
+ * @param options contains generic configuration for rpc calls to specified block (default to head)
205
+ * @description The sum (in mutez) of the spendable balance and frozen bonds of a contract. Corresponds to the contract's full balance from which staked funds and unstake requests have been excluded. Identical to the 'balance_and_frozen_bonds' RPC.
206
+ */
207
+ getSpendableAndFrozenBonds(address_1) {
208
+ return __awaiter(this, arguments, void 0, function* (address, { block } = rpc_client_interface_2.defaultRPCOptions) {
209
+ this.validateAddress(address);
210
+ const key = this.formatCacheKey(this.rpcClient.getRpcUrl(), rpc_client_interface_1.RPCMethodName.GET_SPENDABLE_AND_FROZEN_BONDS, [block, address]);
211
+ if (this.has(key)) {
212
+ return this.get(key);
213
+ }
214
+ else {
215
+ const response = this.rpcClient.getSpendableAndFrozenBonds(address, { block });
216
+ this.put(key, response);
217
+ return response;
218
+ }
219
+ });
220
+ }
161
221
  /**
162
222
  * @param address address from which we want to retrieve the full balance
163
223
  * @param options contains generic configuration for rpc calls to specified block (default to head)
@@ -536,8 +596,8 @@ class RpcClientCache {
536
596
  * @param options contains generic configuration for rpc calls to specified block (default to head) and version.
537
597
  * @description All the information about a block
538
598
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id
539
- * @example getBlock() will default to `/main/chains/block/head?version=0` which shows { kind: endorsement }
540
- * @example getBlock({ block: 'head~2', version: 1 }) will return an offset of 2 from head blocks and shows { kind: attestation }
599
+ * @example getBlock() will default to `/main/chains/block/head?version=1`
600
+ * @example getBlock({ block: 'head~2') will return an offset of 2 from head blocks
541
601
  * @example getBlock({ block: 'BL8fTiWcSxWCjiMVnDkbh6EuhqVPZzgWheJ2dqwrxYRm9AephXh~2' }) will return an offset of 2 blocks from given block hash..
542
602
  */
543
603
  getBlock() {
@@ -597,7 +657,7 @@ class RpcClientCache {
597
657
  * @param args contains optional query arguments (level, cycle, delegate, consensus_key, and max_round)
598
658
  * @param options contains generic configuration for rpc calls to specified block (default to head)
599
659
  * @description Retrieves the list of delegates allowed to bake a block.
600
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
660
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
601
661
  */
602
662
  getBakingRights() {
603
663
  return __awaiter(this, arguments, void 0, function* (args = {}, { block } = rpc_client_interface_2.defaultRPCOptions) {
@@ -619,7 +679,7 @@ class RpcClientCache {
619
679
  * @param args contains optional query arguments (level, cycle, delegate, and consensus_key)
620
680
  * @param options contains generic configuration for rpc calls to specified block (default to head)
621
681
  * @description Retrieves the delegates allowed to attest a block
622
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
682
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
623
683
  */
624
684
  getAttestationRights() {
625
685
  return __awaiter(this, arguments, void 0, function* (args = {}, { block } = rpc_client_interface_2.defaultRPCOptions) {
@@ -754,7 +814,7 @@ class RpcClientCache {
754
814
  * @param data operation contents to forge
755
815
  * @param options contains generic configuration for rpc calls to specified block (default to head)
756
816
  * @description Forge an operation returning the unsigned bytes
757
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
817
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
758
818
  */
759
819
  forgeOperations(data_1) {
760
820
  return __awaiter(this, arguments, void 0, function* (data, { block } = rpc_client_interface_2.defaultRPCOptions) {
@@ -811,7 +871,7 @@ class RpcClientCache {
811
871
  * @param op Operation to run
812
872
  * @param options contains generic configuration for rpc calls to specified block and version
813
873
  * @description Run an operation with the context of the given block and without signature checks and return the operation application result, including the consumed gas.
814
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
874
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
815
875
  */
816
876
  runOperation(op_1) {
817
877
  return __awaiter(this, arguments, void 0, function* (op, { block } = rpc_client_interface_2.defaultRPCOptions) {
@@ -822,7 +882,7 @@ class RpcClientCache {
822
882
  * @param op Operation to simulate
823
883
  * @param options contains generic configuration for rpc calls to specified block and version
824
884
  * @description Simulate running an operation at some future moment (based on the number of blocks given in the `latency` argument), and return the operation application result.
825
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
885
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
826
886
  */
827
887
  simulateOperation(op_1) {
828
888
  return __awaiter(this, arguments, void 0, function* (op, { block } = rpc_client_interface_2.defaultRPCOptions) {
@@ -833,7 +893,7 @@ class RpcClientCache {
833
893
  * @param code Code to run
834
894
  * @param options contains generic configuration for rpc calls to specified block (default to head)
835
895
  * @description Run a Michelson script in the current context
836
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
896
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
837
897
  */
838
898
  runCode(code_1) {
839
899
  return __awaiter(this, arguments, void 0, function* (code, { block } = rpc_client_interface_2.defaultRPCOptions) {
@@ -844,7 +904,7 @@ class RpcClientCache {
844
904
  * @param viewScriptParams Parameters of the script view to run
845
905
  * @param options contains generic configuration for rpc calls to specified block (default to head)
846
906
  * @description Simulate a call to a michelson view
847
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
907
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
848
908
  */
849
909
  runScriptView(_a, _b) {
850
910
  return __awaiter(this, void 0, void 0, function* () {
@@ -857,7 +917,7 @@ class RpcClientCache {
857
917
  * @param viewParams Parameters of the view to run
858
918
  * @param options contains generic configuration for rpc calls to specified block (default to head)
859
919
  * @description Simulate a call to a view following the TZIP-4 standard.
860
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
920
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
861
921
  */
862
922
  runView(_a, _b) {
863
923
  return __awaiter(this, void 0, void 0, function* () {
@@ -888,7 +948,7 @@ class RpcClientCache {
888
948
  * A node that is operated by a bad actor, or compromised by a bad actor could return a fully formed operation that does not correspond to the input provided to the RPC endpoint.
889
949
  * A safer solution to pack and sign data would be to use the `packDataBytes` function available in the `@taquito/michel-codec` package.
890
950
  * @example packData({ data: { string: "test" }, type: { prim: "string" } })
891
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
951
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
892
952
  */
893
953
  packData(data_1) {
894
954
  return __awaiter(this, arguments, void 0, function* (data, { block } = rpc_client_interface_2.defaultRPCOptions) {
@@ -1011,7 +1071,7 @@ class RpcClientCache {
1011
1071
  * @param contract address of the contract we want to retrieve storage information of
1012
1072
  * @param options contains generic configuration for rpc calls to specified block (default to head)
1013
1073
  * @description Access the used storage space of the contract
1014
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
1074
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
1015
1075
  */
1016
1076
  getStorageUsedSpace(contract_1) {
1017
1077
  return __awaiter(this, arguments, void 0, function* (contract, { block } = rpc_client_interface_2.defaultRPCOptions) {
@@ -1030,7 +1090,7 @@ class RpcClientCache {
1030
1090
  * @param contract address of the contract we want to retrieve storage information of
1031
1091
  * @param options contains generic configuration for rpc calls to specified block (default to head)
1032
1092
  = * @description Access the paid storage space of the contract
1033
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
1093
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
1034
1094
  */
1035
1095
  getStoragePaidSpace(contract_1) {
1036
1096
  return __awaiter(this, arguments, void 0, function* (contract, { block } = rpc_client_interface_2.defaultRPCOptions) {
@@ -1051,7 +1111,7 @@ class RpcClientCache {
1051
1111
  * @param options contains generic configuration for rpc calls to specified block (default to head)
1052
1112
  * @description Access the contract's balance of ticket with specified ticketer, content type, and content.
1053
1113
  * @example ticket { ticketer: 'address', content_type: { prim: "string" }, content: { string: 'ticket1' } }
1054
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
1114
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
1055
1115
  */
1056
1116
  getTicketBalance(contract_1, ticket_1) {
1057
1117
  return __awaiter(this, arguments, void 0, function* (contract, ticket, { block } = rpc_client_interface_2.defaultRPCOptions) {
@@ -1070,7 +1130,7 @@ class RpcClientCache {
1070
1130
  * @param contract originated address we want to retrieve ticket balances of
1071
1131
  * @param options contains generic configuration for rpc calls to specified block (default to head)
1072
1132
  * @description Access the complete list of tickets owned by the given contract by scanning the contract's storage.
1073
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
1133
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
1074
1134
  */
1075
1135
  getAllTicketBalances(contract_1) {
1076
1136
  return __awaiter(this, arguments, void 0, function* (contract, { block } = rpc_client_interface_2.defaultRPCOptions) {
@@ -1105,7 +1165,7 @@ class RpcClientCache {
1105
1165
  }
1106
1166
  /**
1107
1167
  * @description List the prevalidated operations in mempool (accessibility of mempool depends on each rpc endpoint)
1108
- * @param args has 5 optional properties. We support version 1 & 2
1168
+ * @param args has 5 optional properties
1109
1169
  * @default args { version: '2', validated: true, refused: true, outdated, true, branchRefused: true, branchDelayed: true, validationPass: undefined }
1110
1170
  */
1111
1171
  getPendingOperations() {
@@ -68,7 +68,7 @@ class RpcClient {
68
68
  * @param httpBackend Http backend that issue http request.
69
69
  * You can override it by providing your own if you which to hook in the request/response
70
70
  *
71
- * @example new RpcClient('https://mainnet.ecadinfra.com/', 'main') this will use https://mainnet.ecadinfra.com//chains/main
71
+ * @example new RpcClient('https://mainnet.tezos.ecadinfra.com/', 'main') this will use https://mainnet.tezos.ecadinfra.com//chains/main
72
72
  */
73
73
  constructor(url, chain = rpc_client_interface_1.defaultChain, httpBackend = new http_utils_1.HttpBackend()) {
74
74
  this.url = url;
@@ -126,9 +126,9 @@ class RpcClient {
126
126
  });
127
127
  }
128
128
  /**
129
- * @param address address from which we want to retrieve the balance
129
+ * @param address address from which we want to retrieve the spendable balance
130
130
  * @param options contains generic configuration for rpc calls to specified block (default to head)
131
- * @description Access the spendable balance of a contract, excluding frozen bonds
131
+ * @description The spendable balance of a contract (in mutez), also known as liquid balance. Corresponds to tez owned by the contract that are neither staked, nor in unstaked requests, nor in frozen bonds. Identical to the 'spendable' RPC.
132
132
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-balance
133
133
  */
134
134
  getBalance(address_1) {
@@ -141,6 +141,53 @@ class RpcClient {
141
141
  return new bignumber_js_1.default(balance);
142
142
  });
143
143
  }
144
+ /**
145
+ * @param address address from which we want to retrieve the spendable balance
146
+ * @param options contains generic configuration for rpc calls to specified block (default to head)
147
+ * @description The spendable balance of a contract (in mutez), also known as liquid balance. Corresponds to tez owned by the contract that are neither staked, nor in unstaked requests, nor in frozen bonds. Identical to the 'balance' RPC.
148
+ */
149
+ getSpendable(address_1) {
150
+ return __awaiter(this, arguments, void 0, function* (address, { block } = rpc_client_interface_1.defaultRPCOptions) {
151
+ this.validateAddress(address);
152
+ const balance = yield this.httpBackend.createRequest({
153
+ url: this.createURL(`/chains/${this.chain}/blocks/${block}/context/contracts/${address}/spendable`),
154
+ method: 'GET',
155
+ });
156
+ return new bignumber_js_1.default(balance);
157
+ });
158
+ }
159
+ /**
160
+ * @param address address from which we want to retrieve balance and frozen bonds
161
+ * @param options contains generic configuration for rpc calls to specified block (default to head)
162
+ * @description The sum (in mutez) of the spendable balance and frozen bonds of a contract. Corresponds to the contract's full balance from which staked funds and unstake requests have been excluded. Identical to the 'spendable_and_frozen_bonds' RPC.
163
+ * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-full-balance
164
+ */
165
+ getBalanceAndFrozenBonds(address_1) {
166
+ return __awaiter(this, arguments, void 0, function* (address, { block } = rpc_client_interface_1.defaultRPCOptions) {
167
+ this.validateAddress(address);
168
+ const balance = yield this.httpBackend.createRequest({
169
+ url: this.createURL(`/chains/${this.chain}/blocks/${block}/context/contracts/${address}/balance_and_frozen_bonds`),
170
+ method: 'GET',
171
+ });
172
+ return new bignumber_js_1.default(balance);
173
+ });
174
+ }
175
+ /**
176
+ * @param address address from which we want to retrieve spendable and frozen bonds
177
+ * @param options contains generic configuration for rpc calls to specified block (default to head)
178
+ * @description The sum (in mutez) of the spendable balance and frozen bonds of a contract. Corresponds to the contract's full balance from which staked funds and unstake requests have been excluded. Identical to the 'balance_and_frozen_bonds' RPC.
179
+ * @see https://tezos.gitlab.io/active/rpc.html#get-block-id-context-contracts-contract-id-full-balance
180
+ */
181
+ getSpendableAndFrozenBonds(address_1) {
182
+ return __awaiter(this, arguments, void 0, function* (address, { block } = rpc_client_interface_1.defaultRPCOptions) {
183
+ this.validateAddress(address);
184
+ const balance = yield this.httpBackend.createRequest({
185
+ url: this.createURL(`/chains/${this.chain}/blocks/${block}/context/contracts/${address}/spendable_and_frozen_bonds`),
186
+ method: 'GET',
187
+ });
188
+ return new bignumber_js_1.default(balance);
189
+ });
190
+ }
144
191
  /**
145
192
  * @param address address from which we want to retrieve the full balance
146
193
  * @param options contains generic configuration for rpc calls to specified block (default to head)
@@ -490,8 +537,8 @@ class RpcClient {
490
537
  * @param options contains generic configuration for rpc calls to specified block (default to head) and version.
491
538
  * @description All the information about a block
492
539
  * @see https://tezos.gitlab.io/active/rpc.html#get-block-id
493
- * @example getBlock() will default to `/main/chains/block/head?version=1` which shows { kind: attestation }
494
- * @example getBlock({ block: 'head~2', version: 0 }) will return an offset of 2 from head blocks and shows { kind: endorsement }
540
+ * @example getBlock() will default to `/main/chains/block/head?version=1`
541
+ * @example getBlock({ block: 'head~2' }) will return an offset of 2 from head blocks
495
542
  * @example getBlock({ block: 'BL8fTiWcSxWCjiMVnDkbh6EuhqVPZzgWheJ2dqwrxYRm9AephXh~2' }) will return an offset of 2 blocks from given block hash..
496
543
  */
497
544
  getBlock() {
@@ -541,7 +588,7 @@ class RpcClient {
541
588
  * @param args contains optional query arguments (level, cycle, delegate, consensus_key, and max_round)
542
589
  * @param options contains generic configuration for rpc calls to specified block (default to head)
543
590
  * @description Retrieves the list of delegates allowed to bake a block.
544
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
591
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
545
592
  */
546
593
  getBakingRights() {
547
594
  return __awaiter(this, arguments, void 0, function* (args = {}, { block } = rpc_client_interface_1.defaultRPCOptions) {
@@ -557,7 +604,7 @@ class RpcClient {
557
604
  * @param args contains optional query arguments (level, cycle, delegate, and consensus_key)
558
605
  * @param options contains generic configuration for rpc calls to specified block (default to head)
559
606
  * @description Retrieves the delegates allowed to attest a block
560
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
607
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
561
608
  */
562
609
  getAttestationRights() {
563
610
  return __awaiter(this, arguments, void 0, function* (args = {}, { block } = rpc_client_interface_1.defaultRPCOptions) {
@@ -667,7 +714,7 @@ class RpcClient {
667
714
  * @param data operation contents to forge
668
715
  * @param options contains generic configuration for rpc calls to specified block (default to head)
669
716
  * @description Forge an operation returning the unsigned bytes
670
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
717
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
671
718
  */
672
719
  forgeOperations(data_1) {
673
720
  return __awaiter(this, arguments, void 0, function* (data, { block } = rpc_client_interface_1.defaultRPCOptions) {
@@ -730,7 +777,7 @@ class RpcClient {
730
777
  * @param op Operation to run
731
778
  * @param options contains generic configuration for rpc calls to specified block and version
732
779
  * @description Run an operation with the context of the given block and without signature checks and return the operation application result, including the consumed gas.
733
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
780
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
734
781
  */
735
782
  runOperation(op_1) {
736
783
  return __awaiter(this, arguments, void 0, function* (op, { block, version } = rpc_client_interface_1.defaultRPCOptions) {
@@ -748,7 +795,7 @@ class RpcClient {
748
795
  * @param op Operation to simulate
749
796
  * @param options contains generic configuration for rpc calls to specified block and version
750
797
  * @description Simulate running an operation at some future moment (based on the number of blocks given in the `latency` argument), and return the operation application result.
751
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
798
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
752
799
  */
753
800
  simulateOperation(op_1) {
754
801
  return __awaiter(this, arguments, void 0, function* (op, { block, version } = rpc_client_interface_1.defaultRPCOptions) {
@@ -766,7 +813,7 @@ class RpcClient {
766
813
  * @param code Code to run
767
814
  * @param options contains generic configuration for rpc calls to specified block (default to head)
768
815
  * @description Run a Michelson script in the current context
769
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
816
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
770
817
  */
771
818
  runCode(code_1) {
772
819
  return __awaiter(this, arguments, void 0, function* (code, { block } = rpc_client_interface_1.defaultRPCOptions) {
@@ -781,7 +828,7 @@ class RpcClient {
781
828
  * @param viewScriptParams Parameters of the script view to run
782
829
  * @param options contains generic configuration for rpc calls to specified block (default to head)
783
830
  * @description Simulate a call to a michelson view
784
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
831
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
785
832
  */
786
833
  runScriptView(_a, _b) {
787
834
  return __awaiter(this, void 0, void 0, function* () {
@@ -797,7 +844,7 @@ class RpcClient {
797
844
  * @param viewParams Parameters of the view to run
798
845
  * @param options contains generic configuration for rpc calls to specified block (default to head)
799
846
  * @description Simulate a call to a view following the TZIP-4 standard.
800
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
847
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
801
848
  */
802
849
  runView(_a, _b) {
803
850
  return __awaiter(this, void 0, void 0, function* () {
@@ -826,7 +873,7 @@ class RpcClient {
826
873
  * A node that is operated by a bad actor, or compromised by a bad actor could return a fully formed operation that does not correspond to the input provided to the RPC endpoint.
827
874
  * A safer solution to pack and sign data would be to use the `packDataBytes` function available in the `@taquito/michel-codec` package.
828
875
  * @example packData({ data: { string: "test" }, type: { prim: "string" } })
829
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
876
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
830
877
  */
831
878
  packData(data_1) {
832
879
  return __awaiter(this, arguments, void 0, function* (data, { block } = rpc_client_interface_1.defaultRPCOptions) {
@@ -923,7 +970,7 @@ class RpcClient {
923
970
  * @param contract address of the contract we want to retrieve storage information of
924
971
  * @param options contains generic configuration for rpc calls to specified block (default to head)
925
972
  * @description Access the used storage space of the contract
926
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
973
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
927
974
  */
928
975
  getStorageUsedSpace(contract_1) {
929
976
  return __awaiter(this, arguments, void 0, function* (contract, { block } = rpc_client_interface_1.defaultRPCOptions) {
@@ -937,7 +984,7 @@ class RpcClient {
937
984
  * @param contract address of the contract we want to retrieve storage information of
938
985
  * @param options contains generic configuration for rpc calls to specified block (default to head)
939
986
  * @description Access the paid storage space of the contract
940
- * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-openapi-rc.json
987
+ * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/alpha-openapi.json
941
988
  */
942
989
  getStoragePaidSpace(contract_1) {
943
990
  return __awaiter(this, arguments, void 0, function* (contract, { block } = rpc_client_interface_1.defaultRPCOptions) {
@@ -992,8 +1039,8 @@ class RpcClient {
992
1039
  }
993
1040
  /**
994
1041
  * @description List the prevalidated operations in mempool (accessibility of mempool depends on each rpc endpoint)
995
- * @param args has 5 optional properties. We support version 1 & 2
996
- * @default args { version: '2', validated: true, refused: true, outdated, true, branchRefused: true, branchDelayed: true, validationPass: undefined }
1042
+ * @param args has 5 optional properties
1043
+ * @default args { version: '2', validated: true, refused: true, outdated, true, branchRefused: true, branchDelayed: true, validationPass: undefined, source: undefined, operationHash: undefined }
997
1044
  * @see https://gitlab.com/tezos/tezos/-/blob/master/docs/api/paris-mempool-openapi-rc.json
998
1045
  */
999
1046
  getPendingOperations() {
@@ -3,6 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
4
  // IMPORTANT: THIS FILE IS AUTO GENERATED! DO NOT MANUALLY EDIT OR CHECKIN!
5
5
  exports.VERSION = {
6
- "commitHash": "3e5b607831fe4d2e3ec023b1648b84a890c0035e",
7
- "version": "20.2.0-beta.0"
6
+ "commitHash": "dc22d94eecc9c8073103ba09a7493d4604a8cf54",
7
+ "version": "21.0.0-beta.1"
8
8
  };