Skip to content

Commit 5b2e64c

Browse files
committed
docs(reference): regenerate for rpc and auth doc changes
1 parent 44ff9be commit 5b2e64c

2 files changed

Lines changed: 74 additions & 66 deletions

File tree

docs/reference/core-soroban-primitives.md

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -711,7 +711,7 @@ function multiPartyAuth(
711711

712712
- authorizeInvocation
713713

714-
**Source:** [src/base/auth.ts:196](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L196)
714+
**Source:** [src/base/auth.ts:198](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L198)
715715

716716
## authorizeInvocation
717717

@@ -723,7 +723,7 @@ authorizeInvocation(params: AuthorizeInvocationParams): Promise<SorobanAuthoriza
723723

724724
- **`params`**`AuthorizeInvocationParams` (required)
725725

726-
**Source:** [src/base/auth.ts:409](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L409)
726+
**Source:** [src/base/auth.ts:411](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L411)
727727

728728
## buildAuthorizationEntryPreimage
729729

@@ -758,7 +758,7 @@ buildAuthorizationEntryPreimage(entry: SorobanAuthorizationEntry, validUntilLedg
758758
- `Error` if `entry` carries source-account or otherwise non-address
759759
credentials
760760

761-
**Source:** [src/base/auth.ts:475](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L475)
761+
**Source:** [src/base/auth.ts:477](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L477)
762762

763763
## buildInvocationTree
764764

@@ -847,7 +847,7 @@ buildWithDelegatesEntry(params: BuildWithDelegatesParams): SorobanAuthorizationE
847847
- `Error` if `entry` is not an `ADDRESS`/`ADDRESS_V2` entry, or if any
848848
delegates array contains a duplicate address.
849849

850-
**Source:** [src/base/auth.ts:582](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L582)
850+
**Source:** [src/base/auth.ts:584](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L584)
851851

852852
## checkAuthEntryReadiness
853853

@@ -889,7 +889,7 @@ a [`AuthEntryReadiness`](#authentryreadiness): `ready`, `expired`, and which
889889
sequence (non-integer, negative, or above 2^32 - 1), which would make the
890890
expiration comparison unreliable
891891

892-
**Source:** [src/base/auth.ts:1037](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L1037)
892+
**Source:** [src/base/auth.ts:1039](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L1039)
893893

894894
## humanizeEvents
895895

@@ -952,7 +952,7 @@ if (!info.signed && info.address !== null) {
952952

953953
- checkAuthEntryReadiness
954954

955-
**Source:** [src/base/auth.ts:917](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L917)
955+
**Source:** [src/base/auth.ts:919](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L919)
956956

957957
## nativeToScVal
958958

@@ -1189,7 +1189,7 @@ The credential arm of a `xdr.SorobanAuthorizationEntry`.
11891189
type AuthEntryCredentialType = "sourceAccount" | "address" | "addressV2" | "addressWithDelegates"
11901190
```
11911191
1192-
**Source:** [src/base/auth.ts:797](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L797)
1192+
**Source:** [src/base/auth.ts:799](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L799)
11931193
11941194
### AuthEntryInfo
11951195
@@ -1208,7 +1208,7 @@ interface AuthEntryInfo {
12081208
}
12091209
```
12101210

1211-
**Source:** [src/base/auth.ts:847](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L847)
1211+
**Source:** [src/base/auth.ts:849](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L849)
12121212

12131213
#### `authEntryInfo.address`
12141214

@@ -1218,15 +1218,15 @@ the authorizing address, or `null` for source-account credentials.
12181218
address: string | null;
12191219
```
12201220

1221-
**Source:** [src/base/auth.ts:850](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L850)
1221+
**Source:** [src/base/auth.ts:852](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L852)
12221222

12231223
#### `authEntryInfo.credentialType`
12241224

12251225
```ts
12261226
credentialType: AuthEntryCredentialType;
12271227
```
12281228

1229-
**Source:** [src/base/auth.ts:848](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L848)
1229+
**Source:** [src/base/auth.ts:850](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L850)
12301230

12311231
#### `authEntryInfo.invocation`
12321232

@@ -1236,7 +1236,7 @@ the invocation tree this entry authorizes.
12361236
invocation: SorobanAuthorizedInvocation;
12371237
```
12381238

1239-
**Source:** [src/base/auth.ts:876](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L876)
1239+
**Source:** [src/base/auth.ts:878](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L878)
12401240

12411241
#### `authEntryInfo.nonce`
12421242

@@ -1246,7 +1246,7 @@ the credential nonce, or `null` for source-account credentials.
12461246
nonce: bigint | null;
12471247
```
12481248

1249-
**Source:** [src/base/auth.ts:852](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L852)
1249+
**Source:** [src/base/auth.ts:854](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L854)
12501250

12511251
#### `authEntryInfo.signatureExpirationLedger`
12521252

@@ -1258,7 +1258,7 @@ carry a placeholder (often `0`) until [`authorizeEntry`](#authorizeentry) sets i
12581258
signatureExpirationLedger: number | null;
12591259
```
12601260

1261-
**Source:** [src/base/auth.ts:858](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L858)
1261+
**Source:** [src/base/auth.ts:860](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L860)
12621262

12631263
#### `authEntryInfo.signed`
12641264

@@ -1274,7 +1274,7 @@ support that.
12741274
signed: boolean;
12751275
```
12761276

1277-
**Source:** [src/base/auth.ts:874](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L874)
1277+
**Source:** [src/base/auth.ts:876](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L876)
12781278

12791279
#### `authEntryInfo.signers`
12801280

@@ -1286,7 +1286,7 @@ source-account credentials.
12861286
signers: AuthEntrySigner[];
12871287
```
12881288

1289-
**Source:** [src/base/auth.ts:864](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L864)
1289+
**Source:** [src/base/auth.ts:866](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L866)
12901290

12911291
### AuthEntryReadiness
12921292

@@ -1300,7 +1300,7 @@ interface AuthEntryReadiness {
13001300
}
13011301
```
13021302

1303-
**Source:** [src/base/auth.ts:880](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L880)
1303+
**Source:** [src/base/auth.ts:882](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L882)
13041304

13051305
#### `authEntryReadiness.expired`
13061306

@@ -1311,7 +1311,7 @@ exclusive). Always `false` for source-account credentials.
13111311
expired: boolean;
13121312
```
13131313

1314-
**Source:** [src/base/auth.ts:887](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L887)
1314+
**Source:** [src/base/auth.ts:889](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L889)
13151315

13161316
#### `authEntryReadiness.ready`
13171317

@@ -1321,7 +1321,7 @@ expired: boolean;
13211321
ready: boolean;
13221322
```
13231323

1324-
**Source:** [src/base/auth.ts:882](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L882)
1324+
**Source:** [src/base/auth.ts:884](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L884)
13251325

13261326
#### `authEntryReadiness.unsignedBy`
13271327

@@ -1331,7 +1331,7 @@ addresses of signer nodes that carry no signature payload.
13311331
unsignedBy: string[];
13321332
```
13331333

1334-
**Source:** [src/base/auth.ts:889](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L889)
1334+
**Source:** [src/base/auth.ts:891](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L891)
13351335

13361336
### AuthEntrySignature
13371337

@@ -1345,7 +1345,7 @@ interface AuthEntrySignature {
13451345
}
13461346
```
13471347

1348-
**Source:** [src/base/auth.ts:807](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L807)
1348+
**Source:** [src/base/auth.ts:809](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L809)
13491349

13501350
#### `authEntrySignature.publicKey`
13511351

@@ -1355,7 +1355,7 @@ the signer's public key, as a `G…` strkey.
13551355
publicKey: string;
13561356
```
13571357

1358-
**Source:** [src/base/auth.ts:809](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L809)
1358+
**Source:** [src/base/auth.ts:811](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L811)
13591359

13601360
#### `authEntrySignature.signature`
13611361

@@ -1365,7 +1365,7 @@ the raw 64-byte ed25519 signature.
13651365
signature: Uint8Array;
13661366
```
13671367

1368-
**Source:** [src/base/auth.ts:811](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L811)
1368+
**Source:** [src/base/auth.ts:813](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L813)
13691369

13701370
### AuthEntrySigner
13711371

@@ -1382,7 +1382,7 @@ interface AuthEntrySigner {
13821382
}
13831383
```
13841384

1385-
**Source:** [src/base/auth.ts:819](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L819)
1385+
**Source:** [src/base/auth.ts:821](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L821)
13861386

13871387
#### `authEntrySigner.address`
13881388

@@ -1392,7 +1392,7 @@ the node's address (`G…` account or `C…` contract).
13921392
address: string;
13931393
```
13941394

1395-
**Source:** [src/base/auth.ts:821](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L821)
1395+
**Source:** [src/base/auth.ts:823](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L823)
13961396

13971397
#### `authEntrySigner.rawSignature`
13981398

@@ -1402,7 +1402,7 @@ the raw signature value, whatever its shape.
14021402
rawSignature: ScVal;
14031403
```
14041404

1405-
**Source:** [src/base/auth.ts:840](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L840)
1405+
**Source:** [src/base/auth.ts:842](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L842)
14061406

14071407
#### `authEntrySigner.signatures`
14081408

@@ -1418,7 +1418,7 @@ node is unsigned.
14181418
signatures: AuthEntrySignature[] | null;
14191419
```
14201420

1421-
**Source:** [src/base/auth.ts:838](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L838)
1421+
**Source:** [src/base/auth.ts:840](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L840)
14221422

14231423
#### `authEntrySigner.signed`
14241424

@@ -1431,7 +1431,7 @@ contract's `__check_auth` cannot be verified client-side.
14311431
signed: boolean;
14321432
```
14331433

1434-
**Source:** [src/base/auth.ts:828](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L828)
1434+
**Source:** [src/base/auth.ts:830](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L830)
14351435

14361436
### AuthorizeInvocationParams
14371437

@@ -1461,7 +1461,7 @@ interface AuthorizeInvocationParams {
14611461

14621462
- authorizeEntry
14631463

1464-
**Source:** [src/base/auth.ts:394](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L394)
1464+
**Source:** [src/base/auth.ts:396](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L396)
14651465

14661466
#### `authorizeInvocationParams.authV2`
14671467

@@ -1473,47 +1473,47 @@ the signed payload.
14731473
authV2?: boolean;
14741474
```
14751475

1476-
**Source:** [src/base/auth.ts:406](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L406)
1476+
**Source:** [src/base/auth.ts:408](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L408)
14771477

14781478
#### `authorizeInvocationParams.invocation`
14791479

14801480
```ts
14811481
invocation: SorobanAuthorizedInvocation;
14821482
```
14831483

1484-
**Source:** [src/base/auth.ts:397](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L397)
1484+
**Source:** [src/base/auth.ts:399](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L399)
14851485

14861486
#### `authorizeInvocationParams.networkPassphrase`
14871487

14881488
```ts
14891489
networkPassphrase: string;
14901490
```
14911491

1492-
**Source:** [src/base/auth.ts:398](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L398)
1492+
**Source:** [src/base/auth.ts:400](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L400)
14931493

14941494
#### `authorizeInvocationParams.publicKey`
14951495

14961496
```ts
14971497
publicKey?: string;
14981498
```
14991499

1500-
**Source:** [src/base/auth.ts:399](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L399)
1500+
**Source:** [src/base/auth.ts:401](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L401)
15011501

15021502
#### `authorizeInvocationParams.signer`
15031503

15041504
```ts
15051505
signer: Keypair | SigningCallback;
15061506
```
15071507

1508-
**Source:** [src/base/auth.ts:395](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L395)
1508+
**Source:** [src/base/auth.ts:397](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L397)
15091509

15101510
#### `authorizeInvocationParams.validUntilLedgerSeq`
15111511

15121512
```ts
15131513
validUntilLedgerSeq: number;
15141514
```
15151515

1516-
**Source:** [src/base/auth.ts:396](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L396)
1516+
**Source:** [src/base/auth.ts:398](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L398)
15171517

15181518
### BuildWithDelegatesParams
15191519

@@ -1528,7 +1528,7 @@ interface BuildWithDelegatesParams {
15281528
}
15291529
```
15301530

1531-
**Source:** [src/base/auth.ts:540](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L540)
1531+
**Source:** [src/base/auth.ts:542](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L542)
15321532

15331533
#### `buildWithDelegatesParams.delegates`
15341534

@@ -1538,7 +1538,7 @@ the delegate signers to attach.
15381538
delegates: DelegateSignature[];
15391539
```
15401540

1541-
**Source:** [src/base/auth.ts:550](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L550)
1541+
**Source:** [src/base/auth.ts:552](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L552)
15421542

15431543
#### `buildWithDelegatesParams.entry`
15441544

@@ -1550,7 +1550,7 @@ simulation — whose address credentials should be wrapped.
15501550
entry: SorobanAuthorizationEntry;
15511551
```
15521552

1553-
**Source:** [src/base/auth.ts:546](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L546)
1553+
**Source:** [src/base/auth.ts:548](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L548)
15541554

15551555
#### `buildWithDelegatesParams.signature`
15561556

@@ -1561,7 +1561,7 @@ for accounts that authorize purely via delegated signers (CAP-71-01).
15611561
signature?: ScVal;
15621562
```
15631563

1564-
**Source:** [src/base/auth.ts:555](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L555)
1564+
**Source:** [src/base/auth.ts:557](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L557)
15651565

15661566
#### `buildWithDelegatesParams.validUntilLedgerSeq`
15671567

@@ -1571,7 +1571,7 @@ the expiration ledger sequence stored on the top-level credentials.
15711571
validUntilLedgerSeq: number;
15721572
```
15731573

1574-
**Source:** [src/base/auth.ts:548](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L548)
1574+
**Source:** [src/base/auth.ts:550](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L550)
15751575

15761576
### CreateInvocation
15771577

@@ -1643,7 +1643,7 @@ interface DelegateSignature {
16431643
}
16441644
```
16451645

1646-
**Source:** [src/base/auth.ts:526](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L526)
1646+
**Source:** [src/base/auth.ts:528](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L528)
16471647

16481648
#### `delegateSignature.address`
16491649

@@ -1653,7 +1653,7 @@ the delegate's address (`G…` account or `C…` contract).
16531653
address: string;
16541654
```
16551655

1656-
**Source:** [src/base/auth.ts:528](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L528)
1656+
**Source:** [src/base/auth.ts:530](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L530)
16571657

16581658
#### `delegateSignature.nestedDelegates`
16591659

@@ -1663,7 +1663,7 @@ signers this delegate in turn delegates to (recursive).
16631663
nestedDelegates?: DelegateSignature[];
16641664
```
16651665

1666-
**Source:** [src/base/auth.ts:536](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L536)
1666+
**Source:** [src/base/auth.ts:538](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L538)
16671667

16681668
#### `delegateSignature.signature`
16691669

@@ -1675,7 +1675,7 @@ as `forAddress`) or by editing the entry directly.
16751675
signature?: ScVal;
16761676
```
16771677

1678-
**Source:** [src/base/auth.ts:534](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L534)
1678+
**Source:** [src/base/auth.ts:536](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L536)
16791679

16801680
### ExecuteInvocation
16811681

@@ -1878,7 +1878,7 @@ necessary to authorize an invocation tree.
18781878
type SigningCallback = (preimage: HashIdPreimage, payload: Uint8Array) => Promise<Uint8Array | { publicKey: string; signature: Uint8Array } | { address?: string; signatureScVal: ScVal }>
18791879
```
18801880
1881-
**Source:** [src/base/auth.ts:58](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L58)
1881+
**Source:** [src/base/auth.ts:60](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/auth.ts#L60)
18821882
18831883
### WasmCreateDetails
18841884

0 commit comments

Comments
 (0)