Interface: HypercertClientInterface
The interface for the Hypercert client.
Hierarchy
-
↳
HypercertClientInterface
Implemented by
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
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
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
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
getDeployments
• getDeployments: (chainId: SupportedChainIds) => Partial<Deployment>
Type declaration
▸ (chainId): Partial<Deployment>
Gets the contract addresses and graph urls for the provided chainId
Parameters
| Name | Type |
|---|---|
chainId | SupportedChainIds |
Returns
Partial<Deployment>
The addresses, graph name and graph url.
Inherited from
HypercertClientMethods.getDeployments
Defined in
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
indexer
• indexer: HypercertIndexer
The indexer used by the client.
Inherited from
Defined in
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
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
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
readonly
• readonly: boolean
Whether the client is in read-only mode.
Inherited from
Defined in
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
storage
• storage: HypercertStorageInterface
The storage layer used by the client.
Inherited from
Defined in
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