Interface: HypercertClientInterface

The interface for the Hypercert client.

Hierarchy

• HypercertClientMethods

• HypercertClientState

  ↳ HypercertClientInterface

Implemented by

• HypercertClient

Properties

batchMintClaimFractionsFromAllowlists

• batchMintClaimFractionsFromAllowlists: (claimIds: bigint[], units: bigint[], proofs: (`0x${string}` | Uint8Array)[][]) => Promise<undefined | `0x${string}`>

Type declaration

▸ (claimIds, units, proofs): Promise<undefined | `0x${string}`>

Batch mints a claim fraction from an allowlist

Parameters

Name	Type	Description
claimIds	bigint[]	Array of the IDs of the claims to mint fractions for.
units	bigint[]	Array of the number of units for each fraction.
proofs	(`0x${string}` | Uint8Array)[][]	Array of Merkle proofs for the allowlists.

Returns

Promise<undefined | `0x${string}`>

A Promise that resolves to the transaction receipt

A Promise that resolves to the transaction hash

Note

The length of the arrays must be equal.

Note

The order of the arrays must be equal.

Inherited from

HypercertClientMethods.batchMintClaimFractionsFromAllowlists

Defined in

sdk/src/types/client.ts:237

---

batchTransferFractions

• batchTransferFractions: (fractionIds: bigint[], to: `0x${string}`, overrides?: SupportedOverrides) => Promise<undefined | `0x${string}`>

Type declaration

▸ (fractionIds, to, overrides?): Promise<undefined | `0x${string}`>

Transfers multiple claim fractions to a new owner.

Parameters

Name	Type
fractionIds	bigint[]
to	`0x${string}`
overrides?	SupportedOverrides

Returns

Promise<undefined | `0x${string}`>

A Promise that resolves to the transaction hash

Inherited from

HypercertClientMethods.batchTransferFractions

Defined in

sdk/src/types/client.ts:171

---

burnClaimFraction

• burnClaimFraction: (fractionId: bigint) => Promise<undefined | `0x${string}`>

Type declaration

▸ (fractionId): Promise<undefined | `0x${string}`>

Burns a claim fraction.

Parameters

Name	Type	Description
fractionId	bigint	The ID of the claim fraction to burn.

Returns

Promise<undefined | `0x${string}`>

A Promise that resolves to the transaction hash

Inherited from

HypercertClientMethods.burnClaimFraction

Defined in

sdk/src/types/client.ts:212

---

contract

• contract: GetContractReturnType<({ anonymous?: undefined = false; inputs: never[] = []; name?: undefined = "balanceOf"; outputs?: undefined ; stateMutability: string = "nonpayable"; type: string = "constructor" } | { anonymous?: undefined = false; inputs: never[] = []; name: string = "AlreadyClaimed"; outputs?: undefined ; stateMutability?: undefined = "view"; type: string = "error" } | { anonymous: boolean = false; inputs: { indexed: boolean = false; internalType: string = "address"; name: string = "previousAdmin"; type: string = "address" }[] ; name: string = "AdminChanged"; outputs?: undefined ; stateMutability?: undefined = "view"; type: string = "event" } | { anonymous?: undefined = false; inputs: { internalType: string = "address"; name: string = "account"; type: string = "address" }[] ; name: string = "balanceOf"; outputs: { internalType: string = "uint256"; name: string = ""; type: string = "uint256" }[] ; stateMutability: string = "view"; type: string = "function" })[]>

Inherited from

HypercertClientState.contract

Defined in

sdk/src/types/client.ts:124

---

createAllowlist

• createAllowlist: (allowList: AllowlistEntry[], metaData: HypercertMetadata, totalUnits: bigint, transferRestriction: TransferRestrictions) => Promise<undefined | `0x${string}`>

Type declaration

▸ (allowList, metaData, totalUnits, transferRestriction): Promise<undefined | `0x${string}`>

Creates a new allowlist and mints a new claim with the allowlist.

Parameters

Name	Type	Description
allowList	AllowlistEntry[]	The allowlist for the claim.
metaData	HypercertMetadata	The metadata for the claim.
totalUnits	bigint	The total number of units for the claim.
transferRestriction	TransferRestrictions	The transfer restriction for the claim.

Returns

Promise<undefined | `0x${string}`>

A Promise that resolves to the transaction hash

Inherited from

HypercertClientMethods.createAllowlist

Defined in

sdk/src/types/client.ts:185

---

getTransferRestrictions

• getTransferRestrictions: (fractionId: bigint) => Promise<TransferRestrictions>

Type declaration

▸ (fractionId): Promise<TransferRestrictions>

Retrieves the TransferRestrictions for a claim.

Parameters

Name	Type	Description
fractionId	bigint	The ID of the claim to retrieve.

Returns

Promise<TransferRestrictions>

A Promise that resolves to the applicable transfer restrictions.

Inherited from

HypercertClientMethods.getTransferRestrictions

Defined in

sdk/src/types/client.ts:149

---

indexer

• indexer: HypercertIndexer

The indexer used by the client.

Inherited from

HypercertClientState.indexer

Defined in

sdk/src/types/client.ts:123

---

mergeFractionUnits

• mergeFractionUnits: (fractionIds: bigint[]) => Promise<undefined | `0x${string}`>

Type declaration

▸ (fractionIds): Promise<undefined | `0x${string}`>

Merges multiple claim fractions into a single claim.

Parameters

Name	Type	Description
fractionIds	bigint[]	The IDs of the claim fractions to merge.

Returns

Promise<undefined | `0x${string}`>

A Promise that resolves to the transaction hash

Inherited from

HypercertClientMethods.mergeFractionUnits

Defined in

sdk/src/types/client.ts:205

---

mintClaim

• mintClaim: (metaData: HypercertMetadata, totalUnits: bigint, transferRestriction: TransferRestrictions) => Promise<undefined | `0x${string}`>

Type declaration

▸ (metaData, totalUnits, transferRestriction): Promise<undefined | `0x${string}`>

Mints a new claim.

Parameters

Name	Type	Description
metaData	HypercertMetadata	The metadata for the claim.
totalUnits	bigint	The total number of units for the claim.
transferRestriction	TransferRestrictions	The transfer restriction for the claim.

Returns

Promise<undefined | `0x${string}`>

A Promise that resolves to the transaction hash

Inherited from

HypercertClientMethods.mintClaim

Defined in

sdk/src/types/client.ts:138

---

mintClaimFractionFromAllowlist

• mintClaimFractionFromAllowlist: (claimId: bigint, units: bigint, proof: (`0x${string}` | Uint8Array)[]) => Promise<undefined | `0x${string}`>

Type declaration

▸ (claimId, units, proof): Promise<undefined | `0x${string}`>

Mints a claim fraction from an allowlist.

Parameters

Name	Type	Description
claimId	bigint	The ID of the claim to mint a fraction for.
units	bigint	The number of units for the fraction.
proof	(`0x${string}` | Uint8Array)[]	The Merkle proof for the allowlist.

Returns

Promise<undefined | `0x${string}`>

A Promise that resolves to the transaction hash

Inherited from

HypercertClientMethods.mintClaimFractionFromAllowlist

Defined in

sdk/src/types/client.ts:221

---

readonly

• readonly: boolean

Whether the client is in read-only mode.

Inherited from

HypercertClientState.readonly

Defined in

sdk/src/types/client.ts:119

---

splitFractionUnits

• splitFractionUnits: (fractionId: bigint, fractions: bigint[]) => Promise<undefined | `0x${string}`>

Type declaration

▸ (fractionId, fractions): Promise<undefined | `0x${string}`>

Splits a claim into multiple fractions.

Parameters

Name	Type	Description
fractionId	bigint	The ID of the claim to split.
fractions	bigint[]	-

Returns

Promise<undefined | `0x${string}`>

A Promise that resolves to the transaction hash

Inherited from

HypercertClientMethods.splitFractionUnits

Defined in

sdk/src/types/client.ts:198

---

storage

• storage: HypercertStorageInterface

The storage layer used by the client.

Inherited from

HypercertClientState.storage

Defined in

sdk/src/types/client.ts:121

---

transferFraction

• transferFraction: (fractionId: bigint, to: `0x${string}`, overrides?: SupportedOverrides) => Promise<undefined | `0x${string}`>

Type declaration

▸ (fractionId, to, overrides?): Promise<undefined | `0x${string}`>

Transfers a claim fraction to a new owner.

Parameters

Name	Type
fractionId	bigint
to	`0x${string}`
overrides?	SupportedOverrides

Returns

Promise<undefined | `0x${string}`>

A Promise that resolves to the transaction hash

Inherited from

HypercertClientMethods.transferFraction

Defined in

sdk/src/types/client.ts:158