Class Contract

This class is used to interact with the contract.

Example

import { createContract } from 'crossbell'

// Create a new contract instance with metamask provider
const provider = window.ethereum
const contract = createContract(provider)
await contract.walletClient.requestAddresses()
// Example API: Create a new character for an address
try {
  const result = await contract.character.create(
    '0x1234567890123456789012345678901234567890',
    'Jason',
    'ipfs://xxxx/metadata.json',
  )
  console.log(result.data) // '42' (characterId)
  console.log(result.transactionHash) // '0xabcdef...'
} catch (e) {
  console.error(e.message) // e.g. "execution reverted: Web3Entry: HandleExists"
}

Hierarchy (view full)

Constructors

constructor

Properties

cbt cbtContract character contract csb link linklistContract linkModule mintModule miraContract newbieVillaContract note operator options peripheryContract publicClient revision tips tipsContract tipsWithConfigContract tipsWithFee tipsWithFeeContract walletClient

Accessors

account

Constructors

constructor

  • new Contract(providerOrPrivateKey, options?): Contract

  • This creates a new Contract instance to interact with.

    Parameters

    • providerOrPrivateKey: undefined | `0x${string}` | EIP1193Provider

      The provider or private key to connect to the contract.

    • Optionaloptions: Partial<ContractOptions>

    Returns Contract

    The Contract instance.

    Example: Connect with Metamask

    import { Contract } from 'crossbell'
    const provider = window.ethereum // the metamask provider
    const contract = new Contract(provider)

    Example: Connect with Private Key

    import { Contract } from 'crossbell'
    const privateKey = '0xabcdef0123456789012345678901234567890123456789012345678901234'
    const contract = new Contract(privateKey)

    Example: Connect with a Readonly Contract

    import { Contract } from 'crossbell'
    const contract = new Contract() // readonly contract

Properties

cbt

cbt: CbtContract = ...

cbtContract

cbtContract: {}

character

character: CharacterContract = ...

contract

contract: {}

csb

csb: CsbContract = ...

link

link: LinkContract = ...

linklistContract

linklistContract: {}

linkModule

linkModule: LinkModuleContract = ...

mintModule

mintModule: MintModuleContract = ...

miraContract

miraContract: {}

newbieVillaContract

newbieVillaContract: {}

note

note: NoteContract = ...

operator

operator: OperatorContract = ...

options

options: ResolvedContractOptions

peripheryContract

peripheryContract: {}

publicClient

publicClient: {}

revision

revision: RevisionContract = ...

tips

tips: TipsContract = ...

tipsContract

tipsContract: {}

tipsWithConfigContract

tipsWithConfigContract: {}

tipsWithFee

tipsWithFee: TipsWithFeeContract = ...

tipsWithFeeContract

tipsWithFeeContract: {}

walletClient

walletClient: {}

Accessors

account

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors