@arkade-os/sdk Documentation - v0.4.54
    Preparing search index...

    Class Arkade

    A connected Arkade client. Holds the providers/identity/network and the resolved network constants (server key, co-signer key, checkpoint closure), so spinning up contracts is synchronous.

    Index

    Properties

    arkProvider: Pick<ArkProvider, "getInfo" | "submitTx" | "finalizeTx">
    contractManager?: IContractManager

    The wallet's contract manager, when contract persistence is wired up.

    emulator: EmulatorProvider | undefined

    The co-signing service, or undefined for emulator-less (pure tapscript) usage.

    emulatorKey: Uint8Array<ArrayBufferLike> | undefined

    The co-signer's x-only key, present only when an emulator is configured.

    identity?: Identity
    indexer?: Pick<IndexerProvider, "getVtxos">
    network: Network
    serverKey: Uint8Array
    userKey?: Uint8Array<ArrayBufferLike>

    The signing identity's x-only public key, resolved at connect — identifies which inputs the wallet signs.

    Methods

    • Instantiate a contract from a program and its constructor arguments. The program's literal type is preserved (const inference) so the resulting contract's functions map is strongly typed — functions.<name>(...) knows each argument's type from the function's inputs descriptors.

      When the program declares a server or user param and the caller does not bind it, it defaults to the client's server key or the identity's key respectively; explicit args always win.

      Type Parameters

      Parameters

      Returns ArkadeContract<P>