Skip to content

docs(tempo): use bech32m addresses in JSDoc examples #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jxom merged 1 commit into from
Mar 5, 2026
+55 −55
Merged

docs(tempo): use bech32m addresses in JSDoc examples #186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions src/tempo/AuthorizationTempo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ export type TupleListSigned = TupleList<true>
* import { AuthorizationTempo } from 'ox/tempo'
*
* const authorization = AuthorizationTempo.from({
* address: '0x1234567890abcdef1234567890abcdef12345678',
* address: 'tempo1qqfrg4ncjz4ummcjx3t83y9tehh3ydzk0qhcg00y',
* chainId: 1,
* nonce: 69n,
* })
Expand All @@ -119,7 +119,7 @@ export type TupleListSigned = TupleList<true>
* const privateKey = Secp256k1.randomPrivateKey()
*
* const authorization = AuthorizationTempo.from({
* address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
* address: 'tempo1qzlftsl42n5lep0v2xlxng7cq7sd2k709sxlwnsu',
* chainId: 1,
* nonce: 40n,
* })
Expand Down Expand Up @@ -149,7 +149,7 @@ export type TupleListSigned = TupleList<true>
* const { privateKey, publicKey } = P256.createKeyPair()
*
* const authorization = AuthorizationTempo.from({
* address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
* address: 'tempo1qzlftsl42n5lep0v2xlxng7cq7sd2k709sxlwnsu',
* chainId: 1,
* nonce: 40n,
* })
Expand Down Expand Up @@ -184,7 +184,7 @@ export type TupleListSigned = TupleList<true>
* const { privateKey, publicKey } = await WebCryptoP256.createKeyPair()
*
* const authorization = AuthorizationTempo.from({
* address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
* address: 'tempo1qzlftsl42n5lep0v2xlxng7cq7sd2k709sxlwnsu',
* chainId: 1,
* nonce: 40n,
* })
Expand Down Expand Up @@ -220,7 +220,7 @@ export type TupleListSigned = TupleList<true>
* const credential = await WebAuthnP256.createCredential({ name: 'Example' })
*
* const authorization = AuthorizationTempo.from({
* address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
* address: 'tempo1qzlftsl42n5lep0v2xlxng7cq7sd2k709sxlwnsu',
* chainId: 1,
* nonce: 40n,
* })
Expand Down Expand Up @@ -302,7 +302,7 @@ export declare namespace from {
* import { AuthorizationTempo } from 'ox/tempo'
*
* const authorization = AuthorizationTempo.fromRpc({
* address: '0x0000000000000000000000000000000000000000',
* address: 'tempo1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj97hme',
* chainId: '0x1',
* nonce: '0x1',
* signature: {
Expand Down Expand Up @@ -340,7 +340,7 @@ export declare namespace fromRpc {
* import { AuthorizationTempo } from 'ox/tempo'
*
* const authorizationList = AuthorizationTempo.fromRpcList([{
* address: '0x0000000000000000000000000000000000000000',
* address: 'tempo1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj97hme',
* chainId: '0x1',
* nonce: '0x1',
* signature: {
Expand Down Expand Up @@ -524,7 +524,7 @@ export declare namespace fromTupleList {
* const privateKey = Secp256k1.randomPrivateKey()
*
* const authorization = AuthorizationTempo.from({
* address: '0x1234567890abcdef1234567890abcdef12345678',
* address: 'tempo1qqfrg4ncjz4ummcjx3t83y9tehh3ydzk0qhcg00y',
* chainId: 1,
* nonce: 69n,
* })
Expand Down Expand Up @@ -552,7 +552,7 @@ export declare namespace fromTupleList {
* const { privateKey, publicKey } = P256.createKeyPair()
*
* const authorization = AuthorizationTempo.from({
* address: '0x1234567890abcdef1234567890abcdef12345678',
* address: 'tempo1qqfrg4ncjz4ummcjx3t83y9tehh3ydzk0qhcg00y',
* chainId: 1,
* nonce: 69n,
* })
Expand Down Expand Up @@ -585,7 +585,7 @@ export declare namespace fromTupleList {
* const { privateKey, publicKey } = await WebCryptoP256.createKeyPair()
*
* const authorization = AuthorizationTempo.from({
* address: '0x1234567890abcdef1234567890abcdef12345678',
* address: 'tempo1qqfrg4ncjz4ummcjx3t83y9tehh3ydzk0qhcg00y',
* chainId: 1,
* nonce: 69n,
* })
Expand Down Expand Up @@ -619,7 +619,7 @@ export declare namespace fromTupleList {
* const credential = await WebAuthnP256.createCredential({ name: 'Example' })
*
* const authorization = AuthorizationTempo.from({
* address: '0x1234567890abcdef1234567890abcdef12345678',
* address: 'tempo1qqfrg4ncjz4ummcjx3t83y9tehh3ydzk0qhcg00y',
* chainId: 1,
* nonce: 69n,
* })
Expand Down Expand Up @@ -660,7 +660,7 @@ export declare namespace getSignPayload {
* import { AuthorizationTempo } from 'ox/tempo'
*
* const authorization = AuthorizationTempo.from({
* address: '0x1234567890abcdef1234567890abcdef12345678',
* address: 'tempo1qqfrg4ncjz4ummcjx3t83y9tehh3ydzk0qhcg00y',
* chainId: 1,
* nonce: 69n,
* })
Expand Down Expand Up @@ -716,7 +716,7 @@ export declare namespace hash {
* import { AuthorizationTempo } from 'ox/tempo'
*
* const authorization = AuthorizationTempo.toRpc({
* address: '0x0000000000000000000000000000000000000000',
* address: 'tempo1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj97hme',
* chainId: 1,
* nonce: 1n,
* signature: {
Expand Down Expand Up @@ -756,7 +756,7 @@ export declare namespace toRpc {
* import { AuthorizationTempo } from 'ox/tempo'
*
* const authorization = AuthorizationTempo.toRpcList([{
* address: '0x0000000000000000000000000000000000000000',
* address: 'tempo1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqj97hme',
* chainId: 1,
* nonce: 1n,
* signature: {
Expand Down Expand Up @@ -789,7 +789,7 @@ export declare namespace toRpcList {
* import { AuthorizationTempo } from 'ox/tempo'
*
* const authorization = AuthorizationTempo.from({
* address: '0x1234567890abcdef1234567890abcdef12345678',
* address: 'tempo1qqfrg4ncjz4ummcjx3t83y9tehh3ydzk0qhcg00y',
* chainId: 1,
* nonce: 69n,
* })
Expand Down Expand Up @@ -838,12 +838,12 @@ export declare namespace toTuple {
* import { AuthorizationTempo } from 'ox/tempo'
*
* const authorization_1 = AuthorizationTempo.from({
* address: '0x1234567890abcdef1234567890abcdef12345678',
* address: 'tempo1qqfrg4ncjz4ummcjx3t83y9tehh3ydzk0qhcg00y',
* chainId: 1,
* nonce: 69n,
* })
* const authorization_2 = AuthorizationTempo.from({
* address: '0x1234567890abcdef1234567890abcdef12345678',
* address: 'tempo1qqfrg4ncjz4ummcjx3t83y9tehh3ydzk0qhcg00y',
* chainId: 3,
* nonce: 20n,
* })
Expand Down
30 changes: 15 additions & 15 deletions src/tempo/KeyAuthorization.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ export type TokenLimit<bigintType = bigint> = {
* expiry: 1234567890,
* type: 'secp256k1',
* limits: [{
* token: '0x20c0000000000000000000000000000000000001',
* token: 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqyr9xgnd',
* limit: Value.from('10', 6),
* }],
* })
Expand All @@ -163,7 +163,7 @@ export type TokenLimit<bigintType = bigint> = {
* expiry: 1234567890,
* type: 'p256',
* limits: [{
* token: '0x20c0000000000000000000000000000000000001',
* token: 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqyr9xgnd',
* limit: Value.from('10', 6),
* }],
* })
Expand All @@ -188,7 +188,7 @@ export type TokenLimit<bigintType = bigint> = {
* expiry: 1234567890,
* type: 'secp256k1',
* limits: [{
* token: '0x20c0000000000000000000000000000000000001',
* token: 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqyr9xgnd',
* limit: Value.from('10', 6),
* }],
* })
Expand Down Expand Up @@ -222,7 +222,7 @@ export type TokenLimit<bigintType = bigint> = {
* expiry: 1234567890,
* type: 'p256',
* limits: [{
* token: '0x20c0000000000000000000000000000000000001',
* token: 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqyr9xgnd',
* limit: Value.from('10', 6),
* }],
* })
Expand Down Expand Up @@ -468,7 +468,7 @@ export declare namespace fromTuple {
* expiry: 1234567890,
* type: 'secp256k1',
* limits: [{
* token: '0x20c0000000000000000000000000000000000001',
* token: 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqyr9xgnd',
* limit: Value.from('10', 6),
* }],
* })
Expand Down Expand Up @@ -496,12 +496,12 @@ export declare namespace getSignPayload {
* import { Value } from 'ox'
*
* const authorization = KeyAuthorization.from({
* address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
* address: 'tempo1qzlftsl42n5lep0v2xlxng7cq7sd2k709sxlwnsu',
* chainId: 4217n,
* expiry: 1234567890,
* type: 'secp256k1',
* limits: [{
* token: '0x20c0000000000000000000000000000000000001',
* token: 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqyr9xgnd',
* limit: Value.from('10', 6)
* }],
* })
Expand Down Expand Up @@ -534,12 +534,12 @@ export declare namespace deserialize {
* import { Value } from 'ox'
*
* const authorization = KeyAuthorization.from({
* address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
* address: 'tempo1qzlftsl42n5lep0v2xlxng7cq7sd2k709sxlwnsu',
* chainId: 4217n,
* expiry: 1234567890,
* type: 'secp256k1',
* limits: [{
* token: '0x20c0000000000000000000000000000000000001',
* token: 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqyr9xgnd',
* limit: Value.from('10', 6)
* }],
* })
Expand Down Expand Up @@ -574,12 +574,12 @@ export declare namespace hash {
* import { Value } from 'ox'
*
* const authorization = KeyAuthorization.from({
* address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
* address: 'tempo1qzlftsl42n5lep0v2xlxng7cq7sd2k709sxlwnsu',
* chainId: 4217n,
* expiry: 1234567890,
* type: 'secp256k1',
* limits: [{
* token: '0x20c0000000000000000000000000000000000001',
* token: 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqyr9xgnd',
* limit: Value.from('10', 6)
* }],
* })
Expand Down Expand Up @@ -611,12 +611,12 @@ export declare namespace serialize {
* import { Value } from 'ox'
*
* const authorization = KeyAuthorization.toRpc({
* address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
* address: 'tempo1qzlftsl42n5lep0v2xlxng7cq7sd2k709sxlwnsu',
* chainId: 4217n,
* expiry: 1234567890,
* type: 'secp256k1',
* limits: [{
* token: '0x20c0000000000000000000000000000000000001',
* token: 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqyr9xgnd',
* limit: Value.from('10', 6)
* }],
* signature: {
Expand Down Expand Up @@ -662,12 +662,12 @@ export declare namespace toRpc {
* import { Value } from 'ox'
*
* const authorization = KeyAuthorization.from({
* address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
* address: 'tempo1qzlftsl42n5lep0v2xlxng7cq7sd2k709sxlwnsu',
* chainId: 4217n,
* expiry: 1234567890,
* type: 'secp256k1',
* limits: [{
* token: '0x20c0000000000000000000000000000000000001',
* token: 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqyr9xgnd',
* limit: Value.from('10', 6)
* }],
* })
Expand Down
4 changes: 2 additions & 2 deletions src/tempo/TokenId.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export function from(tokenIdOrAddress: TokenIdOrAddress | number): TokenId {
* ```ts twoslash
* import { TokenId } from 'ox/tempo'
*
* const tokenId = TokenId.fromAddress('0x20c00000000000000000000000000000000000000001')
* const tokenId = TokenId.fromAddress('tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqyr9xgnd')
* ```
*
* @param address - The token address.
Expand Down Expand Up @@ -96,7 +96,7 @@ export function toAddress(tokenId: TokenIdOrAddress): Address.Address {
* import { TokenId } from 'ox/tempo'
*
* const id = TokenId.compute({
* sender: '0x1234567890123456789012345678901234567890',
* sender: 'tempo1qqfrg4ncjqfrg4ncjqfrg4ncjqfrg4ncjqgmv79k',
* salt: '0x0000000000000000000000000000000000000000000000000000000000000001',
* })
* ```
Expand Down
8 changes: 4 additions & 4 deletions src/tempo/TransactionRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ export type Rpc = Omit<
* const request = TransactionRequest.toRpc({
* calls: [{
* data: '0xdeadbeef',
* to: '0xcafebabecafebabecafebabecafebabecafebabe',
* to: 'tempo1qr90aw47etlt40k2l6atajh7h2lv4l46hcx5uwlp',
* }],
* feeToken: '0x20c0000000000000000000000000000000000000',
* feeToken: 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqv0ywuh',
* })
* ```
*
Expand All @@ -87,9 +87,9 @@ export type Rpc = Omit<
* const request = TransactionRequest.toRpc({
* calls: [{
* data: '0xdeadbeef',
* to: '0xcafebabecafebabecafebabecafebabecafebabe',
* to: 'tempo1qr90aw47etlt40k2l6atajh7h2lv4l46hcx5uwlp',
* }],
* feeToken: '0x20c0000000000000000000000000000000000000',
* feeToken: 'tempo1qqsvqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqv0ywuh',
* })
*
* const hash = await provider.request({ // [!code focus]
Expand Down
Loading
Loading