Skip to content

Commit 18a8a02

Browse files
committed
docs: regenerate reference for Memo.id bigint support
1 parent de4d84c commit 18a8a02

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

docs/reference/core-transactions.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -441,7 +441,7 @@ class Memo<T extends MemoType = MemoType> {
441441
constructor(type: "none", value?: null);
442442
static fromXdrObject(object: Memo): Memo;
443443
static hash(hash: string | Uint8Array<ArrayBufferLike>): Memo<"hash">;
444-
static id(id: string): Memo<"id">;
444+
static id(id: string | bigint): Memo<"id">;
445445
static none(): Memo<"none">;
446446
static return(hash: string | Uint8Array<ArrayBufferLike>): Memo<"return">;
447447
static text(text: string | Uint8Array<ArrayBufferLike>): Memo<"text">;
@@ -455,7 +455,7 @@ class Memo<T extends MemoType = MemoType> {
455455

456456
- [Transactions concept](https://developers.stellar.org/docs/glossary/transactions/)
457457

458-
**Source:** [src/base/memo.ts:63](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L63)
458+
**Source:** [src/base/memo.ts:59](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L59)
459459

460460
### `new Memo(type, value)`
461461

@@ -468,7 +468,7 @@ constructor(type: "none", value?: null);
468468
- **`type`**`"none"` (required)
469469
- **`value`**`null` (optional)
470470

471-
**Source:** [src/base/memo.ts:67](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L67)
471+
**Source:** [src/base/memo.ts:63](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L63)
472472

473473
### `Memo.fromXdrObject(object)`
474474

@@ -482,7 +482,7 @@ static fromXdrObject(object: Memo): Memo;
482482

483483
- **`object`**`Memo` (required) — XDR memo object
484484

485-
**Source:** [src/base/memo.ts:303](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L303)
485+
**Source:** [src/base/memo.ts:312](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L312)
486486

487487
### `Memo.hash(hash)`
488488

@@ -496,21 +496,21 @@ static hash(hash: string | Uint8Array<ArrayBufferLike>): Memo<"hash">;
496496

497497
- **`hash`**`string | Uint8Array<ArrayBufferLike>` (required) — 32 byte hash or hex encoded string
498498

499-
**Source:** [src/base/memo.ts:262](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L262)
499+
**Source:** [src/base/memo.ts:271](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L271)
500500

501501
### `Memo.id(id)`
502502

503503
Creates and returns a `MemoID` memo.
504504

505505
```ts
506-
static id(id: string): Memo<"id">;
506+
static id(id: string | bigint): Memo<"id">;
507507
```
508508

509509
**Parameters**
510510

511-
- **`id`**`string` (required) — 64-bit number represented as a string
511+
- **`id`**`string | bigint` (required) — 64-bit number represented as a string
512512

513-
**Source:** [src/base/memo.ts:253](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L253)
513+
**Source:** [src/base/memo.ts:262](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L262)
514514

515515
### `Memo.none()`
516516

@@ -520,7 +520,7 @@ Returns an empty memo (`MemoNone`).
520520
static none(): Memo<"none">;
521521
```
522522

523-
**Source:** [src/base/memo.ts:233](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L233)
523+
**Source:** [src/base/memo.ts:242](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L242)
524524

525525
### `Memo.return(hash)`
526526

@@ -534,7 +534,7 @@ static return(hash: string | Uint8Array<ArrayBufferLike>): Memo<"return">;
534534
535535
- **`hash`** — `string | Uint8Array<ArrayBufferLike>` (required) — 32 byte hash or hex encoded string
536536
537-
**Source:** [src/base/memo.ts:271](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L271)
537+
**Source:** [src/base/memo.ts:280](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L280)
538538
539539
### `Memo.text(text)`
540540
@@ -550,7 +550,7 @@ static text(text: string | Uint8Array<ArrayBufferLike>): Memo<"text">;
550550
pass a `Uint8Array` for byte-exact content. A plain `number[]` is not
551551
accepted (16.2.0 and earlier took one); wrap it: `new Uint8Array(arr)`.
552552
553-
**Source:** [src/base/memo.ts:244](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L244)
553+
**Source:** [src/base/memo.ts:253](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L253)
554554
555555
### `memo.type`
556556
@@ -560,7 +560,7 @@ Contains memo type: `MemoNone`, `MemoID`, `MemoText`, `MemoHash` or `MemoReturn`
560560
type: T;
561561
```
562562
563-
**Source:** [src/base/memo.ts:107](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L107)
563+
**Source:** [src/base/memo.ts:104](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L104)
564564
565565
### `memo.value`
566566
@@ -574,7 +574,7 @@ Contains memo value:
574574
value: MemoTypeToValue<T>;
575575
```
576576
577-
**Source:** [src/base/memo.ts:122](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L122)
577+
**Source:** [src/base/memo.ts:119](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L119)
578578
579579
### `memo.toXdrObject()`
580580
@@ -584,7 +584,7 @@ Returns XDR memo object.
584584
toXdrObject(): Memo;
585585
```
586586
587-
**Source:** [src/base/memo.ts:278](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L278)
587+
**Source:** [src/base/memo.ts:287](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L287)
588588
589589
## MemoHash
590590
@@ -3692,7 +3692,7 @@ type MemoTypeText = typeof MemoText
36923692
type MemoValue = string | null | Uint8Array
36933693
```
36943694
3695-
**Source:** [src/base/memo.ts:47](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L47)
3695+
**Source:** [src/base/memo.ts:43](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/memo.ts#L43)
36963696
36973697
### Networks
36983698

0 commit comments

Comments
 (0)