• Preparing search index...
  • The search index is not available
@kynesyslabs/demosdk
  • @kynesyslabs/demosdk
  • websdk
  • createPayNamespace

Function createPayNamespace

  • createPayNamespace(ctx): {
        pay: ((to: string, amount: number | bigint, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        transfer: ((to: string, amount: number | bigint, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
    }
  • Native-value transfers as one-call programmatic transactions.

    Collapses the classic pay → confirm → broadcast flow into a single call that auto-broadcasts within the configured fee ceiling.

    Parameters

    • ctx: ProgrammaticContext

    Returns {
        pay: ((to: string, amount: number | bigint, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        transfer: ((to: string, amount: number | bigint, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
    }

    • pay: ((to: string, amount: number | bigint, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>)

      Send native DEMOS tokens to an address, end to end.

      Example

      import { denomination } from "@kynesyslabs/demosdk"
      // auto-broadcast within the 5 DEM fee cap:
      await demos.run.pay("0x...", denomination.demToOs(100))
      // build + confirm only, broadcast later yourself:
      const r = await demos.run.pay("0x...", 100n, { confirm: "manual" })
      await demos.broadcast(r.validityData)
        • (to, amount, opts?): Promise<ProgrammaticTxResult>
        • Parameters

          • to: string

            Receiver address (0x-prefixed hex).

          • amount: number | bigint

            DEM number (legacy) or OS bigint (preferred).

          • Optionalopts: ProgrammaticTxOptions

            Fee ceiling / confirmation strategy / wait behaviour.

          Returns Promise<ProgrammaticTxResult>

    • transfer: ((to: string, amount: number | bigint, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>)

      Alias of pay. Same dual-input amount semantics.

        • (to, amount, opts?): Promise<ProgrammaticTxResult>
        • Parameters

          • to: string

            Receiver address (0x-prefixed hex).

          • amount: number | bigint

            DEM number (legacy) or OS bigint (preferred).

          • Optionalopts: ProgrammaticTxOptions

            Fee ceiling / confirmation strategy / wait behaviour.

          Returns Promise<ProgrammaticTxResult>

    • Defined in src/websdk/programmatic/pay.ts:10

Settings

Member Visibility
@kynesyslabs/demosdk
  • Loading...

Generated using TypeDoc