Skip to content

Commit dbd400d

Browse files
committed
updated the cods with yarn build:docs
1 parent 38cb409 commit dbd400d

File tree

2 files changed

+1
-218
lines changed

2 files changed

+1
-218
lines changed

docs/api_reference/sdk-src_network-client.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1108,33 +1108,6 @@ networkClient.setHeader('Accept-Language', 'en-US');
11081108
11091109
---
11101110
1111-
<<<<<<< HEAD
1112-
### `removeHeader(headerName)`
1113-
1114-
![modifier: public](images/badges/modifier-public.svg)
1115-
1116-
Remove a header from the &#x60;AleoNetworkClient&#x60;s header map
1117-
1118-
Parameters | Type | Description
1119-
--- | --- | ---
1120-
__headerName__ | `string` | *The name of the header to be removed*
1121-
1122-
#### Examples
1123-
1124-
```javascript
1125-
import { AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
1126-
1127-
// Create a networkClient
1128-
const networkClient = new AleoNetworkClient();
1129-
1130-
// Remove the default `X-Aleo-SDK-Version` header
1131-
networkClient.removeHeader('X-Aleo-SDK-Version');
1132-
```
1133-
1134-
---
1135-
1136-
=======
1137-
>>>>>>> 250b119cf9aec51d67c2ec112753db9609026fbf
11381111
### `fetchData(url) ► Promise.<Type>`
11391112
11401113
![modifier: public](images/badges/modifier-public.svg)

docs/api_reference/sdk-src_wasm.md

Lines changed: 1 addition & 191 deletions
Original file line numberDiff line numberDiff line change
@@ -202,197 +202,6 @@ __*return*__ | `boolean` | *Boolean representing whether or not the signature is
202202

203203
---
204204

205-
# Class `Authorization`
206-
207-
Authorization object containing the authorization for a transaction.
208-
209-
## Methods
210-
211-
### `new(request) ► Authorization`
212-
213-
![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
214-
215-
Create a new authorization from a request object.
216-
217-
Parameters | Type | Description
218-
--- | --- | ---
219-
__request__ | `ExecutionRequest` | *The ExecutionRequest to build the authorization from.*
220-
__*return*__ | [Authorization](sdk-src_wasm.md) | **
221-
222-
---
223-
224-
### `replicate() ► Authorization`
225-
226-
![modifier: public](images/badges/modifier-public.svg)
227-
228-
Returns a new and independent replica of the Authorization.
229-
230-
Parameters | Type | Description
231-
--- | --- | ---
232-
__*return*__ | [Authorization](sdk-src_wasm.md) | **
233-
234-
---
235-
236-
### `toString() ► string`
237-
238-
![modifier: public](images/badges/modifier-public.svg)
239-
240-
Returns the string representation of the Authorization.
241-
242-
Parameters | Type | Description
243-
--- | --- | ---
244-
__*return*__ | `string` | **
245-
246-
---
247-
248-
### `fromString(authorization) ► Authorization`
249-
250-
![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
251-
252-
Reconstructs an Authorization object from its string representation.
253-
254-
Parameters | Type | Description
255-
--- | --- | ---
256-
__authorization__ | `String` | *The string representation of the Authorization.*
257-
__*return*__ | [Authorization](sdk-src_wasm.md) | **
258-
259-
---
260-
261-
### `toBytesLe() ► Uint8Array`
262-
263-
![modifier: public](images/badges/modifier-public.svg)
264-
265-
Returns the left-endian byte representation of the Authorization.
266-
267-
Parameters | Type | Description
268-
--- | --- | ---
269-
__*return*__ | `Uint8Array` | **
270-
271-
---
272-
273-
### `fromBytesLe(bytes) ► Authorization`
274-
275-
![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
276-
277-
Creates an authorization object from a left-endian byte representation of an Authorization.
278-
279-
Parameters | Type | Description
280-
--- | --- | ---
281-
__bytes__ | `Uint8Array` | *Left-endian bytes representing the Authorization.*
282-
__*return*__ | [Authorization](sdk-src_wasm.md) | **
283-
284-
---
285-
286-
### `equals(other) ► boolean`
287-
288-
![modifier: public](images/badges/modifier-public.svg)
289-
290-
Check if an Authorization object is the same as another.
291-
292-
Parameters | Type | Description
293-
--- | --- | ---
294-
__other__ | [Authorization](sdk-src_wasm.md) | *The Authorization object to determine equality with.*
295-
__*return*__ | `boolean` | **
296-
297-
---
298-
299-
### `len() ► number`
300-
301-
![modifier: public](images/badges/modifier-public.svg)
302-
303-
Returns the number of &#x60;Request&#x60;s in the Authorization.
304-
305-
Parameters | Type | Description
306-
--- | --- | ---
307-
__*return*__ | `number` | **
308-
309-
---
310-
311-
### `isEmpty() ► boolean`
312-
313-
![modifier: public](images/badges/modifier-public.svg)
314-
315-
Return &#x60;true&#x60; if the Authorization is empty.
316-
317-
Parameters | Type | Description
318-
--- | --- | ---
319-
__*return*__ | `boolean` | **
320-
321-
---
322-
323-
### `isFeePrivate() ► boolean`
324-
325-
![modifier: public](images/badges/modifier-public.svg)
326-
327-
Returns &#x60;true&#x60; if the Authorization is for &#x60;credits.aleo/fee_private&#x60;.
328-
329-
Parameters | Type | Description
330-
--- | --- | ---
331-
__*return*__ | `boolean` | **
332-
333-
---
334-
335-
### `isFeePublic() ► boolean`
336-
337-
![modifier: public](images/badges/modifier-public.svg)
338-
339-
Returns &#x60;true&#x60; if the Authorization is for &#x60;credits.aleo/fee_public&#x60;.
340-
341-
Parameters | Type | Description
342-
--- | --- | ---
343-
__*return*__ | `boolean` | **
344-
345-
---
346-
347-
### `isSplit() ► boolean`
348-
349-
![modifier: public](images/badges/modifier-public.svg)
350-
351-
Returns &#x60;true&#x60; if the Authorization is for &#x60;credits.aleo/split&#x60;.
352-
353-
Parameters | Type | Description
354-
--- | --- | ---
355-
__*return*__ | `boolean` | **
356-
357-
---
358-
359-
### `insertTransition(transition) ► void`
360-
361-
![modifier: public](images/badges/modifier-public.svg)
362-
363-
Insert a transition into the Authorization.
364-
365-
Parameters | Type | Description
366-
--- | --- | ---
367-
__transition__ | `Transition` | *The transition object to insert into the Authorization.*
368-
__*return*__ | `void` | **
369-
370-
---
371-
372-
### `transitions() ► Array.<Transition>`
373-
374-
![modifier: public](images/badges/modifier-public.svg)
375-
376-
Get the transitions in an Authorization.
377-
378-
Parameters | Type | Description
379-
--- | --- | ---
380-
__*return*__ | `Array.<Transition>` | *Array of transition objects*
381-
382-
---
383-
384-
### `toExecutionId() ► Field`
385-
386-
![modifier: public](images/badges/modifier-public.svg)
387-
388-
Returns the execution ID for the Authorization.
389-
390-
Parameters | Type | Description
391-
--- | --- | ---
392-
__*return*__ | [Field](sdk-src_wasm.md) | *The execution ID for the Authorization, call toString() after this result to get the string representation.*
393-
394-
---
395-
396205
# Class `Ciphertext`
397206

398207
SnarkVM Ciphertext object. A Ciphertext represents an symmetrically encrypted plaintext. This
@@ -3469,6 +3278,7 @@ __*return*__ | `string` | *TransactionId*
34693278
34703279
![modifier: public](images/badges/modifier-public.svg)
34713280
3281+
Get the
34723282
Get the type of the transaction (will return &quot;deploy&quot; or &quot;execute&quot;)
34733283
34743284
Parameters | Type | Description

0 commit comments

Comments
 (0)