@meddleware/docs 0.0.1

package/docs/access-gate/api/functions/fetchAccessNftById.md

@@ -0,0 +1,27 @@
+# Function: fetchAccessNftById()
+
+> **fetchAccessNftById**(`client`, `objectId`): `Promise`\<[`OwnedAccessNft`](../interfaces/OwnedAccessNft.md)\>
+
+Defined in: ownership.ts:68
+
+Typed single-object read of one access NFT by id (`getObject` with `showType`+`showContent`),
+used when a UI needs the **exact** `usesRemaining` reliably rather than the best-effort parse
+of an owned-objects page. Returns `null` if the object is missing or not an access NFT.
+
+## Parameters
+
+### client
+
+[`SuiObjectClient`](../interfaces/SuiObjectClient.md)
+
+### objectId
+
+`string`
+
+## Returns
+
+`Promise`\<[`OwnedAccessNft`](../interfaces/OwnedAccessNft.md)\>
+
+## Throws
+
+if the RPC call fails at the network or transport layer.

package/docs/access-gate/api/functions/fetchAccessNfts.md

@@ -0,0 +1,34 @@
+# Function: fetchAccessNfts()
+
+> **fetchAccessNfts**(`client`, `owner`, `nftType`, `gateId?`): `Promise`\<[`OwnedAccessNft`](../interfaces/OwnedAccessNft.md)[]\>
+
+Defined in: ownership.ts:82
+
+Fetch all access NFTs of `nftType` owned by `owner`, optionally restricted to a specific
+`gateId`. Uses `getOwnedObjects` filtered by `StructType` (the standard owned-objects query).
+
+## Parameters
+
+### client
+
+[`OwnedObjectsClient`](../interfaces/OwnedObjectsClient.md)
+
+### owner
+
+`string`
+
+### nftType
+
+`string`
+
+### gateId?
+
+`string`
+
+## Returns
+
+`Promise`\<[`OwnedAccessNft`](../interfaces/OwnedAccessNft.md)[]\>
+
+## Throws
+
+if the RPC call fails at the network or transport layer.

package/docs/access-gate/api/functions/fetchAdminCaps.md

@@ -0,0 +1,30 @@
+# Function: fetchAdminCaps()
+
+> **fetchAdminCaps**(`client`, `owner`, `packageId`): `Promise`\<`object`[]\>
+
+Defined in: ownership.ts:171
+
+List the `{ adminCapId, gateId }` pairs for every `access_gate::AdminCap` owned by `owner`
+under `packageId`. Uses `getOwnedObjects` filtered by `StructType` (the standard query).
+
+## Parameters
+
+### client
+
+[`OwnedObjectsClient`](../interfaces/OwnedObjectsClient.md)
+
+### owner
+
+`string`
+
+### packageId
+
+`string`
+
+## Returns
+
+`Promise`\<`object`[]\>
+
+## Throws
+
+if the underlying RPC call fails.

package/docs/access-gate/api/functions/fetchChallenge.md

@@ -0,0 +1,32 @@
+# Function: fetchChallenge()
+
+> **fetchChallenge**(`gatewayHost`, `opts?`): `Promise`\<[`Challenge`](../interfaces/Challenge.md)\>
+
+Defined in: challenge.ts:10
+
+Fetch a fresh challenge from a gateway's `GET /v1/challenge` endpoint. Tolerates both
+`expiresAt` (camelCase) and `expires_at` (snake_case) response shapes.
+
+## Parameters
+
+### gatewayHost
+
+`string`
+
+### opts?
+
+#### signal?
+
+`AbortSignal`
+
+## Returns
+
+`Promise`\<[`Challenge`](../interfaces/Challenge.md)\>
+
+## Throws
+
+if the network request fails or the gateway returns a non-2xx status.
+
+## Throws
+
+if the response body is missing the required `nonce` field.

package/docs/access-gate/api/functions/fetchGate.md

@@ -0,0 +1,26 @@
+# Function: fetchGate()
+
+> **fetchGate**(`client`, `gateId`): `Promise`\<`Omit`\<[`OwnedGate`](../interfaces/OwnedGate.md), `"adminCapId"`\>\>
+
+Defined in: ownership.ts:192
+
+Typed single-object read of one `Gate` by id, returning its parsed state (without `adminCapId`).
+Returns `null` if the object is missing or not a `Gate`.
+
+## Parameters
+
+### client
+
+[`SuiObjectClient`](../interfaces/SuiObjectClient.md)
+
+### gateId
+
+`string`
+
+## Returns
+
+`Promise`\<`Omit`\<[`OwnedGate`](../interfaces/OwnedGate.md), `"adminCapId"`\>\>
+
+## Throws
+
+if the RPC call fails at the network or transport layer.

package/docs/access-gate/api/functions/fetchOwnedGates.md

@@ -0,0 +1,31 @@
+# Function: fetchOwnedGates()
+
+> **fetchOwnedGates**(`client`, `owner`, `packageId`): `Promise`\<[`OwnedGate`](../interfaces/OwnedGate.md)[]\>
+
+Defined in: ownership.ts:207
+
+Fetch every gate `owner` administers: list their owned `AdminCap`s, then fetch each referenced
+`Gate` shared object and merge in the owning `adminCapId`. Gates whose object can no longer be
+read (e.g. deleted) are skipped.
+
+## Parameters
+
+### client
+
+[`OwnedObjectsClient`](../interfaces/OwnedObjectsClient.md) & [`SuiObjectClient`](../interfaces/SuiObjectClient.md)
+
+### owner
+
+`string`
+
+### packageId
+
+`string`
+
+## Returns
+
+`Promise`\<[`OwnedGate`](../interfaces/OwnedGate.md)[]\>
+
+## Throws
+
+if an underlying RPC call fails at the network or transport layer.

package/docs/access-gate/api/functions/ownsAccessNft.md

@@ -0,0 +1,35 @@
+# Function: ownsAccessNft()
+
+> **ownsAccessNft**(`client`, `owner`, `nftType`, `gateId?`): `Promise`\<`boolean`\>
+
+Defined in: ownership.ts:106
+
+True if `owner` holds at least one access NFT of `nftType` (optionally for `gateId`).
+This is the cheap check a frontend runs to decide whether to show a gated option, and a
+gateway runs (server-side) as part of access verification.
+
+## Parameters
+
+### client
+
+[`OwnedObjectsClient`](../interfaces/OwnedObjectsClient.md)
+
+### owner
+
+`string`
+
+### nftType
+
+`string`
+
+### gateId?
+
+`string`
+
+## Returns
+
+`Promise`\<`boolean`\>
+
+## Throws
+
+if the underlying RPC call fails.

package/docs/access-gate/api/functions/parseAdminCap.md

@@ -0,0 +1,26 @@
+# Function: parseAdminCap()
+
+> **parseAdminCap**(`entry`): `object`
+
+Defined in: ownership.ts:129
+
+Parse a single `getOwnedObjects`/`getObject` entry into `{ adminCapId, gateId }`, or `null` if
+it is not an `AdminCap`. Validates the object **type** when present and reads `fields.gate_id`.
+
+## Parameters
+
+### entry
+
+`any`
+
+## Returns
+
+`object`
+
+### adminCapId
+
+> **adminCapId**: `string`
+
+### gateId
+
+> **gateId**: `string`

package/docs/access-gate/api/functions/parseGate.md

