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

Function createTokensNamespace

  • createTokensNamespace(ctx): {
        approve: ((tokenAddress: string, spender: string, amount: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        burn: ((tokenAddress: string, from: string, amount: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        callMethod: ((tokenAddress: string, method: string, params: unknown[], opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        create: ((params: TokenCreationParams, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        grantPermissions: ((tokenAddress: string, address: string, permissions: string[], opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        mint: ((tokenAddress: string, to: string, amount: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        pause: ((tokenAddress: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        revokePermissions: ((tokenAddress: string, address: string, permissions: string[], opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        transfer: ((tokenAddress: string, to: string, amount: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        transferFrom: ((tokenAddress: string, from: string, to: string, amount: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        transferOwnership: ((tokenAddress: string, newOwner: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        unpause: ((tokenAddress: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        upgradeScript: ((tokenAddress: string, newCode: string, newMethods: TokenScriptMethod[], newHooks: TokenHookType[], opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
    }
  • Token creation and execution as one-call programmatic transactions.

    Wraps DemosTokens so deploying a token or running a token operation (transfer, approve, mint, burn, …) collapses the classic build → sign → confirm → broadcast flow into a single call. Each builder here returns an UNSIGNED transaction; the method hands a thunk producing it to ctx.run(...), which signs, confirms against the fee ceiling and auto-broadcasts — keeping fee-cap policy, confirmation strategy and result shape uniform with the rest of demos.run.*.

    All amounts are bigint-valued decimal strings, mirroring DemosTokens.

    Parameters

    • ctx: ProgrammaticContext

    Returns {
        approve: ((tokenAddress: string, spender: string, amount: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        burn: ((tokenAddress: string, from: string, amount: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        callMethod: ((tokenAddress: string, method: string, params: unknown[], opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        create: ((params: TokenCreationParams, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        grantPermissions: ((tokenAddress: string, address: string, permissions: string[], opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        mint: ((tokenAddress: string, to: string, amount: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        pause: ((tokenAddress: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        revokePermissions: ((tokenAddress: string, address: string, permissions: string[], opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        transfer: ((tokenAddress: string, to: string, amount: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        transferFrom: ((tokenAddress: string, from: string, to: string, amount: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        transferOwnership: ((tokenAddress: string, newOwner: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        unpause: ((tokenAddress: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
        upgradeScript: ((tokenAddress: string, newCode: string, newMethods: TokenScriptMethod[], newHooks: TokenHookType[], opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>);
    }

    • approve: ((tokenAddress: string, spender: string, amount: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>)

      Approve a spender to move tokens on your behalf, end to end.

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

          • tokenAddress: string

            Token contract address.

          • spender: string

            Spender address being granted the allowance.

          • amount: string

            Amount to approve (bigint-valued decimal string).

          • Optionalopts: ProgrammaticTxOptions

            Fee ceiling / confirmation strategy / wait behaviour.

          Returns Promise<ProgrammaticTxResult>

    • burn: ((tokenAddress: string, from: string, amount: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>)

      Burn tokens from an address, end to end.

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

          • tokenAddress: string

            Token contract address.

          • from: string

            Address to burn tokens from.

          • amount: string

            Amount to burn (bigint-valued decimal string).

          • Optionalopts: ProgrammaticTxOptions

            Fee ceiling / confirmation strategy / wait behaviour.

          Returns Promise<ProgrammaticTxResult>

    • callMethod: ((tokenAddress: string, method: string, params: unknown[], opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>)

      Call a custom script method on the token, end to end.

        • (tokenAddress, method, params, opts?): Promise<ProgrammaticTxResult>
        • Parameters

          • tokenAddress: string

            Token contract address.

          • method: string

            Method name to invoke.

          • params: unknown[]

            Method parameters.

          • Optionalopts: ProgrammaticTxOptions

            Fee ceiling / confirmation strategy / wait behaviour.

          Returns Promise<ProgrammaticTxResult>

    • create: ((params: TokenCreationParams, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>)

      Deploy a new token, end to end.

      Example

      const r = await demos.run.tokens.create({
      name: "My Token",
      ticker: "MYT",
      decimals: 18,
      initialSupply: "1000000",
      })
      console.log(r.transaction.content.to) // derived token address
        • (params, opts?): Promise<ProgrammaticTxResult>
        • Parameters

          • params: TokenCreationParams

            Token creation parameters (name, ticker, decimals, initial supply, optional script/ACL).

          • Optionalopts: ProgrammaticTxOptions

            Fee ceiling / confirmation strategy / wait behaviour.

          Returns Promise<ProgrammaticTxResult>

    • grantPermissions: ((tokenAddress: string, address: string, permissions: string[], opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>)

      Grant ACL permissions to an address, end to end.

        • (tokenAddress, address, permissions, opts?): Promise<ProgrammaticTxResult>
        • Parameters

          • tokenAddress: string

            Token contract address.

          • address: string

            Address being granted the permissions.

          • permissions: string[]

            Permissions to grant.

          • Optionalopts: ProgrammaticTxOptions

            Fee ceiling / confirmation strategy / wait behaviour.

          Returns Promise<ProgrammaticTxResult>

    • mint: ((tokenAddress: string, to: string, amount: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>)

      Mint new tokens to an address, end to end.

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

          • tokenAddress: string

            Token contract address.

          • to: string

            Recipient of the minted tokens.

          • amount: string

            Amount to mint (bigint-valued decimal string).

          • Optionalopts: ProgrammaticTxOptions

            Fee ceiling / confirmation strategy / wait behaviour.

          Returns Promise<ProgrammaticTxResult>

    • pause: ((tokenAddress: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>)

      Pause all token operations, end to end.

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

          • tokenAddress: string

            Token contract address.

          • Optionalopts: ProgrammaticTxOptions

            Fee ceiling / confirmation strategy / wait behaviour.

          Returns Promise<ProgrammaticTxResult>

    • revokePermissions: ((tokenAddress: string, address: string, permissions: string[], opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>)

      Revoke ACL permissions from an address, end to end.

        • (tokenAddress, address, permissions, opts?): Promise<ProgrammaticTxResult>
        • Parameters

          • tokenAddress: string

            Token contract address.

          • address: string

            Address the permissions are revoked from.

          • permissions: string[]

            Permissions to revoke.

          • Optionalopts: ProgrammaticTxOptions

            Fee ceiling / confirmation strategy / wait behaviour.

          Returns Promise<ProgrammaticTxResult>

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

      Transfer tokens to another address, end to end.

      Example

      // auto-broadcast within the 5 DEM fee cap:
      await demos.run.tokens.transfer("0xToken...", "0xTo...", "1000")
      // build + confirm only, broadcast later yourself:
      const r = await demos.run.tokens.transfer(
      "0xToken...", "0xTo...", "1000", { confirm: "manual" },
      )
      await demos.broadcast(r.validityData)
        • (tokenAddress, to, amount, opts?): Promise<ProgrammaticTxResult>
        • Parameters

          • tokenAddress: string

            Token contract address.

          • to: string

            Recipient address.

          • amount: string

            Amount to transfer (bigint-valued decimal string).

          • Optionalopts: ProgrammaticTxOptions

            Fee ceiling / confirmation strategy / wait behaviour.

          Returns Promise<ProgrammaticTxResult>

    • transferFrom: ((tokenAddress: string, from: string, to: string, amount: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>)

      Transfer tokens from one address to another using an existing allowance, end to end.

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

          • tokenAddress: string

            Token contract address.

          • from: string

            Owner address the tokens are moved from.

          • to: string

            Recipient address.

          • amount: string

            Amount to transfer (bigint-valued decimal string).

          • Optionalopts: ProgrammaticTxOptions

            Fee ceiling / confirmation strategy / wait behaviour.

          Returns Promise<ProgrammaticTxResult>

    • transferOwnership: ((tokenAddress: string, newOwner: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>)

      Transfer ownership of the token to a new owner, end to end.

        • (tokenAddress, newOwner, opts?): Promise<ProgrammaticTxResult>
        • Parameters

          • tokenAddress: string

            Token contract address.

          • newOwner: string

            Address of the new owner.

          • Optionalopts: ProgrammaticTxOptions

            Fee ceiling / confirmation strategy / wait behaviour.

          Returns Promise<ProgrammaticTxResult>

    • unpause: ((tokenAddress: string, opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>)

      Resume a paused token, end to end.

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

          • tokenAddress: string

            Token contract address.

          • Optionalopts: ProgrammaticTxOptions

            Fee ceiling / confirmation strategy / wait behaviour.

          Returns Promise<ProgrammaticTxResult>

    • upgradeScript: ((tokenAddress: string, newCode: string, newMethods: TokenScriptMethod[], newHooks: TokenHookType[], opts?: ProgrammaticTxOptions) => Promise<ProgrammaticTxResult>)

      Upgrade the token's on-chain script, end to end.

        • (tokenAddress, newCode, newMethods, newHooks, opts?): Promise<ProgrammaticTxResult>
        • Parameters

          • tokenAddress: string

            Token contract address.

          • newCode: string

            New script code.

          • newMethods: TokenScriptMethod[]

            New method definitions to install.

          • newHooks: TokenHookType[]

            New hooks to activate.

          • Optionalopts: ProgrammaticTxOptions

            Fee ceiling / confirmation strategy / wait behaviour.

          Returns Promise<ProgrammaticTxResult>

    • Defined in src/websdk/programmatic/tokens.ts:24

Settings

Member Visibility
@kynesyslabs/demosdk
  • Loading...

Generated using TypeDoc