@xyo-network/xl1-protocol-sdk 1.16.1 → 1.16.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/dist/neutral/config/Config.d.ts +6 -18
  2. package/dist/neutral/config/Config.d.ts.map +1 -1
  3. package/dist/neutral/config/Producer.d.ts +2 -6
  4. package/dist/neutral/config/Producer.d.ts.map +1 -1
  5. package/dist/neutral/config/Validation.d.ts +4 -12
  6. package/dist/neutral/config/Validation.d.ts.map +1 -1
  7. package/dist/neutral/driver/cache/LruCacheMap.d.ts +1 -0
  8. package/dist/neutral/driver/cache/LruCacheMap.d.ts.map +1 -1
  9. package/dist/neutral/driver/memory/MemoryMap.d.ts +1 -0
  10. package/dist/neutral/driver/memory/MemoryMap.d.ts.map +1 -1
  11. package/dist/neutral/eip-712/Payloads/EIP712Signature.d.ts +1 -9
  12. package/dist/neutral/eip-712/Payloads/EIP712Signature.d.ts.map +1 -1
  13. package/dist/neutral/index.d.ts +1 -0
  14. package/dist/neutral/index.d.ts.map +1 -1
  15. package/dist/neutral/index.mjs +462 -21
  16. package/dist/neutral/index.mjs.map +1 -1
  17. package/dist/neutral/map/AsynchronousMap.d.ts +1 -0
  18. package/dist/neutral/map/AsynchronousMap.d.ts.map +1 -1
  19. package/dist/neutral/map/SynchronousMap.d.ts +1 -0
  20. package/dist/neutral/map/SynchronousMap.d.ts.map +1 -1
  21. package/dist/neutral/payloads/netBalancesForPayloads.d.ts +2 -3
  22. package/dist/neutral/payloads/netBalancesForPayloads.d.ts.map +1 -1
  23. package/dist/neutral/provider/DataLake.d.ts +6 -2
  24. package/dist/neutral/provider/DataLake.d.ts.map +1 -1
  25. package/dist/neutral/provider/XyoClient.d.ts +3 -3
  26. package/dist/neutral/provider/XyoClient.d.ts.map +1 -1
  27. package/dist/neutral/provider/XyoConnection.d.ts +1 -23
  28. package/dist/neutral/provider/XyoConnection.d.ts.map +1 -1
  29. package/dist/neutral/provider/XyoGateway.d.ts +4 -10
  30. package/dist/neutral/provider/XyoGateway.d.ts.map +1 -1
  31. package/dist/neutral/provider/XyoGatewayRunner.d.ts +25 -0
  32. package/dist/neutral/provider/XyoGatewayRunner.d.ts.map +1 -0
  33. package/dist/neutral/provider/index.d.ts +2 -2
  34. package/dist/neutral/provider/index.d.ts.map +1 -1
  35. package/dist/neutral/provider/{XyoSigner.d.ts → signer/XyoSigner.d.ts} +2 -2
  36. package/dist/neutral/provider/signer/XyoSigner.d.ts.map +1 -0
  37. package/dist/neutral/provider/signer/index.d.ts +2 -0
  38. package/dist/neutral/provider/signer/index.d.ts.map +1 -0
  39. package/dist/neutral/provider/viewer/StepViewer.d.ts +1 -1
  40. package/dist/neutral/provider/viewer/StepViewer.d.ts.map +1 -1
  41. package/dist/neutral/simple/client/SimpleXyoClient.d.ts +7 -0
  42. package/dist/neutral/simple/client/SimpleXyoClient.d.ts.map +1 -0
  43. package/dist/neutral/simple/client/index.d.ts +2 -0
  44. package/dist/neutral/simple/client/index.d.ts.map +1 -0
  45. package/dist/neutral/simple/datalake/SimpleDataLakeRunner.d.ts +15 -0
  46. package/dist/neutral/simple/datalake/SimpleDataLakeRunner.d.ts.map +1 -0
  47. package/dist/neutral/simple/datalake/SimpleDataLakeViewer.d.ts +23 -0
  48. package/dist/neutral/simple/datalake/SimpleDataLakeViewer.d.ts.map +1 -0
  49. package/dist/neutral/simple/datalake/index.d.ts +3 -0
  50. package/dist/neutral/simple/datalake/index.d.ts.map +1 -0
  51. package/dist/neutral/simple/gateway/SimpleXyoGateway.d.ts +9 -0
  52. package/dist/neutral/simple/gateway/SimpleXyoGateway.d.ts.map +1 -0
  53. package/dist/neutral/simple/gateway/SimpleXyoGatewayRunner.d.ts +20 -0
  54. package/dist/neutral/simple/gateway/SimpleXyoGatewayRunner.d.ts.map +1 -0
  55. package/dist/neutral/simple/gateway/index.d.ts +3 -0
  56. package/dist/neutral/simple/gateway/index.d.ts.map +1 -0
  57. package/dist/neutral/simple/index.d.ts +8 -0
  58. package/dist/neutral/simple/index.d.ts.map +1 -0
  59. package/dist/neutral/simple/network/SimpleXyoNetwork.d.ts +9 -0
  60. package/dist/neutral/simple/network/SimpleXyoNetwork.d.ts.map +1 -0
  61. package/dist/neutral/simple/network/index.d.ts +2 -0
  62. package/dist/neutral/simple/network/index.d.ts.map +1 -0
  63. package/dist/neutral/simple/network/lib/FailedNetworkStatusPayloads.d.ts +4 -0
  64. package/dist/neutral/simple/network/lib/FailedNetworkStatusPayloads.d.ts.map +1 -0
  65. package/dist/neutral/simple/network/lib/StatusNetworks.d.ts +10 -0
  66. package/dist/neutral/simple/network/lib/StatusNetworks.d.ts.map +1 -0
  67. package/dist/neutral/simple/network/lib/index.d.ts +3 -0
  68. package/dist/neutral/simple/network/lib/index.d.ts.map +1 -0
  69. package/dist/neutral/simple/network/spec/XyoNetwork.spec.d.ts +2 -0
  70. package/dist/neutral/simple/network/spec/XyoNetwork.spec.d.ts.map +1 -0
  71. package/dist/neutral/simple/permissions/SimpleXyoPermissions.d.ts +17 -0
  72. package/dist/neutral/simple/permissions/SimpleXyoPermissions.d.ts.map +1 -0
  73. package/dist/neutral/simple/permissions/index.d.ts +3 -0
  74. package/dist/neutral/simple/permissions/index.d.ts.map +1 -0
  75. package/dist/neutral/simple/permissions/spec/SimpleXyoPermissions.spec.d.ts +2 -0
  76. package/dist/neutral/simple/permissions/spec/SimpleXyoPermissions.spec.d.ts.map +1 -0
  77. package/dist/neutral/simple/permissions/store/MemoryPermissions.d.ts +16 -0
  78. package/dist/neutral/simple/permissions/store/MemoryPermissions.d.ts.map +1 -0
  79. package/dist/neutral/simple/permissions/store/PermissionsStore.d.ts +12 -0
  80. package/dist/neutral/simple/permissions/store/PermissionsStore.d.ts.map +1 -0
  81. package/dist/neutral/simple/permissions/store/index.d.ts +3 -0
  82. package/dist/neutral/simple/permissions/store/index.d.ts.map +1 -0
  83. package/dist/neutral/simple/runner/SimpleXyoRunner.d.ts +11 -0
  84. package/dist/neutral/simple/runner/SimpleXyoRunner.d.ts.map +1 -0
  85. package/dist/neutral/simple/runner/index.d.ts +2 -0
  86. package/dist/neutral/simple/runner/index.d.ts.map +1 -0
  87. package/dist/neutral/simple/signer/SimpleXyoSigner.d.ts +15 -0
  88. package/dist/neutral/simple/signer/SimpleXyoSigner.d.ts.map +1 -0
  89. package/dist/neutral/simple/signer/index.d.ts +2 -0
  90. package/dist/neutral/simple/signer/index.d.ts.map +1 -0
  91. package/package.json +20 -15
  92. package/src/driver/cache/LruCacheMap.ts +6 -0
  93. package/src/driver/memory/MemoryMap.ts +6 -0
  94. package/src/index.ts +1 -0
  95. package/src/map/AsynchronousMap.ts +1 -0
  96. package/src/map/SynchronousMap.ts +1 -0
  97. package/src/provider/DataLake.ts +8 -3
  98. package/src/provider/XyoClient.ts +3 -3
  99. package/src/provider/XyoConnection.ts +1 -43
  100. package/src/provider/XyoGateway.ts +4 -12
  101. package/src/provider/XyoGatewayRunner.ts +42 -0
  102. package/src/provider/index.ts +2 -2
  103. package/src/provider/{XyoSigner.ts → signer/XyoSigner.ts} +2 -2
  104. package/src/provider/signer/index.ts +1 -0
  105. package/src/provider/viewer/StepViewer.ts +1 -1
  106. package/src/simple/client/SimpleXyoClient.ts +13 -0
  107. package/src/simple/client/index.ts +1 -0
  108. package/src/simple/datalake/SimpleDataLakeRunner.ts +36 -0
  109. package/src/simple/datalake/SimpleDataLakeViewer.ts +74 -0
  110. package/src/simple/datalake/index.ts +2 -0
  111. package/src/simple/gateway/SimpleXyoGateway.ts +21 -0
  112. package/src/simple/gateway/SimpleXyoGatewayRunner.ts +116 -0
  113. package/src/simple/gateway/index.ts +2 -0
  114. package/src/simple/index.ts +7 -0
  115. package/src/simple/network/SimpleXyoNetwork.ts +48 -0
  116. package/src/simple/network/index.ts +1 -0
  117. package/src/simple/network/lib/FailedNetworkStatusPayloads.ts +14 -0
  118. package/src/simple/network/lib/StatusNetworks.ts +27 -0
  119. package/src/simple/network/lib/index.ts +2 -0
  120. package/src/simple/network/spec/XyoNetwork.spec.ts +77 -0
  121. package/src/simple/permissions/SimpleXyoPermissions.ts +82 -0
  122. package/src/simple/permissions/index.ts +2 -0
  123. package/src/simple/permissions/spec/SimpleXyoPermissions.spec.ts +93 -0
  124. package/src/simple/permissions/store/MemoryPermissions.ts +32 -0
  125. package/src/simple/permissions/store/PermissionsStore.ts +15 -0
  126. package/src/simple/permissions/store/index.ts +2 -0
  127. package/src/simple/runner/SimpleXyoRunner.ts +29 -0
  128. package/src/simple/runner/index.ts +1 -0
  129. package/src/simple/signer/SimpleXyoSigner.ts +52 -0
  130. package/src/simple/signer/index.ts +1 -0
  131. package/dist/neutral/provider/XyoGatewayHelpers.d.ts +0 -16
  132. package/dist/neutral/provider/XyoGatewayHelpers.d.ts.map +0 -1
  133. package/dist/neutral/provider/XyoSigner.d.ts.map +0 -1
  134. package/src/provider/XyoGatewayHelpers.ts +0 -30