@@ -0,0 +1,19 @@
+# Function: parseGate()
+
+> **parseGate**(`entry`): `Omit`\<[`OwnedGate`](../interfaces/OwnedGate.md), `"adminCapId"`\>
+
+Defined in: ownership.ts:145
+
+Parse a `getObject` entry for a `Gate` shared object into an [OwnedGate](../interfaces/OwnedGate.md) (minus
+`adminCapId`, which comes from the owning cap). Returns `null` if the object is missing its
+expected `Gate` fields.
+
+## Parameters
+
+### entry
+
+`any`
+
+## Returns
+
+`Omit`\<[`OwnedGate`](../interfaces/OwnedGate.md), `"adminCapId"`\>

package/docs/access-gate/api/functions/parseOwnedAccessNft.md

@@ -0,0 +1,19 @@
+# Function: parseOwnedAccessNft()
+
+> **parseOwnedAccessNft**(`entry`): [`OwnedAccessNft`](../interfaces/OwnedAccessNft.md)
+
+Defined in: ownership.ts:44
+
+Parse a single core-API object (a `listOwnedObjects` item or a `getObject`'s `{ object }`) into
+an [OwnedAccessNft](../interfaces/OwnedAccessNft.md), or `null` if it is not an access NFT. Validates the object **type**
+when present (typed), and reads the nested `data` fields deterministically.
+
+## Parameters
+
+### entry
+
+`any`
+
+## Returns
+
+[`OwnedAccessNft`](../interfaces/OwnedAccessNft.md)

package/docs/access-gate/api/functions/personalMessageForNonce.md

@@ -0,0 +1,18 @@
+# Function: personalMessageForNonce()
+
+> **personalMessageForNonce**(`nonce`): `Uint8Array`
+
+Defined in: proof.ts:7
+
+The exact bytes a wallet signs (as a personal message) to answer a challenge. Both the
+client (signing) and the gateway (verifying) MUST derive the message identically.
+
+## Parameters
+
+### nonce
+
+`string`
+
+## Returns
+
+`Uint8Array`

package/docs/access-gate/api/index.md

@@ -0,0 +1,47 @@
+# NFT-gate client API
+
+## Interfaces
+
+- [AccessGateConfig](interfaces/AccessGateConfig.md)
+- [AccessProof](interfaces/AccessProof.md)
+- [Challenge](interfaces/Challenge.md)
+- [GateAdminContext](interfaces/GateAdminContext.md)
+- [OwnedAccessNft](interfaces/OwnedAccessNft.md)
+- [OwnedGate](interfaces/OwnedGate.md)
+- [OwnedObjectsClient](interfaces/OwnedObjectsClient.md)
+- [SuiObjectClient](interfaces/SuiObjectClient.md)
+
+## Type Aliases
+
+- [PersonalMessageSigner](type-aliases/PersonalMessageSigner.md)
+
+## Functions
+
+- [buildAccessProof](functions/buildAccessProof.md)
+- [buildAirdropTx](functions/buildAirdropTx.md)
+- [buildConsumeTx](functions/buildConsumeTx.md)
+- [buildCreateGateTx](functions/buildCreateGateTx.md)
+- [buildMakeGateImmutableTx](functions/buildMakeGateImmutableTx.md)
+- [buildPurchaseTx](functions/buildPurchaseTx.md)
+- [buildSetAutoBurnAtZeroTx](functions/buildSetAutoBurnAtZeroTx.md)
+- [buildSetDefaultUsesTx](functions/buildSetDefaultUsesTx.md)
+- [buildSetNftDescriptionTx](functions/buildSetNftDescriptionTx.md)
+- [buildSetNftImageUrlTx](functions/buildSetNftImageUrlTx.md)
+- [buildSetNftNameTx](functions/buildSetNftNameTx.md)
+- [buildSetPausedTx](functions/buildSetPausedTx.md)
+- [buildSetPaymentRecipientTx](functions/buildSetPaymentRecipientTx.md)
+- [buildSetPriceTx](functions/buildSetPriceTx.md)
+- [buildSetSoulboundTx](functions/buildSetSoulboundTx.md)
+- [decodeAccessProof](functions/decodeAccessProof.md)
+- [encodeAccessProof](functions/encodeAccessProof.md)
+- [fetchAccessNftById](functions/fetchAccessNftById.md)
+- [fetchAccessNfts](functions/fetchAccessNfts.md)
+- [fetchAdminCaps](functions/fetchAdminCaps.md)
+- [fetchChallenge](functions/fetchChallenge.md)
+- [fetchGate](functions/fetchGate.md)
+- [fetchOwnedGates](functions/fetchOwnedGates.md)
+- [ownsAccessNft](functions/ownsAccessNft.md)
+- [parseAdminCap](functions/parseAdminCap.md)
+- [parseGate](functions/parseGate.md)
+- [parseOwnedAccessNft](functions/parseOwnedAccessNft.md)
+- [personalMessageForNonce](functions/personalMessageForNonce.md)

package/docs/access-gate/api/interfaces/AccessGateConfig.md

@@ -0,0 +1,57 @@
+# Interface: AccessGateConfig
+
+Defined in: types.ts:9
+
+Identifies a deployed gate and the NFT type that satisfies it.
+
+## Properties
+
+### gateId
+
+> **gateId**: `string`
+
+Defined in: types.ts:13
+
+The shared `Gate` object ID.
+
+***
+
+### nftType
+
+> **nftType**: `string`
+
+Defined in: types.ts:21
+
+Fully-qualified NFT type string to filter ownership by, e.g.
+`<pkg>::access_gate::AccessNFT` or `<pkg>::access_gate::SoulboundAccessNFT`.
+Choose the variant matching the gate's `soulbound` flag.
+
+***
+
+### packageId
+
+> **packageId**: `string`
+
+Defined in: types.ts:11
+
+Published `access_gate` package ID.
+
+***
+
+### platformConfigId
+
+> **platformConfigId**: `string`
+
+Defined in: types.ts:15
+
+The shared `PlatformConfig` object ID. Required for `buildPurchaseTx`.
+
+***
+
+### soulbound?
+
+> `optional` **soulbound?**: `boolean`
+
+Defined in: types.ts:23
+
+Whether this gate mints soulbound NFTs (selects `consume` vs `consume_soulbound`).

package/docs/access-gate/api/interfaces/AccessProof.md

@@ -0,0 +1,46 @@
+# Interface: AccessProof
+
+Defined in: types.ts:77
+
+The proof a client presents to a gateway to demonstrate gated access.
+
+## Properties
+
+### address
+
+> **address**: `string`
+
+Defined in: types.ts:79
+
+The Sui address claimed by the caller.
+
+***
+
+### consumeDigest?
+
+> `optional` **consumeDigest?**: `string`
+
+Defined in: types.ts:88
+
+For single-use gates: the digest of the on-chain `consume(nft, nonce)` transaction, so
+the gateway can confirm the matching `AccessConsumedEvent` before allowing the request.
+
+***
+
+### nonce
+
+> **nonce**: `string`
+
+Defined in: types.ts:81
+
+The challenge nonce that was signed.
+
+***
+
+### signature
+
+> **signature**: `string`
+
+Defined in: types.ts:83
+
+Base64 personal-message signature over [personalMessageForNonce](../functions/personalMessageForNonce.md).

package/docs/access-gate/api/interfaces/Challenge.md

@@ -0,0 +1,25 @@
+# Interface: Challenge
+
+Defined in: types.ts:69
+
+A server-issued, time-bound challenge the wallet signs to prove control of an address.
+
+## Properties
+
+### expiresAt
+
+> **expiresAt**: `number`
+
+Defined in: types.ts:73
+
+Unix epoch milliseconds after which the challenge is rejected.
+
+***
+
+### nonce
+
+> **nonce**: `string`
+
+Defined in: types.ts:71
+
+Opaque nonce (as issued by the gateway; treated as a UTF-8 string end-to-end).

package/docs/access-gate/api/interfaces/GateAdminContext.md

@@ -0,0 +1,37 @@
+# Interface: GateAdminContext
+
+Defined in: types.ts:31
+
+Identifies a gate an operator administers, for the AdminCap-gated management PTB builders
+(setters, airdrop, freeze). The three ids together authorise a call: `adminCapId` must be the
+`AdminCap` whose `gate_id` matches `gateId`, under the published `packageId`.
+
+## Properties
+
+### adminCapId
+
+> **adminCapId**: `string`
+
+Defined in: types.ts:37
+
+The `AdminCap` object ID authorised over `gateId` (held by the operator).
+
+***
+
+### gateId
+
+> **gateId**: `string`
+
+Defined in: types.ts:35
+
+The shared `Gate` object ID being administered.
+
+***
+
+### packageId
+
+> **packageId**: `string`
+
+Defined in: types.ts:33
+
+Published `access_gate` package ID.

package/docs/access-gate/api/interfaces/OwnedAccessNft.md

@@ -0,0 +1,31 @@
+# Interface: OwnedAccessNft
+
+Defined in: types.ts:92
+
+A parsed owned access NFT.
+
+## Properties
+
+### gateId
+
+> **gateId**: `string`
+
+Defined in: types.ts:94
+
+***
+
+### objectId
+
+> **objectId**: `string`
+
+Defined in: types.ts:93
+
+***
+
+### usesRemaining
+
+> **usesRemaining**: `number`
+
+Defined in: types.ts:96
+
+`null` for an unlimited pass; otherwise remaining single-use count.

package/docs/access-gate/api/interfaces/OwnedGate.md

@@ -0,0 +1,125 @@
+# Interface: OwnedGate
+
+Defined in: types.ts:41
+
+A gate an operator administers, parsed from its on-chain `Gate` object + owning `AdminCap`.
+
+## Properties
+
+### adminCapId
+
+> **adminCapId**: `string`
+
+Defined in: types.ts:45
+
+The `AdminCap` object ID that authorises administering this gate.
+
+***
+
+### autoBurnAtZero
+
+> **autoBurnAtZero**: `boolean`
+
+Defined in: types.ts:55
+
+Whether a single-use NFT is deleted (vs. kept as a receipt) at zero uses.
+
+***
+
+### defaultUses
+
+> **defaultUses**: `bigint`
+
+Defined in: types.ts:51
+
+0 ⇒ unlimited passes; N ⇒ single-use NFTs with N uses.
+
+***
+
+### frozen
+
+> **frozen**: `boolean`
+
+Defined in: types.ts:59
+
+Whether the gate has been made immutable (all admin/airdrop permanently disabled).
+
+***
+
+### gateId
+
+> **gateId**: `string`
+
+Defined in: types.ts:43
+
+The shared `Gate` object ID.
+
+***
+
+### nftDescription
+
+> **nftDescription**: `string`
+
+Defined in: types.ts:65
+
+Default NFT description minted into future NFTs.
+
+***
+
+### nftImageUrl
+
+> **nftImageUrl**: `string`
+
+Defined in: types.ts:63
+
+Default NFT image URL minted into future NFTs.
+
+***
+
+### nftName
+
+> **nftName**: `string`
+
+Defined in: types.ts:61
+
+Default NFT display name minted into future NFTs.
+
+***
+
+### paused
+
+> **paused**: `boolean`
+
+Defined in: types.ts:57
+
+Whether `purchase` is currently disabled.
+
+***
+
+### paymentRecipient
+
+> **paymentRecipient**: `string`
+
+Defined in: types.ts:49
+
+Address that receives the operator share of each paid `purchase`.
+
+***
+
+### priceMist
+
+> **priceMist**: `bigint`
+
+Defined in: types.ts:47
+
+Price in MIST charged by `purchase` (0 = free).
+
+***
+
+### soulbound
+
+> **soulbound**: `boolean`
+
+Defined in: types.ts:53
+
+Whether newly-minted NFTs are soulbound.