Skip to main content

Interface: HypercertClientMethods

The methods for the Hypercert client.

Hierarchy

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
NameTypeDescription
claimIdsbigint[]Array of the IDs of the claims to mint fractions for.
unitsbigint[]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.

Defined in

sdk/src/types/client.ts:281


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
NameType
fractionIdsbigint[]
to`0x${string}`
overrides?SupportedOverrides
Returns

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

A Promise that resolves to the transaction hash

Defined in

sdk/src/types/client.ts:215


burnClaimFraction

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

Type declaration

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

Burns a claim fraction.

Parameters
NameTypeDescription
fractionIdbigintThe ID of the claim fraction to burn.
Returns

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

A Promise that resolves to the transaction hash

Defined in

sdk/src/types/client.ts:256


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
NameTypeDescription
allowListAllowlistEntry[]The allowlist for the claim.
metaDataHypercertMetadataThe metadata for the claim.
totalUnitsbigintThe total number of units for the claim.
transferRestrictionTransferRestrictionsThe transfer restriction for the claim.
Returns

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

A Promise that resolves to the transaction hash

Defined in

sdk/src/types/client.ts:229


getDeployments

getDeployments: (chainId: SupportedChainIds) => Partial<Deployment>

Type declaration

▸ (chainId): Partial<Deployment>

Gets the contract addresses and graph urls for the provided chainId

Parameters
NameType
chainIdSupportedChainIds
Returns

Partial<Deployment>

The addresses, graph name and graph url.

Defined in

sdk/src/types/client.ts:173


getTransferRestrictions

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

Type declaration

▸ (fractionId): Promise<TransferRestrictions>

Retrieves the TransferRestrictions for a claim.

Parameters
NameTypeDescription
fractionIdbigintThe ID of the claim to retrieve.
Returns

Promise<TransferRestrictions>

A Promise that resolves to the applicable transfer restrictions.

Defined in

sdk/src/types/client.ts:193


mergeFractionUnits

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

Type declaration

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

Merges multiple claim fractions into a single claim.

Parameters
NameTypeDescription
fractionIdsbigint[]The IDs of the claim fractions to merge.
Returns

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

A Promise that resolves to the transaction hash

Defined in

sdk/src/types/client.ts:249


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
NameTypeDescription
metaDataHypercertMetadataThe metadata for the claim.
totalUnitsbigintThe total number of units for the claim.
transferRestrictionTransferRestrictionsThe transfer restriction for the claim.
Returns

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

A Promise that resolves to the transaction hash

Defined in

sdk/src/types/client.ts:182


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
NameTypeDescription
claimIdbigintThe ID of the claim to mint a fraction for.
unitsbigintThe 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

Defined in

sdk/src/types/client.ts:265


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
NameTypeDescription
fractionIdbigintThe ID of the claim to split.
fractionsbigint[]-
Returns

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

A Promise that resolves to the transaction hash

Defined in

sdk/src/types/client.ts:242


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
NameType
fractionIdbigint
to`0x${string}`
overrides?SupportedOverrides
Returns

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

A Promise that resolves to the transaction hash

Defined in

sdk/src/types/client.ts:202