Skip to content

Commit c7491e5

Browse files
jxomjxom
committed
chore: jsdoc
1 parent 7997629 commit c7491e5

File tree

8 files changed

+27
-27
lines changed

8 files changed

+27
-27
lines changed

‎src/tempo/AuthorizationTempo.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import * as SignatureEnvelope from './SignatureEnvelope.js'
1212
* Tempo extends EIP-7702 to support secp256k1, P256, and WebAuthn signature types,
1313
* enabling passkey-based account delegation.
1414
*
15-
* @see [Tempo Authorization Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#tempo-authorization-list)
15+
* [Tempo Authorization Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#tempo-authorization-list)
1616
*/
1717
export type AuthorizationTempo<
1818
signed extends boolean = boolean,
@@ -91,7 +91,7 @@ export type TupleListSigned = TupleList<true>
9191
*
9292
* Tempo extends EIP-7702 to support secp256k1, P256, and WebAuthn signature types.
9393
*
94-
* @see [Tempo Authorization Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#tempo-authorization-list)
94+
* [Tempo Authorization Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#tempo-authorization-list)
9595
*
9696
* @example
9797
* An Authorization can be instantiated from an EIP-7702 Authorization tuple in object format.

‎src/tempo/KeyAuthorization.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import * as SignatureEnvelope from './SignatureEnvelope.js'
2525
* - `limits`: Per-TIP-20 token spending limits (only applies to `transfer()` and `approve()` calls)
2626
* - `type`: Key type (`secp256k1`, `p256`, or `webAuthn`)
2727
*
28-
* @see [Access Keys Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#access-keys)
28+
* [Access Keys Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#access-keys)
2929
*/
3030
export type KeyAuthorization<
3131
signed extends boolean = boolean,
@@ -103,7 +103,7 @@ export type Tuple<signed extends boolean = boolean> = signed extends true
103103
* Defines a per-TIP-20 token spending limit for an access key. Limits deplete as tokens
104104
* are spent and can be updated by the root key via `updateSpendingLimit()`.
105105
*
106-
* @see [Access Keys Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#access-keys)
106+
* [Access Keys Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#access-keys)
107107
*/
108108
export type TokenLimit<bigintType = bigint> = {
109109
/** Address of the TIP-20 token. */
@@ -120,7 +120,7 @@ export type TokenLimit<bigintType = bigint> = {
120120
* can be included in a {@link ox#TransactionEnvelopeTempo.TransactionEnvelopeTempo} via the
121121
* `keyAuthorization` field to provision the access key on-chain.
122122
*
123-
* @see [Access Keys Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#access-keys)
123+
* [Access Keys Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#access-keys)
124124
*
125125
* @example
126126
* ### Secp256k1 Key
@@ -424,7 +424,7 @@ export declare namespace fromTuple {
424424
* is attached to the key authorization via {@link ox#KeyAuthorization.(from:function)} with the
425425
* `signature` option.
426426
*
427-
* @see [Access Keys Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#access-keys)
427+
* [Access Keys Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#access-keys)
428428
*
429429
* @example
430430
* ```ts twoslash

‎src/tempo/PoolId.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import * as TokenId from './TokenId.js'
88
* Pool IDs are deterministic keys derived from two token addresses (order-independent)
99
* used to identify trading pairs on Tempo's enshrined stablecoin DEX.
1010
*
11-
* @see [Stablecoin DEX Specification](https://docs.tempo.xyz/protocol/exchange/spec)
11+
* [Stablecoin DEX Specification](https://docs.tempo.xyz/protocol/exchange/spec)
1212
*
1313
* @example
1414
* ```ts twoslash

‎src/tempo/SignatureEnvelope.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ export type GetType<
8282
* p256, or webAuthn). Format: `0x03` + user_address (20 bytes) + inner signature. The
8383
* protocol validates the access key authorization via the AccountKeychain precompile.
8484
*
85-
* @see [Signature Types Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#signature-types)
85+
* [Signature Types Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#signature-types)
8686
*/
8787
export type SignatureEnvelope<bigintType = bigint, numberType = number> = OneOf<
8888
| Secp256k1<bigintType, numberType>
@@ -270,7 +270,7 @@ export declare namespace assert {
270270
* - Type `0x02` + variable: WebAuthn signature (webauthnData, r, s, pubKeyX, pubKeyY)
271271
* - Type `0x03` + 20 bytes + inner: Keychain signature (userAddress + inner signature)
272272
*
273-
* @see [Signature Types](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#signature-types)
273+
* [Signature Types](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#signature-types)
274274
*
275275
* @example
276276
* ```ts twoslash
@@ -410,7 +410,7 @@ export function deserialize(serialized: Serialized): SignatureEnvelope {
410410
* {@link ox#WebCryptoP256.(sign:function)}, or {@link ox#WebAuthnP256.(sign:function)} into the envelope format
411411
* required by Tempo transactions.
412412
*
413-
* @see [Signature Types](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#signature-types)
413+
* [Signature Types](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#signature-types)
414414
*
415415
* @example
416416
* ### Secp256k1
@@ -745,7 +745,7 @@ export function getType<
745745
* - WebAuthn: `0x02` + webauthnData (variable) + r (32) + s (32) + pubKeyX (32) + pubKeyY (32)
746746
* - Keychain: `0x03` + userAddress (20) + inner signature (recursive)
747747
*
748-
* @see [Signature Types](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#signature-types)
748+
* [Signature Types](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#signature-types)
749749
*
750750
* @example
751751
* ```ts twoslash

‎src/tempo/Tick.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ import * as Errors from '../core/Errors.js'
33
/**
44
* Minimum allowed tick value (-2% from peg).
55
*
6-
* @see [Stablecoin DEX Pricing](https://docs.tempo.xyz/protocol/exchange/spec#key-concepts)
6+
* [Stablecoin DEX Pricing](https://docs.tempo.xyz/protocol/exchange/spec#key-concepts)
77
*/
88
export const minTick = -2000
99

1010
/**
1111
* Maximum allowed tick value (+2% from peg).
1212
*
13-
* @see [Stablecoin DEX Pricing](https://docs.tempo.xyz/protocol/exchange/spec#key-concepts)
13+
* [Stablecoin DEX Pricing](https://docs.tempo.xyz/protocol/exchange/spec#key-concepts)
1414
*/
1515
export const maxTick = 2000
1616

@@ -20,7 +20,7 @@ export const maxTick = 2000
2020
* The DEX uses a tick-based pricing system where `price = PRICE_SCALE + tick`.
2121
* Orders must be placed at ticks divisible by `TICK_SPACING = 10` (1 bp grid).
2222
*
23-
* @see [Stablecoin DEX Pricing](https://docs.tempo.xyz/protocol/exchange/spec#key-concepts)
23+
* [Stablecoin DEX Pricing](https://docs.tempo.xyz/protocol/exchange/spec#key-concepts)
2424
*/
2525
export const priceScale = 100_000
2626

@@ -32,7 +32,7 @@ export type Tick = number
3232
/**
3333
* Converts a tick to a price string.
3434
*
35-
* @see [Stablecoin DEX Pricing](https://docs.tempo.xyz/protocol/exchange/spec#key-concepts)
35+
* [Stablecoin DEX Pricing](https://docs.tempo.xyz/protocol/exchange/spec#key-concepts)
3636
*
3737
* @example
3838
* ```ts
@@ -75,7 +75,7 @@ export declare namespace toPrice {
7575
/**
7676
* Converts a price string to a tick.
7777
*
78-
* @see [Stablecoin DEX Pricing](https://docs.tempo.xyz/protocol/exchange/spec#key-concepts)
78+
* [Stablecoin DEX Pricing](https://docs.tempo.xyz/protocol/exchange/spec#key-concepts)
7979
*
8080
* @example
8181
* ```ts

‎src/tempo/TokenId.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export type TokenIdOrAddress = TokenId | Address.Address
1212
* TIP-20 is Tempo's native token standard for stablecoins with deterministic addresses
1313
* derived from sequential token IDs (prefix `0x20c0`).
1414
*
15-
* @see [TIP-20 Token Standard](https://docs.tempo.xyz/protocol/tip20/overview)
15+
* [TIP-20 Token Standard](https://docs.tempo.xyz/protocol/tip20/overview)
1616
*
1717
* @example
1818
* ```ts twoslash
@@ -36,7 +36,7 @@ export function from(tokenIdOrAddress: TokenIdOrAddress | number): TokenId {
3636
/**
3737
* Converts a TIP-20 token address to a token ID.
3838
*
39-
* @see [TIP-20 Token Standard](https://docs.tempo.xyz/protocol/tip20/overview)
39+
* [TIP-20 Token Standard](https://docs.tempo.xyz/protocol/tip20/overview)
4040
*
4141
* @example
4242
* ```ts twoslash
@@ -57,7 +57,7 @@ export function fromAddress(address: Address.Address): TokenId {
5757
/**
5858
* Converts a TIP-20 token ID to an address.
5959
*
60-
* @see [TIP-20 Token Standard](https://docs.tempo.xyz/protocol/tip20/overview)
60+
* [TIP-20 Token Standard](https://docs.tempo.xyz/protocol/tip20/overview)
6161
*
6262
* @example
6363
* ```ts twoslash

‎src/tempo/TokenRole.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export const toPreHashed = {
2424
* TIP-20 includes a built-in RBAC system with roles like `ISSUER_ROLE` (mint/burn),
2525
* `PAUSE_ROLE`/`UNPAUSE_ROLE` (emergency controls), and `BURN_BLOCKED_ROLE` (compliance).
2626
*
27-
* @see [TIP-20 RBAC](https://docs.tempo.xyz/protocol/tip20/overview#role-based-access-control-rbac)
27+
* [TIP-20 RBAC](https://docs.tempo.xyz/protocol/tip20/overview#role-based-access-control-rbac)
2828
*
2929
* @example
3030
* ```ts twoslash

‎src/tempo/TransactionEnvelopeTempo.ts‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import * as TokenId from './TokenId.js'
2323
*
2424
* Tempo transactions support batching multiple calls for atomic execution.
2525
*
26-
* @see [Batch Calls](https://docs.tempo.xyz/protocol/transactions#batch-calls)
26+
* [Batch Calls](https://docs.tempo.xyz/protocol/transactions#batch-calls)
2727
*/
2828
export type Call<bigintType = bigint> = {
2929
/** Call data. */
@@ -60,7 +60,7 @@ export type Call<bigintType = bigint> = {
6060
*
6161
* - **Multi-Signature Support**: Sign with secp256k1, P256 (passkeys), or WebAuthn credentials.
6262
*
63-
* @see [Tempo Transaction Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction)
63+
* [Tempo Transaction Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction)
6464
*/
6565
export type TransactionEnvelopeTempo<
6666
signed extends boolean = boolean,
@@ -390,7 +390,7 @@ export declare namespace deserialize {
390390
* fee tokens, access keys, and scheduled execution. Attach a signature using the `signature`
391391
* option after signing with {@link ox#TransactionEnvelopeTempo.(getSignPayload:function)}.
392392
*
393-
* @see [Tempo Transaction Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction)
393+
* [Tempo Transaction Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction)
394394
*
395395
* @example
396396
* ```ts twoslash
@@ -540,7 +540,7 @@ export declare namespace from {
540540
* RLP-encodes the transaction with type prefix `0x76`. For fee sponsorship, use `format: 'feePayer'`
541541
* to serialize with the fee payer magic `0x78` and the sender address.
542542
*
543-
* @see [RLP Encoding](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#rlp-encoding)
543+
* [RLP Encoding](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#rlp-encoding)
544544
*
545545
* @example
546546
* ```ts twoslash
@@ -716,7 +716,7 @@ export declare namespace serialize {
716716
* Computes the keccak256 hash of the unsigned serialized transaction. Sign this payload
717717
* with secp256k1, P256, or WebAuthn, then attach the signature via {@link ox#TransactionEnvelopeTempo.(from:function)}.
718718
*
719-
* @see [Tempo Transaction Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction)
719+
* [Tempo Transaction Specification](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction)
720720
*
721721
* @example
722722
* The example below demonstrates how to compute the sign payload which can be used
@@ -833,8 +833,8 @@ export declare namespace hash {
833833
* signs over the transaction with the sender's address to commit to paying fees. The fee payer's
834834
* signature includes the `feeToken` and `sender_address`, using magic byte `0x78` for domain separation.
835835
*
836-
* @see [Fee Payer Signature](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#fee-payer-signature)
837-
* @see [Fee Sponsorship Guide](https://docs.tempo.xyz/protocol/transactions#fee-sponsorship)
836+
* [Fee Payer Signature](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction#fee-payer-signature)
837+
* [Fee Sponsorship Guide](https://docs.tempo.xyz/protocol/transactions#fee-sponsorship)
838838
*
839839
* @example
840840
* ```ts twoslash

0 commit comments

Comments
 (0)