@@ -0,0 +1,116 @@
1
+ import { assertEx } from '@xylabs/assert'
2
+ import type {
3
+ Address, Hash, Hex,
4
+ } from '@xylabs/hex'
5
+ import { BigIntToJsonZod } from '@xylabs/hex'
6
+ import { isDefined } from '@xylabs/typeof'
7
+ import { PayloadBuilder } from '@xyo-network/payload-builder'
8
+ import type { Payload, WithHashMeta } from '@xyo-network/payload-model'
9
+ import {
10
+ type AllowedBlockPayload,
11
+ type AttoXL1,
12
+ type SignedHydratedTransaction,
13
+ type SignedHydratedTransactionWithHashMeta,
14
+ type Transfer,
15
+ TransferSchema,
16
+ } from '@xyo-network/xl1-protocol'
17
+
18
+ import type {
19
+ DataLakeRunner,
20
+ TransactionOptions,
21
+ XyoConnection, XyoGateway, XyoGatewayRunner,
22
+ XyoSigner,
23
+ } from '../../provider/index.ts'
24
+ import { buildUnsignedTransaction } from '../../transaction/index.ts'
25
+
26
+ export class SimpleXyoGatewayRunner implements XyoGatewayRunner {
27
+ protected readonly gateway: XyoGateway
28
+ private _dataLakes: (DataLakeRunner | null)[]
29
+
30
+ constructor(gateway: XyoGateway, dataLakes: DataLakeRunner[] = []) {
31
+ this.gateway = gateway
32
+ this._dataLakes = [...dataLakes]
33
+ }
34
+
35
+ get connection(): XyoConnection {
36
+ return this.gateway.connection
37
+ }
38
+
39
+ get dataLakes(): DataLakeRunner[] {
40
+ throw new Error('Method not implemented.')
41
+ }
42
+
43
+ get signer(): XyoSigner {
44
+ return this.gateway.signer
45
+ }
46
+
47
+ addDataLake(dataLake: DataLakeRunner): number {
48
+ this._dataLakes.push(dataLake)
49
+ return this._dataLakes.length - 1
50
+ }
51
+
52
+ async addPayloadsToChain(
53
+ onChain: AllowedBlockPayload[],
54
+ offChain: Payload[],
55
+ options?: TransactionOptions,
56
+ ): Promise<[Hash, SignedHydratedTransactionWithHashMeta]> {
57
+ // Get chain providers
58
+ const viewer = assertEx(this.connection.viewer, () => 'No viewer available on connection')
59
+
60
+ // Resolve transaction options
61
+ const {
62
+ nbf, exp, chain, fees,
63
+ } = options ?? {}
64
+ const resolvedChainId = isDefined(chain) ? chain : await viewer.chainId()
65
+ const resolvedNbf = isDefined(nbf) ? nbf : await viewer?.currentBlockNumber()
66
+ const resolvedExp = isDefined(exp) ? exp : resolvedNbf + 10
67
+
68
+ // Build, sign, and broadcast the transaction
69
+ const tx = await buildUnsignedTransaction(resolvedChainId, onChain, offChain, resolvedNbf, resolvedExp, await this.signer.address(), fees)
70
+ return await this.addTransactionToChain(tx)
71
+ }
72
+
73
+ async addTransactionToChain(tx: SignedHydratedTransaction): Promise<[Hash, SignedHydratedTransactionWithHashMeta]> {
74
+ const connection = this.gateway.connection
75
+ const signer = this.gateway.signer
76
+ const runner = assertEx(connection.runner, () => 'No runner available on connection')
77
+ const signedTx = await signer.signTransaction(tx)
78
+ await this.addPayloadsToDataLakes(signedTx[1])
79
+ return [await runner.broadcastTransaction(
80
+ [await PayloadBuilder.addStorageMeta(signedTx[0]),
81
+ await PayloadBuilder.addStorageMeta(signedTx[1])],
82
+ ), signedTx]
83
+ }
84
+
85
+ removeDataLake(index: number): void {
86
+ this._dataLakes[index] = null
87
+ }
88
+
89
+ async send(to: Address, amount: AttoXL1, options?: TransactionOptions): Promise<Hash> {
90
+ return await this.sendMany({ [to]: amount }, options)
91
+ }
92
+
93
+ async sendMany(transfers: Record<Address, AttoXL1>, options?: TransactionOptions): Promise<Hash> {
94
+ const from = await this.signer.address()
95
+ const hexTransfers: Record<Address, Hex> = Object.fromEntries(
96
+ Object.entries(transfers).map(([address, amount]) => ([
97
+ address, BigIntToJsonZod.parse(amount),
98
+ ])),
99
+ )
100
+ const transfer = new PayloadBuilder<Transfer>({ schema: TransferSchema }).fields({
101
+ from,
102
+ transfers: hexTransfers,
103
+ epoch: Date.now(),
104
+ }).build()
105
+ const [hash] = await this.addPayloadsToChain([transfer], [], options)
106
+ return hash
107
+ }
108
+
109
+ protected async addPayloadsToDataLakes(payloads: WithHashMeta<Payload>[]): Promise<void> {
110
+ await Promise.all(this._dataLakes.map(async (dataLake) => {
111
+ await Promise.all(payloads.map(async (payload) => {
112
+ await dataLake?.set(payload._hash, payload)
113
+ }))
114
+ }))
115
+ }
116
+ }
@@ -0,0 +1,2 @@
1
+ export * from './SimpleXyoGateway.ts'
2
+ export * from './SimpleXyoGatewayRunner.ts'
@@ -0,0 +1,7 @@
1
+ export * from './client/index.ts'
2
+ export * from './datalake/index.ts'
3
+ export * from './gateway/index.ts'
4
+ export * from './network/index.ts'
5
+ export * from './permissions/index.ts'
6
+ export * from './runner/index.ts'
7
+ export * from './signer/index.ts'
@@ -0,0 +1,48 @@
1
+ import { isUndefined } from '@xylabs/typeof'
2
+ import type {
3
+ GatewayName,
4
+ NetworkStatus,
5
+ } from '@xyo-network/xl1-protocol'
6
+ import { isNetworkStatus } from '@xyo-network/xl1-protocol'
7
+ import axios from 'axios'
8
+
9
+ import type { XyoNetwork } from '../../provider/index.ts'
10
+ import {
11
+ errorStatus, StatusNetworks, unknownStatus,
12
+ } from './lib/index.ts'
13
+
14
+ export class SimpleXyoNetwork implements XyoNetwork {
15
+ protected readonly _networkId: GatewayName
16
+
17
+ constructor(networkId: GatewayName) {
18
+ this._networkId = networkId
19
+ }
20
+
21
+ async status(): Promise<NetworkStatus> {
22
+ const statusNetwork = StatusNetworks[this._networkId]
23
+ if (isUndefined(statusNetwork)) {
24
+ throw new Error(`Unknown status network ID: ${this._networkId}`)
25
+ }
26
+
27
+ return await this.makeRequest(statusNetwork.statusUrl)
28
+ }
29
+
30
+ private async makeRequest(url: string): Promise<NetworkStatus> {
31
+ try {
32
+ const response = await axios.get(url)
33
+ if (isNetworkStatus(response.data)) {
34
+ return response.data
35
+ } else {
36
+ if (response.status === 200) {
37
+ console.error('Unknown network status response:', response.data)
38
+
39
+ return unknownStatus
40
+ }
41
+ return errorStatus
42
+ }
43
+ } catch (error) {
44
+ console.error('Error fetching network status:', error)
45
+ return errorStatus
46
+ }
47
+ }
48
+ }
@@ -0,0 +1 @@
1
+ export * from './SimpleXyoNetwork.ts'
@@ -0,0 +1,14 @@
1
+ import type { NetworkStatus } from '@xyo-network/xl1-protocol'
2
+ import { NetworkStatusSchema } from '@xyo-network/xl1-protocol'
3
+
4
+ export const unknownStatus: NetworkStatus = {
5
+ description: 'Unknown Network Status',
6
+ schema: NetworkStatusSchema,
7
+ state: 'unknown',
8
+ }
9
+
10
+ export const errorStatus: NetworkStatus = {
11
+ description: 'Error Fetching Network Status',
12
+ schema: NetworkStatusSchema,
13
+ state: 'unknown',
14
+ }
@@ -0,0 +1,27 @@
1
+ import type { GatewayName } from '@xyo-network/xl1-protocol'
2
+
3
+ export type StatusNetwork = {
4
+ id: GatewayName
5
+ statusUrl: string
6
+ }
7
+
8
+ export const MainNetworkStats: StatusNetwork = {
9
+ id: 'mainnet' as GatewayName,
10
+ statusUrl: 'https://xyo.network/chain-network-status-mainnet.json',
11
+ }
12
+
13
+ export const SequenceNetworkStats: StatusNetwork = {
14
+ id: 'sequence' as GatewayName,
15
+ statusUrl: 'https://beta.xyo.network/chain-network-status-sequence.json',
16
+ }
17
+
18
+ export const LocalNetworkStats: StatusNetwork = {
19
+ id: 'local' as GatewayName,
20
+ statusUrl: 'http://localhost:3002/chain-network-status-local.json',
21
+ }
22
+
23
+ export const StatusNetworks: Record<GatewayName, StatusNetwork> = {
24
+ ['mainnet' as GatewayName]: MainNetworkStats,
25
+ ['sequence' as GatewayName]: SequenceNetworkStats,
26
+ ['local' as GatewayName]: LocalNetworkStats,
27
+ }
@@ -0,0 +1,2 @@
1
+ export * from './FailedNetworkStatusPayloads.ts'
2
+ export * from './StatusNetworks.ts'
@@ -0,0 +1,77 @@
1
+ import type { NetworkId } from '@xyo-network/xl1-protocol'
2
+ import { NetworkStatusSchema } from '@xyo-network/xl1-protocol'
3
+ import axios from 'axios'
4
+ import type { Mocked } from 'vitest'
5
+ import {
6
+ beforeEach, describe, expect, it, vitest,
7
+ } from 'vitest'
8
+
9
+ import {
10
+ errorStatus, StatusNetworks, unknownStatus,
11
+ } from '../lib/index.ts'
12
+ import { SimpleXyoNetwork } from '../SimpleXyoNetwork.ts'
13
+
14
+ vitest.mock('axios')
15
+ const mockedAxios = axios as Mocked<typeof axios>
16
+
17
+ describe('SimpleXyoNetwork', () => {
18
+ const mockNetworkStatus = {
19
+ description: 'Mock Network Status',
20
+ schema: NetworkStatusSchema,
21
+ state: 'active',
22
+ }
23
+
24
+ const networks = Object.values(StatusNetworks)
25
+
26
+ beforeEach(() => {
27
+ vitest.clearAllMocks()
28
+ })
29
+
30
+ for (const { id, statusUrl } of networks) {
31
+ it(`should fetch the ${id} status successfully`, async () => {
32
+ mockedAxios.get.mockResolvedValueOnce({ data: mockNetworkStatus })
33
+
34
+ const network = new SimpleXyoNetwork(id)
35
+ const status = await network.status()
36
+
37
+ expect(mockedAxios.get).toHaveBeenCalledWith(statusUrl)
38
+ expect(status).toEqual(mockNetworkStatus)
39
+ })
40
+
41
+ it(`should return unknownStatus for invalid response data on ${id}`, async () => {
42
+ mockedAxios.get.mockResolvedValueOnce({ data: { invalid: 'data' }, status: 200 })
43
+
44
+ const network = new SimpleXyoNetwork(id)
45
+ const status = await network.status()
46
+
47
+ expect(mockedAxios.get).toHaveBeenCalledWith(statusUrl)
48
+ expect(status).toEqual(unknownStatus)
49
+ })
50
+
51
+ it(`should return errorStatus for non-200 response on ${id}`, async () => {
52
+ mockedAxios.get.mockResolvedValueOnce({ data: {}, status: 500 })
53
+
54
+ const network = new SimpleXyoNetwork(id)
55
+ const status = await network.status()
56
+
57
+ expect(mockedAxios.get).toHaveBeenCalledWith(statusUrl)
58
+ expect(status).toEqual(errorStatus)
59
+ })
60
+
61
+ it(`should return errorStatus for network errors on ${id}`, async () => {
62
+ mockedAxios.get.mockRejectedValueOnce(new Error('Network error'))
63
+
64
+ const network = new SimpleXyoNetwork(id)
65
+ const status = await network.status()
66
+
67
+ expect(mockedAxios.get).toHaveBeenCalledWith(statusUrl)
68
+ expect(status).toEqual(errorStatus)
69
+ })
70
+ }
71
+
72
+ it('should throw an error for unknown network ID', async () => {
73
+ const network = new SimpleXyoNetwork('invalid' as unknown as NetworkId)
74
+
75
+ await expect(network.status()).rejects.toThrow('Unknown status network ID: invalid')
76
+ })
77
+ })
@@ -0,0 +1,82 @@
1
+ import { assertEx } from '@xylabs/assert'
2
+
3
+ import type {
4
+ CaveatTypes,
5
+ InvokerPermission, PermissionRequest, RequestedPermission, XyoPermissions,
6
+ } from '../../provider/index.ts'
7
+ import type { Invoker, PermissionsStore } from './store/index.ts'
8
+
9
+ /**
10
+ * In-memory implementation of XyoPermissions for testing or ephemeral use cases.
11
+ * Does not persist data beyond the lifetime of the instance.
12
+ * Assumes all permission requests are granted and revocations always succeed.
13
+ */
14
+ export class SimpleXyoPermissions implements XyoPermissions {
15
+ invoker: Invoker
16
+ private _store: PermissionsStore
17
+
18
+ constructor(store: PermissionsStore) {
19
+ this._store = store
20
+ this.invoker = store.invoker
21
+ }
22
+
23
+ get store(): PermissionsStore {
24
+ return assertEx(this._store, () => 'Store must be defined to get permissions')
25
+ }
26
+
27
+ async getPermissions(): Promise<InvokerPermission[]> {
28
+ return await this.store.getPermissions()
29
+ }
30
+
31
+ // assumed the permissions are always granted
32
+ async requestPermissions(permissions: PermissionRequest[]): Promise<RequestedPermission[]> {
33
+ await Promise.resolve()
34
+ // Flatten PermissionRequest[] into InvokerPermission[]
35
+ const newPermissions: InvokerPermission[] = []
36
+ const now = Date.now()
37
+ for (const req of permissions) {
38
+ for (const parentCapability in req) {
39
+ newPermissions.push({
40
+ invoker: this.invoker,
41
+ parentCapability,
42
+ caveats: Object.entries(req[parentCapability]).map(([type, value]) => ({ type: type as CaveatTypes, value })),
43
+ date: now,
44
+ })
45
+ }
46
+ }
47
+
48
+ // Update or add permissions in the store
49
+ const existingPermissions = await this.getPermissions()
50
+ for (const perm of newPermissions) {
51
+ const idx = existingPermissions.findIndex(
52
+ p => p.invoker === perm.invoker && p.parentCapability === perm.parentCapability,
53
+ )
54
+ if (idx === -1) {
55
+ existingPermissions.push(perm)
56
+ } else {
57
+ existingPermissions[idx] = perm
58
+ }
59
+ }
60
+ await this.store.setPermissions(existingPermissions)
61
+
62
+ // Return the granted permissions in RequestedPermission shape
63
+ return newPermissions.map(({ parentCapability, date }) => ({ parentCapability, date }))
64
+ }
65
+
66
+ // Assumes the permissions are always revoked
67
+ async revokePermissions(permissions: PermissionRequest): Promise<RequestedPermission[]> {
68
+ const existingPermissions = await this.getPermissions()
69
+ const revoked: RequestedPermission[] = []
70
+ for (const parentCapability in permissions) {
71
+ const idx = existingPermissions.findIndex(
72
+ p => p.invoker === this.invoker && p.parentCapability === parentCapability,
73
+ )
74
+ if (idx !== -1) {
75
+ const removed = existingPermissions.splice(idx, 1)[0]
76
+ revoked.push({ parentCapability: removed.parentCapability, date: removed.date })
77
+ }
78
+ }
79
+ await this.store.setPermissions(existingPermissions)
80
+ return revoked
81
+ }
82
+ }
@@ -0,0 +1,2 @@
1
+ export * from './SimpleXyoPermissions.ts'
2
+ export * from './store/index.ts'
@@ -0,0 +1,93 @@
1
+ import {
2
+ beforeEach, describe, expect, it,
3
+ } from 'vitest'
4
+
5
+ import type { PermissionRequest } from '../../../provider/index.ts'
6
+ import { SimpleXyoPermissions } from '../SimpleXyoPermissions.ts'
7
+ import { MemoryPermissionsStore } from '../store/index.ts'
8
+
9
+ describe('MemoryXyoPermissions', () => {
10
+ const invoker = 'https://example.com'
11
+ const parentCapability = 'xyoViewer_chainId'
12
+ let memoryPermissions: SimpleXyoPermissions
13
+
14
+ // Helper to build PermissionRequest
15
+ const buildPermissionRequest = (cap: string, caveats: Record<string, unknown> = {}) =>
16
+ ({ [cap]: caveats }) as PermissionRequest
17
+
18
+ beforeEach(() => {
19
+ memoryPermissions = new SimpleXyoPermissions(new MemoryPermissionsStore(invoker))
20
+ })
21
+
22
+ it('returns an empty list initially', async () => {
23
+ const permissions = await memoryPermissions.getPermissions()
24
+ expect(permissions).toEqual([])
25
+ })
26
+
27
+ it('adds and retrieves a permission', async () => {
28
+ const req = buildPermissionRequest(parentCapability)
29
+ const result = await memoryPermissions.requestPermissions([req])
30
+ expect(Array.isArray(result)).toBe(true)
31
+ expect(result.length).toBe(1)
32
+ expect(result[0].parentCapability).toBe(parentCapability)
33
+ expect(typeof result[0].date).toBe('number')
34
+
35
+ const permissions = await memoryPermissions.getPermissions()
36
+ expect(permissions.length).toBe(1)
37
+ expect(permissions[0].parentCapability).toBe(parentCapability)
38
+ expect(permissions[0].invoker).toBe(invoker)
39
+ expect(typeof permissions[0].date).toBe('number')
40
+ })
41
+
42
+ it('replaces an existing permission with the same key', async () => {
43
+ const req = buildPermissionRequest(parentCapability)
44
+ await memoryPermissions.requestPermissions([req])
45
+ const originalDate = (await memoryPermissions.getPermissions())[0].date
46
+
47
+ await new Promise(r => setTimeout(r, 5)) // ensure timestamp difference
48
+ await memoryPermissions.requestPermissions([req])
49
+ const updatedDate = (await memoryPermissions.getPermissions())[0].date
50
+
51
+ expect(updatedDate).toBeGreaterThan(originalDate!)
52
+ })
53
+
54
+ it('revokes a previously granted permission', async () => {
55
+ const req = buildPermissionRequest(parentCapability)
56
+ await memoryPermissions.requestPermissions([req])
57
+ expect((await memoryPermissions.getPermissions()).length).toBe(1)
58
+
59
+ const result = await memoryPermissions.revokePermissions(req)
60
+ expect(Array.isArray(result)).toBe(true)
61
+ expect(result.length).toBe(1)
62
+ expect(result[0].parentCapability).toBe(parentCapability)
63
+
64
+ const permissions = await memoryPermissions.getPermissions()
65
+ expect(permissions).toEqual([])
66
+ })
67
+
68
+ it('revoking a non-existent permission does nothing and returns empty array', async () => {
69
+ const req = buildPermissionRequest(parentCapability)
70
+ const result = await memoryPermissions.revokePermissions(req)
71
+ expect(result).toEqual([])
72
+ expect(await memoryPermissions.getPermissions()).toEqual([])
73
+ })
74
+
75
+ it('can handle multiple permissions from different invokers', async () => {
76
+ const memoryPermissionsA = new SimpleXyoPermissions(new MemoryPermissionsStore('https://a.com'))
77
+ const memoryPermissionsB = new SimpleXyoPermissions(new MemoryPermissionsStore('https://b.com'))
78
+ const reqA1 = buildPermissionRequest('xyo_1')
79
+ const reqA2 = buildPermissionRequest('xyo_3')
80
+ const reqB = buildPermissionRequest('xyo_2')
81
+
82
+ await memoryPermissionsA.requestPermissions([reqA1, reqA2])
83
+ await memoryPermissionsB.requestPermissions([reqB])
84
+
85
+ const resultsA = await memoryPermissionsA.getPermissions()
86
+ const resultsB = await memoryPermissionsB.getPermissions()
87
+
88
+ expect(resultsA.length).toBe(2)
89
+ expect(resultsB.length).toBe(1)
90
+ expect(resultsA.map(p => p.parentCapability).toSorted((a, b) => a.localeCompare(b))).toEqual(['xyo_1', 'xyo_3'])
91
+ expect(resultsB[0].parentCapability).toBe('xyo_2')
92
+ })
93
+ })
@@ -0,0 +1,32 @@
1
+ import { assertEx } from '@xylabs/assert'
2
+
3
+ import type { InvokerPermission } from '../../../provider/index.ts'
4
+ import type { Invoker, PermissionsStore } from './PermissionsStore.ts'
5
+
6
+ /**
7
+ * In-memory implementation of XyoPermissions for testing or ephemeral use cases.
8
+ * Does not persist data beyond the lifetime of the instance.
9
+ * Assumes all permission requests are granted and revocations always succeed.
10
+ */
11
+ export class MemoryPermissionsStore implements PermissionsStore {
12
+ private _invoker: Invoker
13
+ private permissions: InvokerPermission[] = []
14
+
15
+ constructor(invoker: Invoker) {
16
+ this._invoker = invoker
17
+ }
18
+
19
+ get invoker(): Invoker {
20
+ return assertEx(this._invoker, () => 'Invoker must be defined to get permissions')
21
+ }
22
+
23
+ async getPermissions(): Promise<InvokerPermission[]> {
24
+ await Promise.resolve()
25
+ return this.permissions
26
+ }
27
+
28
+ async setPermissions(permissions: InvokerPermission[]): Promise<void> {
29
+ await Promise.resolve()
30
+ this.permissions = permissions
31
+ }
32
+ }
@@ -0,0 +1,15 @@
1
+ import type { InvokerPermission, PermissionsGetHandler } from '../../../provider/index.ts'
2
+
3
+ export type Invoker = string
4
+ export type ParentCapability = string
5
+ /**
6
+ * Interface for a permissions store that abstracts away the storage medium.
7
+ * (i.e. in-memory, browser storage, database, etc.)
8
+ */
9
+ export interface PermissionsStore extends PermissionsGetHandler {
10
+ // The invoker associated with this permissions store
11
+ readonly invoker: Invoker
12
+ // Retrieve all permissions associated with the invoker.
13
+ // Store or update permissions for the invoker
14
+ setPermissions(permissions: InvokerPermission[]): Promise<void>
15
+ }
@@ -0,0 +1,2 @@
1
+ export * from './MemoryPermissions.ts'
2
+ export * from './PermissionsStore.ts'
@@ -0,0 +1,29 @@
1
+ import type { Hash } from '@xylabs/hex'
2
+ import { MemoryArchivist } from '@xyo-network/archivist-memory'
3
+ import type { ArchivistInstance } from '@xyo-network/archivist-model'
4
+ import { PayloadBuilder } from '@xyo-network/payload-builder'
5
+ import type { SignedHydratedTransactionWithStorageMeta } from '@xyo-network/xl1-protocol'
6
+
7
+ import type { XyoRunner } from '../../provider/index.ts'
8
+ import { flattenHydratedTransaction } from '../../transaction/index.ts'
9
+
10
+ export class SimpleXyoRunner implements XyoRunner {
11
+ private _mempoolArchivist?: ArchivistInstance
12
+
13
+ constructor(mempoolArchivist?: ArchivistInstance) {
14
+ this._mempoolArchivist = mempoolArchivist
15
+ }
16
+
17
+ async broadcastTransaction(transaction: SignedHydratedTransactionWithStorageMeta): Promise<Hash> {
18
+ const archivist = await this.getMempoolArchivist()
19
+ await archivist.insert(flattenHydratedTransaction(transaction))
20
+ return await PayloadBuilder.hash(transaction[0])
21
+ }
22
+
23
+ protected async getMempoolArchivist(): Promise<ArchivistInstance> {
24
+ if (!this._mempoolArchivist) {
25
+ this._mempoolArchivist = await MemoryArchivist.create({ account: 'random' })
26
+ }
27
+ return this._mempoolArchivist
28
+ }
29
+ }
@@ -0,0 +1 @@
1
+ export * from './SimpleXyoRunner.ts'
@@ -0,0 +1,52 @@
1
+ import type { Address } from '@xylabs/hex'
2
+ import type { Promisable } from '@xylabs/promise'
3
+ import type { AccountInstance } from '@xyo-network/account-model'
4
+ import type { Signed, UnsignedBoundWitness } from '@xyo-network/boundwitness-model'
5
+ import { PayloadBuilder } from '@xyo-network/payload-builder'
6
+ import { type Payload } from '@xyo-network/payload-model'
7
+ import type {
8
+ AllowedBlockPayload, ChainId, SignedHydratedTransactionWithHashMeta, TransactionBoundWitness, TransactionFeesBigInt,
9
+ } from '@xyo-network/xl1-protocol'
10
+
11
+ import type { XyoSigner } from '../../provider/index.ts'
12
+ import { buildTransaction, signTransaction } from '../../transaction/index.ts'
13
+
14
+ export class SimpleXyoSigner implements XyoSigner {
15
+ protected readonly _account: AccountInstance
16
+
17
+ constructor(account: AccountInstance) {
18
+ this._account = account
19
+ }
20
+
21
+ address(): Promisable<Address> {
22
+ return this._account.address
23
+ }
24
+
25
+ async createSignedTransaction(
26
+ chain: ChainId,
27
+ elevatedPayloads: AllowedBlockPayload[],
28
+ additionalPayloads: Payload[],
29
+ nbf: number,
30
+ exp: number,
31
+ fees: TransactionFeesBigInt,
32
+ from?: Address,
33
+ ): Promise<Signed<TransactionBoundWitness>> {
34
+ const fromAddress = from ?? this._account.address
35
+ const transaction = await buildTransaction(
36
+ chain,
37
+ elevatedPayloads,
38
+ additionalPayloads,
39
+ this._account,
40
+ nbf,
41
+ exp,
42
+ fromAddress,
43
+ fees,
44
+ )
45
+ return transaction[0]
46
+ }
47
+
48
+ async signTransaction(tx: [UnsignedBoundWitness<TransactionBoundWitness>, Payload[]]): Promise<SignedHydratedTransactionWithHashMeta> {
49
+ const txBW = await signTransaction(tx[0], this._account)
50
+ return [await PayloadBuilder.addStorageMeta(txBW), await PayloadBuilder.addStorageMeta(tx[1])]
51
+ }
52
+ }
@@ -0,0 +1 @@
1
+ export * from './SimpleXyoSigner.ts'
@@ -1,16 +0,0 @@
1
- import type { Address, Hash, Hex } from '@xylabs/hex';
2
- import type { Promisable } from '@xylabs/promise';
3
- import type { Payload } from '@xyo-network/payload-model';
4
- import type { AllowedBlockPayload, TransactionBoundWitness, TransactionFeesBigInt } from '@xyo-network/xl1-protocol';
5
- export interface TransactionOptions {
6
- chain?: Hex;
7
- exp?: number;
8
- fees?: TransactionFeesBigInt;
9
- from?: Address;
10
- nbf?: number;
11
- }
12
- export interface XyoGatewayHelpers {
13
- addPayloadsToChain(onChain: AllowedBlockPayload[], offChain: Payload[], options?: TransactionOptions): Promisable<[Hash, [TransactionBoundWitness, Payload[]]]>;
14
- addTransactionToChain(tx: [TransactionBoundWitness, Payload[]]): Promisable<Hash>;
15
- }
16
- //# sourceMappingURL=XyoGatewayHelpers.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"XyoGatewayHelpers.d.ts","sourceRoot":"","sources":["../../../src/provider/XyoGatewayHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EAAE,IAAI,EAAE,GAAG,EACnB,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,KAAK,EACV,mBAAmB,EAAE,uBAAuB,EAAE,qBAAqB,EACpE,MAAM,2BAA2B,CAAA;AAElC,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,GAAG,CAAA;IACX,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,qBAAqB,CAAA;IAC5B,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,iBAAiB;IAEhC,kBAAkB,CAChB,OAAO,EAAE,mBAAmB,EAAE,EAC9B,QAAQ,EAAE,OAAO,EAAE,EACnB,OAAO,CAAC,EAAE,kBAAkB,GAC3B,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC,uBAAuB,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;IAE3D,qBAAqB,CACnB,EAAE,EAAE,CAAC,uBAAuB,EAAE,OAAO,EAAE,CAAC,GACvC,UAAU,CAAC,IAAI,CAAC,CAAA;CAEpB"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"XyoSigner.d.ts","sourceRoot":"","sources":["../../../src/provider/XyoSigner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAA;AACnF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,KAAK,EACV,mBAAmB,EAAE,OAAO,EAAE,uBAAuB,EACrD,qBAAqB,EACtB,MAAM,2BAA2B,CAAA;AAElC,MAAM,WAAW,SAAS;IACxB,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,CAAA;IAI9B,eAAe,CAAC,EAAE,EAAE,CAAC,oBAAoB,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,MAAM,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;CAC1I;AAED,MAAM,WAAW,mBAAmB;IAClC,8CAA8C;IAC9C,uBAAuB,CACrB,KAAK,EAAE,OAAO,EACd,gBAAgB,EAAE,mBAAmB,EAAE,EACvC,kBAAkB,EAAE,OAAO,EAAE,EAC7B,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,qBAAqB,EAC3B,IAAI,CAAC,EAAE,OAAO,GACb,UAAU,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC,CAAA;CAC/C"}