@taquito/taquito 24.2.0 → 24.3.0-beta.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.
Files changed (129) hide show
  1. package/README.md +1 -1
  2. package/dist/lib/batch/rpc-batch-provider.js +91 -83
  3. package/dist/lib/context.js +22 -26
  4. package/dist/lib/contract/big-map.js +16 -29
  5. package/dist/lib/contract/contract-methods/contract-method-object-param.js +7 -7
  6. package/dist/lib/contract/contract-methods/contract-on-chain-view.js +31 -44
  7. package/dist/lib/contract/contract.js +21 -32
  8. package/dist/lib/contract/errors.js +9 -9
  9. package/dist/lib/contract/prepare.js +36 -45
  10. package/dist/lib/contract/rpc-contract-provider.js +426 -475
  11. package/dist/lib/contract/sapling-state-abstraction.js +3 -14
  12. package/dist/lib/contract/semantic.js +2 -2
  13. package/dist/lib/errors.js +3 -3
  14. package/dist/lib/estimate/errors.js +1 -1
  15. package/dist/lib/estimate/estimate.js +66 -20
  16. package/dist/lib/estimate/rpc-estimate-provider.js +427 -460
  17. package/dist/lib/forger/composite-forger.js +16 -27
  18. package/dist/lib/forger/errors.js +2 -2
  19. package/dist/lib/forger/taquito-local-forger.js +9 -22
  20. package/dist/lib/global-constants/default-global-constants-provider.js +8 -19
  21. package/dist/lib/global-constants/errors.js +2 -2
  22. package/dist/lib/global-constants/noop-global-constants-provider.js +2 -13
  23. package/dist/lib/import-key.js +23 -34
  24. package/dist/lib/injector/rpc-injector.js +13 -24
  25. package/dist/lib/operations/ballot-operation.js +2 -3
  26. package/dist/lib/operations/delegate-operation.js +5 -8
  27. package/dist/lib/operations/drain-delegate-operation.js +1 -1
  28. package/dist/lib/operations/errors.js +9 -6
  29. package/dist/lib/operations/increase-paid-storage-operation.js +4 -7
  30. package/dist/lib/operations/operations.js +100 -30
  31. package/dist/lib/operations/origination-operation.js +16 -27
  32. package/dist/lib/operations/proposals-operation.js +2 -3
  33. package/dist/lib/operations/register-global-constant-operation.js +4 -7
  34. package/dist/lib/operations/reveal-operation.js +1 -1
  35. package/dist/lib/operations/smart-rollup-add-messages-operation.js +4 -7
  36. package/dist/lib/operations/smart-rollup-execute-outbox-message-operation.js +4 -7
  37. package/dist/lib/operations/smart-rollup-originate-operation.js +4 -7
  38. package/dist/lib/operations/transaction-operation.js +2 -2
  39. package/dist/lib/operations/transfer-ticket-operation.js +4 -6
  40. package/dist/lib/operations/types.js +17 -19
  41. package/dist/lib/operations/update-companion-key-operation.js +4 -7
  42. package/dist/lib/operations/update-consensus-key-operation.js +4 -7
  43. package/dist/lib/packer/michel-codec-packer.js +3 -14
  44. package/dist/lib/packer/rpc-packer.js +2 -13
  45. package/dist/lib/parser/michel-codec-parser.js +82 -107
  46. package/dist/lib/parser/noop-parser.js +2 -13
  47. package/dist/lib/prepare/prepare-provider.js +780 -744
  48. package/dist/lib/provider.js +322 -128
  49. package/dist/lib/read-provider/rpc-read-adapter.js +76 -121
  50. package/dist/lib/signer/errors.js +1 -1
  51. package/dist/lib/signer/noop.js +9 -26
  52. package/dist/lib/subscribe/errors.js +2 -2
  53. package/dist/lib/subscribe/polling-subcribe-provider.js +35 -38
  54. package/dist/lib/taquito.js +33 -33
  55. package/dist/lib/tz/rpc-tz-provider.js +27 -44
  56. package/dist/lib/version.js +2 -2
  57. package/dist/lib/wallet/batch-operation.js +32 -45
  58. package/dist/lib/wallet/delegation-operation.js +25 -40
  59. package/dist/lib/wallet/errors.js +15 -3
  60. package/dist/lib/wallet/increase-paid-storage-operation.js +25 -40
  61. package/dist/lib/wallet/legacy.js +28 -63
  62. package/dist/lib/wallet/operation-factory.js +27 -56
  63. package/dist/lib/wallet/operation.js +123 -59
  64. package/dist/lib/wallet/origination-operation.js +34 -46
  65. package/dist/lib/wallet/register-global-constant-operation.js +26 -43
  66. package/dist/lib/wallet/transaction-operation.js +21 -36
  67. package/dist/lib/wallet/transfer-ticket-operation.js +21 -36
  68. package/dist/lib/wallet/wallet.js +187 -184
  69. package/dist/taquito.es6.js +3424 -3197
  70. package/dist/taquito.es6.js.map +1 -1
  71. package/dist/taquito.min.js +1 -1
  72. package/dist/taquito.umd.js +7930 -7701
  73. package/dist/taquito.umd.js.map +1 -1
  74. package/dist/types/batch/rpc-batch-provider.d.ts +18 -18
  75. package/dist/types/context.d.ts +4 -4
  76. package/dist/types/contract/big-map.d.ts +3 -3
  77. package/dist/types/contract/contract-methods/contract-method-interface.d.ts +4 -4
  78. package/dist/types/contract/contract-methods/contract-method-object-param.d.ts +6 -6
  79. package/dist/types/contract/contract-methods/contract-on-chain-view.d.ts +3 -3
  80. package/dist/types/contract/contract.d.ts +6 -6
  81. package/dist/types/contract/errors.d.ts +11 -11
  82. package/dist/types/contract/interface.d.ts +42 -42
  83. package/dist/types/contract/rpc-contract-provider.d.ts +44 -43
  84. package/dist/types/contract/sapling-state-abstraction.d.ts +1 -1
  85. package/dist/types/contract/semantic.d.ts +2 -2
  86. package/dist/types/errors.d.ts +5 -5
  87. package/dist/types/estimate/errors.d.ts +1 -1
  88. package/dist/types/estimate/estimate-provider-interface.d.ts +81 -84
  89. package/dist/types/estimate/estimate.d.ts +28 -11
  90. package/dist/types/estimate/rpc-estimate-provider.d.ts +34 -30
  91. package/dist/types/forger/errors.d.ts +2 -2
  92. package/dist/types/global-constants/default-global-constants-provider.d.ts +2 -2
  93. package/dist/types/global-constants/errors.d.ts +2 -2
  94. package/dist/types/global-constants/interface-global-constants-provider.d.ts +1 -1
  95. package/dist/types/import-key.d.ts +2 -2
  96. package/dist/types/operations/ballot-operation.d.ts +1 -1
  97. package/dist/types/operations/delegate-operation.d.ts +2 -2
  98. package/dist/types/operations/drain-delegate-operation.d.ts +1 -1
  99. package/dist/types/operations/errors.d.ts +5 -5
  100. package/dist/types/operations/failing-noop-operation.d.ts +1 -1
  101. package/dist/types/operations/increase-paid-storage-operation.d.ts +1 -1
  102. package/dist/types/operations/operations.d.ts +2 -2
  103. package/dist/types/operations/origination-operation.d.ts +5 -5
  104. package/dist/types/operations/proposals-operation.d.ts +1 -1
  105. package/dist/types/operations/register-global-constant-operation.d.ts +2 -2
  106. package/dist/types/operations/reveal-operation.d.ts +1 -1
  107. package/dist/types/operations/smart-rollup-add-messages-operation.d.ts +1 -1
  108. package/dist/types/operations/smart-rollup-execute-outbox-message-operation.d.ts +1 -1
  109. package/dist/types/operations/smart-rollup-originate-operation.d.ts +1 -1
  110. package/dist/types/operations/transaction-operation.d.ts +2 -2
  111. package/dist/types/operations/transfer-ticket-operation.d.ts +2 -2
  112. package/dist/types/operations/types.d.ts +387 -25
  113. package/dist/types/operations/update-companion-key-operation.d.ts +1 -1
  114. package/dist/types/operations/update-consensus-key-operation.d.ts +1 -1
  115. package/dist/types/prepare/interface.d.ts +32 -33
  116. package/dist/types/prepare/prepare-provider.d.ts +34 -60
  117. package/dist/types/provider.d.ts +7 -1
  118. package/dist/types/read-provider/interface.d.ts +21 -21
  119. package/dist/types/read-provider/rpc-read-adapter.d.ts +22 -22
  120. package/dist/types/signer/errors.d.ts +1 -1
  121. package/dist/types/signer/noop.d.ts +1 -1
  122. package/dist/types/subscribe/errors.d.ts +2 -2
  123. package/dist/types/taquito.d.ts +33 -33
  124. package/dist/types/wallet/errors.d.ts +10 -2
  125. package/dist/types/wallet/interface.d.ts +13 -13
  126. package/dist/types/wallet/operation.d.ts +4 -3
  127. package/dist/types/wallet/wallet.d.ts +36 -35
  128. package/package.json +27 -15
  129. package/LICENSE +0 -202
@@ -24,7 +24,7 @@ export type ContractSchema = Schema | unknown;
24
24
  export interface StorageProvider {
25
25
  /**
26
26
  *
27
- * @description Return a well formatted json object of the contract storage
27
+ * Return a well formatted json object of the contract storage
28
28
  *
29
29
  * @param contract contract address you want to get the storage from
30
30
  * @param schema optional schema can either be the contract script rpc response or a michelson-encoder schema
@@ -34,7 +34,7 @@ export interface StorageProvider {
34
34
  getStorage<T>(contract: string, schema?: ContractSchema): Promise<T>;
35
35
  /**
36
36
  *
37
- * @description Return a well formatted json object of a big map value
37
+ * Return a well formatted json object of a big map value
38
38
  *
39
39
  * @param id Big Map ID
40
40
  * @param keyToEncode key to query (will be encoded properly according to the schema)
@@ -46,7 +46,7 @@ export interface StorageProvider {
46
46
  getBigMapKeyByID<T>(id: string, keyToEncode: BigMapKeyType, schema: Schema, block?: number): Promise<T>;
47
47
  /**
48
48
  *
49
- * @description Fetch multiple values in a big map
49
+ * Fetch multiple values in a big map
50
50
  *
51
51
  * @param id Big Map ID
52
52
  * @param keysToEncode Array of keys to query (will be encoded properly according to the schema)
@@ -59,7 +59,7 @@ export interface StorageProvider {
59
59
  getBigMapKeysByID<T>(id: string, keysToEncode: Array<BigMapKeyType>, schema: Schema, block?: number, batchSize?: number): Promise<MichelsonMap<MichelsonMapKey, T | undefined>>;
60
60
  /**
61
61
  *
62
- * @description Return a well formatted json object of a sapling state
62
+ * Return a well formatted json object of a sapling state
63
63
  *
64
64
  * @param id Sapling state ID
65
65
  * @param block optional block level to fetch the value from
@@ -70,95 +70,95 @@ export interface StorageProvider {
70
70
  export interface ContractProvider extends StorageProvider {
71
71
  /**
72
72
  *
73
- * @description Originate a new contract according to the script in parameters. Will sign and inject an operation using the current context
73
+ * Originate a new contract according to the script in parameters. Will sign and inject an operation using the current context
74
74
  *
75
75
  * @returns An operation handle with the result from the rpc node
76
76
  *
77
- * @param OriginationOperation Originate operation parameter
77
+ * @param contract Originate operation parameter
78
78
  */
79
79
  originate<TContract extends DefaultContractType = DefaultContractType>(contract: OriginateParams<ContractStorageType<TContract>>): Promise<OriginationOperation<TContract>>;
80
80
  /**
81
81
  *
82
- * @description Set the delegate for a contract. Will sign and inject an operation using the current context
82
+ * Set the delegate for a contract. Will sign and inject an operation using the current context
83
83
  *
84
84
  * @returns An operation handle with the result from the rpc node
85
85
  *
86
- * @param SetDelegate operation parameter
86
+ * @param params SetDelegate operation parameter
87
87
  */
88
88
  setDelegate(params: DelegateParams): Promise<DelegateOperation>;
89
89
  /**
90
90
  *
91
- * @description Register the current address as delegate. Will sign and inject an operation using the current context
91
+ * Register the current address as delegate. Will sign and inject an operation using the current context
92
92
  *
93
93
  * @returns An operation handle with the result from the rpc node
94
94
  *
95
- * @param RegisterDelegate operation parameter
95
+ * @param params RegisterDelegate operation parameter
96
96
  */
97
97
  registerDelegate(params: RegisterDelegateParams): Promise<DelegateOperation>;
98
98
  /**
99
99
  *
100
- * @description Transfer tz from current address to a specific address. Will sign and inject an operation using the current context
100
+ * Transfer tz from current address to a specific address. Will sign and inject an operation using the current context
101
101
  *
102
102
  * @returns An operation handle with the result from the rpc node
103
103
  *
104
- * @param Transfer operation parameter
104
+ * @param params Transfer operation parameter
105
105
  */
106
106
  transfer(params: TransferParams): Promise<TransactionOperation>;
107
107
  /**
108
108
  *
109
- * @description Stake tz from current address to a specific address. Built on top of the existing transaction operation
109
+ * Stake tz from current address to a specific address. Built on top of the existing transaction operation
110
110
  *
111
111
  * @returns An operation handle with the result from the rpc node
112
112
  *
113
- * @param Stake pseudo-operation parameter
113
+ * @param params Stake pseudo-operation parameter
114
114
  */
115
115
  stake(params: StakeParams): Promise<TransactionOperation>;
116
116
  /**
117
117
  *
118
- * @description Unstake tz from current address to a specific address. Built on top of the existing transaction operation
118
+ * Unstake tz from current address to a specific address. Built on top of the existing transaction operation
119
119
  *
120
120
  * @returns An operation handle with the result from the rpc node
121
121
  *
122
- * @param Unstake pseudo-operation parameter
122
+ * @param params Unstake pseudo-operation parameter
123
123
  */
124
124
  unstake(params: UnstakeParams): Promise<TransactionOperation>;
125
125
  /**
126
126
  *
127
- * @description Finalize unstake tz from current address to a specific address. Built on top of the existing transaction operation
127
+ * Finalize unstake tz from current address to a specific address. Built on top of the existing transaction operation
128
128
  *
129
129
  * @returns An operation handle with the result from the rpc node
130
130
  *
131
- * @param finalize_unstake pseudo-operation parameter
131
+ * @param params Finalize unstake pseudo-operation parameter
132
132
  */
133
133
  finalizeUnstake(params: FinalizeUnstakeParams): Promise<TransactionOperation>;
134
134
  /**
135
135
  *
136
- * @description Transfer tickets from an implicit account to a contract or another implicit account.
136
+ * Transfer tickets from an implicit account to a contract or another implicit account.
137
137
  *
138
138
  * @returns An operation handle with the result from the rpc node
139
139
  *
140
- * @param TransferTicket operation parameter
140
+ * @param params TransferTicket operation parameter
141
141
  */
142
142
  transferTicket(params: TransferTicketParams): Promise<TransferTicketOperation>;
143
143
  /**
144
144
  *
145
- * @description Reveal the current address. Will throw an error if the address is already revealed.
145
+ * Reveal the current address. Will throw an error if the address is already revealed.
146
146
  * @returns An operation handle with the result from the rpc node
147
147
  *
148
- * @param Reveal operation parameter
148
+ * @param params Reveal operation parameter
149
149
  */
150
150
  reveal(params: RevealParams): Promise<RevealOperation>;
151
151
  at<T extends ContractAbstraction<ContractProvider>>(address: string, contractAbstractionComposer?: (abs: ContractAbstraction<ContractProvider>, context: Context) => T): Promise<T>;
152
152
  /**
153
153
  *
154
- * @description Batch a group of operation together. Operations will be applied in the order in which they are added to the batch
154
+ * Batch a group of operation together. Operations will be applied in the order in which they are added to the batch
155
155
  *
156
156
  * @param params List of operation to batch together
157
157
  */
158
158
  batch(params?: ParamsWithKind[]): OperationBatch;
159
159
  /**
160
160
  *
161
- * @description Register a Micheline expression in a global table of constants. Will sign and inject an operation using the current context
161
+ * Register a Micheline expression in a global table of constants. Will sign and inject an operation using the current context
162
162
  *
163
163
  * @returns An operation handle with the result from the rpc node
164
164
  *
@@ -167,7 +167,7 @@ export interface ContractProvider extends StorageProvider {
167
167
  registerGlobalConstant(params: RegisterGlobalConstantParams): Promise<RegisterGlobalConstantOperation>;
168
168
  /**
169
169
  *
170
- * @description Increase the amount of bytes in a smart contract storage by paying a fee
170
+ * Increase the amount of bytes in a smart contract storage by paying a fee
171
171
  *
172
172
  * @returns An operation handle with the result from the rpc node
173
173
  *
@@ -176,75 +176,75 @@ export interface ContractProvider extends StorageProvider {
176
176
  increasePaidStorage(params: IncreasePaidStorageParams): Promise<IncreasePaidStorageOperation>;
177
177
  /**
178
178
  *
179
- * @description Submit a drain delegate operation
179
+ * Submit a drain delegate operation
180
180
  *
181
181
  * @returns An operation handle with the result from the RPC node
182
182
  *
183
- * @param DrainDelegateParams DrainDelegate operation parameter
183
+ * @param params DrainDelegate operation parameter
184
184
  */
185
185
  drainDelegate(params: DrainDelegateParams): Promise<DrainDelegateOperation>;
186
186
  /**
187
187
  *
188
- * @description Submit ballot for an ongoing proposal
188
+ * Submit ballot for an ongoing proposal
189
189
  *
190
190
  * @returns An operation handle with the result from the RPC node
191
191
  *
192
- * @param BallotParams Ballot operation parameter
192
+ * @param params Ballot operation parameter
193
193
  */
194
194
  ballot(params: BallotParams): Promise<BallotOperation>;
195
195
  /**
196
196
  *
197
- * @description Submit proposal
197
+ * Submit proposal
198
198
  *
199
199
  * @returns An operation handle with the result from the RPC node
200
200
  *
201
- * @param ProposalsParams Proposals operation parameter
201
+ * @param params Proposals operation parameter
202
202
  */
203
203
  proposals(params: ProposalsParams): Promise<ProposalsOperation>;
204
204
  /**
205
205
  *
206
- * @description Update consensus key
206
+ * Update consensus key
207
207
  * @returns An operation handle with the result from the RPC node
208
208
  *
209
- * @param UpdateConsensusKeyParams UpdateConsensusKey operation parameter
209
+ * @param params UpdateConsensusKey operation parameter
210
210
  */
211
211
  updateConsensusKey(params: UpdateConsensusKeyParams): Promise<UpdateConsensusKeyOperation>;
212
212
  /**
213
213
  *
214
- * @description Update companion key
214
+ * Update companion key
215
215
  * @returns An operation handle with the result from the RPC node
216
216
  *
217
- * @param UpdateCompanionKeyParams UpdateCompanionKey operation parameter
217
+ * @param params UpdateCompanionKey operation parameter
218
218
  */
219
219
  updateCompanionKey(params: UpdateCompanionKeyParams): Promise<UpdateCompanionKeyOperation>;
220
220
  /**
221
221
  *
222
- * @description Smart Rollup Add Messages
222
+ * Smart Rollup Add Messages
223
223
  *
224
224
  * @returns An operation handle with the result from the RPC node
225
225
  *
226
- * @param SmartRollupAddMessagesParams smartRollupAddMessages operation parameter
226
+ * @param params smartRollupAddMessages operation parameter
227
227
  */
228
228
  smartRollupAddMessages(params: SmartRollupAddMessagesParams): Promise<SmartRollupAddMessagesOperation>;
229
229
  /**
230
- * @description Smart rollup originate
230
+ * Smart rollup originate
231
231
  *
232
232
  * @returns An operation handle with the result from the RPC node
233
233
  *
234
- * @param SmartRollupOriginateParams smartRollupOriginate operation parameter
234
+ * @param params smartRollupOriginate operation parameter
235
235
  */
236
236
  smartRollupOriginate(params: SmartRollupOriginateParams): Promise<SmartRollupOriginateOperation>;
237
237
  /**
238
- * @description Execute a message from a smart rollup's outbox of a cemented commitment
238
+ * Execute a message from a smart rollup's outbox of a cemented commitment
239
239
  *
240
240
  * @returns An operation handle with the result from the RPC node
241
241
  *
242
- * @param SmartRollupExecuteOutboxMessageParams smartRollupExecuteOutboxMessage operation parameter
242
+ * @param params smartRollupExecuteOutboxMessage operation parameter
243
243
  */
244
244
  smartRollupExecuteOutboxMessage(params: SmartRollupExecuteOutboxMessageParams): Promise<SmartRollupExecuteOutboxMessageOperation>;
245
245
  /**
246
246
  *
247
- * @description Send arbitrary data inside a failing_noop operation that's guaranteed to fail.
247
+ * Send arbitrary data inside a failing_noop operation that's guaranteed to fail.
248
248
  *
249
249
  * @returns An operation handle with the result from the rpc node
250
250
  *
@@ -22,6 +22,7 @@ import { SmartRollupOriginateOperation } from '../operations/smart-rollup-origin
22
22
  import { SmartRollupExecuteOutboxMessageOperation } from '../operations/smart-rollup-execute-outbox-message-operation';
23
23
  import { Provider } from '../provider';
24
24
  import { FailingNoopOperation } from '../operations/failing-noop-operation';
25
+ import { BlockIdentifier } from '../read-provider/interface';
25
26
  export declare class RpcContractProvider extends Provider implements ContractProvider, StorageProvider {
26
27
  private estimator;
27
28
  constructor(context: Context, estimator: EstimationProvider);
@@ -29,7 +30,7 @@ export declare class RpcContractProvider extends Provider implements ContractPro
29
30
  private prepare;
30
31
  /**
31
32
  *
32
- * @description Return a well formatted json object of the contract storage
33
+ * Return a well formatted json object of the contract storage
33
34
  *
34
35
  * @param contract contract address you want to get the storage from
35
36
  * @param schema optional schema can either be the contract script rpc response or a michelson-encoder schema
@@ -39,7 +40,7 @@ export declare class RpcContractProvider extends Provider implements ContractPro
39
40
  getStorage<T>(contract: string, schema?: ContractSchema): Promise<T>;
40
41
  /**
41
42
  *
42
- * @description Return a well formatted json object of a big map value
43
+ * Return a well formatted json object of a big map value
43
44
  *
44
45
  * @param id Big Map ID
45
46
  * @param keyToEncode key to query (will be encoded properly according to the schema)
@@ -51,7 +52,7 @@ export declare class RpcContractProvider extends Provider implements ContractPro
51
52
  getBigMapKeyByID<T>(id: string, keyToEncode: BigMapKeyType, schema: Schema, block?: number): Promise<T>;
52
53
  /**
53
54
  *
54
- * @description Fetch multiple values in a big map
55
+ * Fetch multiple values in a big map
55
56
  * All values will be fetched on the same block level. If a block is specified in the request, the values will be fetched at it.
56
57
  * Otherwise, a first request will be done to the node to fetch the level of the head and all values will be fetched at this level.
57
58
  * If one of the keys does not exist in the big map, its value will be set to undefined.
@@ -69,7 +70,7 @@ export declare class RpcContractProvider extends Provider implements ContractPro
69
70
  private getBigMapValueOrUndefined;
70
71
  /**
71
72
  *
72
- * @description Return a well formatted json object of a sapling state
73
+ * Return a well formatted json object of a sapling state
73
74
  *
74
75
  * @param id Sapling state ID
75
76
  * @param block optional block level to fetch the value from
@@ -78,90 +79,90 @@ export declare class RpcContractProvider extends Provider implements ContractPro
78
79
  getSaplingDiffByID(id: string, block?: number): Promise<import("@taquito/rpc").SaplingDiffResponse>;
79
80
  /**
80
81
  *
81
- * @description Originate a new contract according to the script in parameters. Will sign and inject an operation using the current context
82
+ * Originate a new contract according to the script in parameters. Will sign and inject an operation using the current context
82
83
  *
83
84
  * @returns An operation handle with the result from the rpc node
84
85
  *
85
86
  * @warn You cannot specify storage and init at the same time (use init to pass the raw michelson representation of storage)
86
87
  *
87
- * @param OriginationOperation Originate operation parameter
88
+ * @param params Originate operation parameter
88
89
  */
89
90
  originate<TContract extends DefaultContractType = DefaultContractType>(params: OriginateParams<ContractStorageType<TContract>>): Promise<OriginationOperation<TContract>>;
90
91
  /**
91
92
  *
92
- * @description Set the delegate for a contract. Will sign and inject an operation using the current context
93
+ * Set the delegate for a contract. Will sign and inject an operation using the current context
93
94
  *
94
95
  * @returns An operation handle with the result from the rpc node
95
96
  *
96
- * @param SetDelegate operation parameter
97
+ * @param params SetDelegate operation parameter
97
98
  */
98
99
  setDelegate(params: DelegateParams): Promise<DelegateOperation>;
99
100
  /**
100
101
  *
101
- * @description Register the current address as delegate. Will sign and inject an operation using the current context
102
+ * Register the current address as delegate. Will sign and inject an operation using the current context
102
103
  *
103
104
  * @returns An operation handle with the result from the rpc node
104
105
  *
105
- * @param RegisterDelegate operation parameter
106
+ * @param params RegisterDelegate operation parameter
106
107
  */
107
108
  registerDelegate(params: RegisterDelegateParams): Promise<DelegateOperation>;
108
109
  /**
109
110
  *
110
- * @description Transfer tz from current address to a specific address. Will sign and inject an operation using the current context
111
+ * Transfer tz from current address to a specific address. Will sign and inject an operation using the current context
111
112
  *
112
113
  * @returns An operation handle with the result from the rpc node
113
114
  *
114
- * @param Transfer operation parameter
115
+ * @param params Transfer operation parameter
115
116
  */
116
117
  transfer(params: TransferParams): Promise<TransactionOperation>;
117
118
  /**
118
119
  *
119
- * @description Stake a given amount for the source address
120
+ * Stake a given amount for the source address
120
121
  *
121
122
  * @returns An operation handle with the result from the rpc node
122
123
  *
123
- * @param Stake pseudo-operation parameter
124
+ * @param params Stake pseudo-operation parameter
124
125
  */
125
126
  stake(params: StakeParams): Promise<TransactionOperation>;
126
127
  /**
127
128
  *
128
- * @description Unstake the given amount. If "everything" is given as amount, unstakes everything from the staking balance.
129
+ * Unstake the given amount. If "everything" is given as amount, unstakes everything from the staking balance.
129
130
  * Unstaked tez remains frozen for a set amount of cycles (the slashing period) after the operation. Once this period is over,
130
131
  * the operation "finalize unstake" must be called for the funds to appear in the liquid balance.
131
132
  *
132
133
  * @returns An operation handle with the result from the rpc node
133
134
  *
134
- * @param Unstake pseudo-operation parameter
135
+ * @param params Unstake pseudo-operation parameter
135
136
  */
136
137
  unstake(params: UnstakeParams): Promise<TransactionOperation>;
137
138
  /**
138
139
  *
139
- * @description Transfer all the finalizable unstaked funds of the source to their liquid balance
140
+ * Transfer all the finalizable unstaked funds of the source to their liquid balance
140
141
  * @returns An operation handle with the result from the rpc node
141
142
  *
142
- * @param Finalize_unstake pseudo-operation parameter
143
+ * @param params Finalize_unstake pseudo-operation parameter
143
144
  */
144
145
  finalizeUnstake(params: FinalizeUnstakeParams): Promise<TransactionOperation>;
145
146
  /**
146
147
  *
147
- * @description Transfer Tickets to a smart contract address
148
+ * Transfer Tickets to a smart contract address
148
149
  *
149
150
  * @returns An operation handle with the result from the rpc node
150
151
  *
151
- * @param TransferTicketParams operation parameter
152
+ * @param params TransferTicket operation parameter
152
153
  */
153
154
  transferTicket(params: TransferTicketParams): Promise<TransferTicketOperation>;
154
155
  /**
155
156
  *
156
- * @description Reveal the public key of the current address. Will throw an error if the address is already revealed.
157
+ * Reveal the public key of the current address. Will throw an error if the address is already revealed.
157
158
  * @returns An operation handle with the result from the rpc node
158
159
  *
159
- * @param RevealParams operation parameter
160
+ * @param params Reveal operation parameter
160
161
  */
161
162
  reveal(params: RevealParams): Promise<RevealOperation>;
162
163
  /**
163
164
  *
164
- * @description Register a Micheline expression in a global table of constants. Will sign and inject an operation using the current context
165
+ * Register a Micheline expression in a global table of constants. Will sign and inject an operation using the current context
165
166
  *
166
167
  * @returns An operation handle with the result from the rpc node
167
168
  *
@@ -170,7 +171,7 @@ export declare class RpcContractProvider extends Provider implements ContractPro
170
171
  registerGlobalConstant(params: RegisterGlobalConstantParams): Promise<RegisterGlobalConstantOperation>;
171
172
  /**
172
173
  *
173
- * @description Increase the paid storage of a smart contract
174
+ * Increase the paid storage of a smart contract
174
175
  *
175
176
  * @returns An operation handle with the result from the rpc node
176
177
  *
@@ -179,7 +180,7 @@ export declare class RpcContractProvider extends Provider implements ContractPro
179
180
  increasePaidStorage(params: IncreasePaidStorageParams): Promise<IncreasePaidStorageOperation>;
180
181
  /**
181
182
  *
182
- * @description Transfers the spendable balance of the delegate to destination when consensus_key is the active consensus key of delegate
183
+ * Transfers the spendable balance of the delegate to destination when consensus_key is the active consensus key of delegate
183
184
  *
184
185
  * @returns An operation handle with the result from the rpc node
185
186
  *
@@ -188,59 +189,59 @@ export declare class RpcContractProvider extends Provider implements ContractPro
188
189
  drainDelegate(params: DrainDelegateParams): Promise<DrainDelegateOperation>;
189
190
  /**
190
191
  *
191
- * @description Submit a ballot vote to a specified proposal
192
+ * Submit a ballot vote to a specified proposal
192
193
  *
193
194
  * @returns An operation handle with the result from the rpc node
194
195
  *
195
- * @param BallotParams Ballot operation parameter
196
+ * @param params Ballot operation parameter
196
197
  */
197
198
  ballot(params: BallotParams): Promise<BallotOperation>;
198
199
  /**
199
200
  *
200
- * @description Submit or upvote a proposal during the Proposal period
201
+ * Submit or upvote a proposal during the Proposal period
201
202
  *
202
203
  * @returns An operation handle with the result from the rpc node
203
204
  *
204
- * @param ProposalsParams Proposals operation parameter
205
+ * @param params Proposals operation parameter
205
206
  */
206
207
  proposals(params: ProposalsParams): Promise<ProposalsOperation>;
207
208
  /**
208
209
  *
209
- * @description Update the consensus key of a delegate starting from the current cycle plus CONSENSUS_RIGHTS_DELAY + 1
210
+ * Update the consensus key of a delegate starting from the current cycle plus CONSENSUS_RIGHTS_DELAY + 1
210
211
  * @returns An operation handle with the result from the rpc node
211
212
  *
212
- * @param UpdateConsensusKeyParams
213
+ * @param params UpdateConsensusKey operation parameter
213
214
  */
214
215
  updateConsensusKey(params: UpdateConsensusKeyParams): Promise<UpdateConsensusKeyOperation>;
215
216
  /**
216
217
  *
217
- * @description Updates the companion key of the delegate starting from the current cycle plus CONSENSUS_KEY_ACTIVATION_DELAY + 1
218
+ * Updates the companion key of the delegate starting from the current cycle plus CONSENSUS_KEY_ACTIVATION_DELAY + 1
218
219
  * @returns An operation handle with the result from the rpc node
219
220
  *
220
- * @param UpdateCompanionKeyParams
221
+ * @param params UpdateCompanionKey operation parameter
221
222
  */
222
223
  updateCompanionKey(params: UpdateCompanionKeyParams): Promise<UpdateCompanionKeyOperation>;
223
224
  /**
224
- * @description Adds messages to the rollup inbox that can be executed/claimed after it gets cemented
225
- * @param SmartRollupAddMessagesParams
225
+ * Adds messages to the rollup inbox that can be executed/claimed after it gets cemented
226
+ * @param params SmartRollupAddMessages operation parameter
226
227
  * @returns An operation handle with results from the RPC node
227
228
  */
228
229
  smartRollupAddMessages(params: SmartRollupAddMessagesParams): Promise<SmartRollupAddMessagesOperation>;
229
230
  /**
230
- * @description Creates a smart rollup originate operation
231
- * @param SmartRollupOriginateParams
231
+ * Creates a smart rollup originate operation
232
+ * @param params SmartRollupOriginate operation parameter
232
233
  * @returns An operation handle with results from the RPC node
233
234
  */
234
235
  smartRollupOriginate(params: SmartRollupOriginateParams): Promise<SmartRollupOriginateOperation>;
235
236
  /**
236
- * @description Execute a message from a smart rollup's outbox of a cemented commitment
237
- * @param SmartRollupExecuteOutboxMessageParams
237
+ * Execute a message from a smart rollup's outbox of a cemented commitment
238
+ * @param params SmartRollupExecuteOutboxMessage operation parameter
238
239
  * @returns An operation handle with results from the RPC node
239
240
  */
240
241
  smartRollupExecuteOutboxMessage(params: SmartRollupExecuteOutboxMessageParams): Promise<SmartRollupExecuteOutboxMessageOperation>;
241
242
  /**
242
243
  *
243
- * @description A failing_noop operation that is guaranteed to fail.
244
+ * A failing_noop operation that is guaranteed to fail.
244
245
  *
245
246
  * @returns A FailingNoopOperation object representing the signed failing_noop operation
246
247
  *
@@ -249,15 +250,15 @@ export declare class RpcContractProvider extends Provider implements ContractPro
249
250
  failingNoop(params: FailingNoopParams): Promise<FailingNoopOperation>;
250
251
  /**
251
252
  *
252
- * @description Create an smart contract abstraction for the address specified.
253
+ * Create an smart contract abstraction for the address specified.
253
254
  *
254
255
  * @param address Smart contract address
255
256
  * @throws {@link InvalidContractAddressError}
256
257
  */
257
- at<T extends DefaultContractType = DefaultContractType>(address: string, contractAbstractionComposer?: ContractAbstractionComposer<T>): Promise<T>;
258
+ at<T extends DefaultContractType = DefaultContractType>(address: string, contractAbstractionComposer?: ContractAbstractionComposer<T>, block?: BlockIdentifier): Promise<T>;
258
259
  /**
259
260
  *
260
- * @description Batch a group of operation together. Operations will be applied in the order in which they are added to the batch
261
+ * Batch a group of operation together. Operations will be applied in the order in which they are added to the batch
261
262
  *
262
263
  * @returns A batch object from which we can add more operation or send a command to execute the batch
263
264
  *
@@ -6,7 +6,7 @@ export declare class SaplingStateAbstraction {
6
6
  constructor(id: BigNumber, provider: ContractProvider);
7
7
  /**
8
8
  *
9
- * @description Fetch the sapling state
9
+ * Fetch the sapling state
10
10
  *
11
11
  * @param block optional block level to fetch the values from (head will be use by default)
12
12
  * @returns Return a json object of the sapling_state
@@ -1,7 +1,7 @@
1
1
  import { Semantic } from '@taquito/michelson-encoder';
2
2
  import { ContractProvider } from './interface';
3
3
  /**
4
- * @description Override the default michelson encoder semantic to provide richer abstraction over storage properties
5
- * @param provider ContractProvider (contract API)
4
+ * Override the default michelson encoder semantic to provide richer abstraction over storage properties
5
+ * @param p ContractProvider (contract API)
6
6
  */
7
7
  export declare const smartContractAbstractionSemantic: (p: ContractProvider) => Semantic;
@@ -1,7 +1,7 @@
1
1
  import { ParameterValidationError, RpcError, NetworkError } from '@taquito/core';
2
2
  /**
3
3
  * @category Error
4
- * @description Error that indicates invalid confirmation count has been passed or configured
4
+ * Error that indicates invalid confirmation count has been passed or configured
5
5
  */
6
6
  export declare class InvalidConfirmationCountError extends ParameterValidationError {
7
7
  readonly invalidConfirmations: number;
@@ -9,7 +9,7 @@ export declare class InvalidConfirmationCountError extends ParameterValidationEr
9
9
  }
10
10
  /**
11
11
  * @category Error
12
- * @description Error that indicates that confirmation polling timed out
12
+ * Error that indicates that confirmation polling timed out
13
13
  */
14
14
  export declare class ConfirmationTimeoutError extends NetworkError {
15
15
  readonly message: string;
@@ -17,10 +17,10 @@ export declare class ConfirmationTimeoutError extends NetworkError {
17
17
  }
18
18
  /**
19
19
  * @category Error
20
- * @description Error that indicates an error being returned from the RPC response
20
+ * Error that indicates an error being returned from the RPC response
21
21
  */
22
22
  export declare class RPCResponseError extends RpcError {
23
23
  readonly message: string;
24
- readonly cause?: any;
25
- constructor(message: string, cause?: any);
24
+ readonly cause?: any | undefined;
25
+ constructor(message: string, cause?: any | undefined);
26
26
  }
@@ -1,7 +1,7 @@
1
1
  import { TaquitoError } from '@taquito/core';
2
2
  /**
3
3
  * @category Error
4
- * @description Error that indicates unable to get public key to estimate reveal operation in Wallet API
4
+ * Error that indicates unable to get public key to estimate reveal operation in Wallet API
5
5
  */
6
6
  export declare class RevealEstimateError extends TaquitoError {
7
7
  constructor();