Interface IJPYC

interface IJPYC {
    allowance(
        params: { owner: `0x${string}`; spender: `0x${string}` },
    ): Promise<number>;
    approve(
        params: { spender: `0x${string}`; value: number },
    ): Promise<`0x${string}`>;
    balanceOf(params: { account: `0x${string}` }): Promise<number>;
    cancelAuthorization(
        params: {
            authorizer: `0x${string}`;
            nonce: `0x${string}`;
            r: `0x${string}`;
            s: `0x${string}`;
            v: Uint8;
        },
    ): Promise<`0x${string}`>;
    configureMinter(
        params: { minter: `0x${string}`; minterAllowedAmount: number },
    ): Promise<`0x${string}`>;
    decreaseAllowance(
        params: { decrement: number; spender: `0x${string}` },
    ): Promise<`0x${string}`>;
    increaseAllowance(
        params: { increment: number; spender: `0x${string}` },
    ): Promise<`0x${string}`>;
    isMinter(params: { account: `0x${string}` }): Promise<boolean>;
    mint(params: { amount: number; to: `0x${string}` }): Promise<`0x${string}`>;
    minterAllowance(params: { minter: `0x${string}` }): Promise<number>;
    nonces(params: { owner: `0x${string}` }): Promise<Uint256>;
    permit(
        params: {
            deadline: Uint256;
            owner: `0x${string}`;
            r: `0x${string}`;
            s: `0x${string}`;
            spender: `0x${string}`;
            v: Uint8;
            value: number;
        },
    ): Promise<`0x${string}`>;
    receiveWithAuthorization(
        params: {
            from: `0x${string}`;
            nonce: `0x${string}`;
            r: `0x${string}`;
            s: `0x${string}`;
            to: `0x${string}`;
            v: Uint8;
            validAfter: Uint256;
            validBefore: Uint256;
            value: number;
        },
    ): Promise<`0x${string}`>;
    totalSupply(): Promise<number>;
    transfer(
        params: { to: `0x${string}`; value: number },
    ): Promise<`0x${string}`>;
    transferFrom(
        params: { from: `0x${string}`; to: `0x${string}`; value: number },
    ): Promise<`0x${string}`>;
    transferWithAuthorization(
        params: {
            from: `0x${string}`;
            nonce: `0x${string}`;
            r: `0x${string}`;
            s: `0x${string}`;
            to: `0x${string}`;
            v: Uint8;
            validAfter: Uint256;
            validBefore: Uint256;
            value: number;
        },
    ): Promise<`0x${string}`>;
}

Implemented by

Methods

allowance approve balanceOf cancelAuthorization configureMinter decreaseAllowance increaseAllowance isMinter mint minterAllowance nonces permit receiveWithAuthorization totalSupply transfer transferFrom transferWithAuthorization

Methods

allowance

  • allowance(
        params: { owner: `0x${string}`; spender: `0x${string}` },
    ): Promise<number>

  • Returns allowance of a spender over owner's tokens (for transferring).

    Parameters

    • params: { owner: `0x${string}`; spender: `0x${string}` }

    Returns Promise<number>

    spender allowance

approve

  • approve(
        params: { spender: `0x${string}`; value: number },
    ): Promise<`0x${string}`>

  • Sets allowance of a spender over owner's tokens.

    Parameters

    • params: { spender: `0x${string}`; value: number }

    Returns Promise<`0x${string}`>

    transaction hash

balanceOf

  • balanceOf(params: { account: `0x${string}` }): Promise<number>

  • Returns balance of an account.

    Parameters

    • params: { account: `0x${string}` }

    Returns Promise<number>

    account balance

cancelAuthorization

  • cancelAuthorization(
        params: {
            authorizer: `0x${string}`;
            nonce: `0x${string}`;
            r: `0x${string}`;
            s: `0x${string}`;
            v: Uint8;
        },
    ): Promise<`0x${string}`>

  • Cancels authorization.

    Parameters

    • params: {
          authorizer: `0x${string}`;
          nonce: `0x${string}`;
          r: `0x${string}`;
          s: `0x${string}`;
          v: Uint8;
      }

    Returns Promise<`0x${string}`>

    transaction hash

configureMinter

  • configureMinter(
        params: { minter: `0x${string}`; minterAllowedAmount: number },
    ): Promise<`0x${string}`>

  • Configures a minter.

    Parameters

    • params: { minter: `0x${string}`; minterAllowedAmount: number }

    Returns Promise<`0x${string}`>

    transaction hash

decreaseAllowance

  • decreaseAllowance(
        params: { decrement: number; spender: `0x${string}` },
    ): Promise<`0x${string}`>

  • Decreases allowance.

    Parameters

    • params: { decrement: number; spender: `0x${string}` }

    Returns Promise<`0x${string}`>

    transaction hash

increaseAllowance

  • increaseAllowance(
        params: { increment: number; spender: `0x${string}` },
    ): Promise<`0x${string}`>

  • Increases allowance.

    Parameters

    • params: { increment: number; spender: `0x${string}` }

    Returns Promise<`0x${string}`>

    transaction hash

isMinter

  • isMinter(params: { account: `0x${string}` }): Promise<boolean>

  • Returns true if the given address is a minter.

    Parameters

    • params: { account: `0x${string}` }

    Returns Promise<boolean>

    true if minter, false otherwise

mint

  • mint(params: { amount: number; to: `0x${string}` }): Promise<`0x${string}`>

  • Mints tokens.

    Parameters

    • params: { amount: number; to: `0x${string}` }

    Returns Promise<`0x${string}`>

    transaction hash

minterAllowance

  • minterAllowance(params: { minter: `0x${string}` }): Promise<number>

  • Returns allowance of a minter (for minting).

    Parameters

    • params: { minter: `0x${string}` }

    Returns Promise<number>

    minter allowance

nonces

  • nonces(params: { owner: `0x${string}` }): Promise<Uint256>

  • Returns nonce for EIP2612's permit.

    Parameters

    • params: { owner: `0x${string}` }

    Returns Promise<Uint256>

    owner nonce

permit

  • permit(
        params: {
            deadline: Uint256;
            owner: `0x${string}`;
            r: `0x${string}`;
            s: `0x${string}`;
            spender: `0x${string}`;
            v: Uint8;
            value: number;
        },
    ): Promise<`0x${string}`>

  • Sets allowance of a spender over owner's tokens, given owner's signed approval.

    Parameters

    • params: {
          deadline: Uint256;
          owner: `0x${string}`;
          r: `0x${string}`;
          s: `0x${string}`;
          spender: `0x${string}`;
          v: Uint8;
          value: number;
      }

    Returns Promise<`0x${string}`>

    transaction hash

receiveWithAuthorization

  • receiveWithAuthorization(
        params: {
            from: `0x${string}`;
            nonce: `0x${string}`;
            r: `0x${string}`;
            s: `0x${string}`;
            to: `0x${string}`;
            v: Uint8;
            validAfter: Uint256;
            validBefore: Uint256;
            value: number;
        },
    ): Promise<`0x${string}`>

  • Receives tokens with authorization.

    Parameters

    • params: {
          from: `0x${string}`;
          nonce: `0x${string}`;
          r: `0x${string}`;
          s: `0x${string}`;
          to: `0x${string}`;
          v: Uint8;
          validAfter: Uint256;
          validBefore: Uint256;
          value: number;
      }

    Returns Promise<`0x${string}`>

    transaction hash

totalSupply

transfer

  • transfer(params: { to: `0x${string}`; value: number }): Promise<`0x${string}`>

  • Transfers tokens (directly).

    Parameters

    • params: { to: `0x${string}`; value: number }

    Returns Promise<`0x${string}`>

    transaction hash

transferFrom

  • transferFrom(
        params: { from: `0x${string}`; to: `0x${string}`; value: number },
    ): Promise<`0x${string}`>

  • Transfers tokens (from spender).

    Parameters

    • params: { from: `0x${string}`; to: `0x${string}`; value: number }

    Returns Promise<`0x${string}`>

    transaction hash

transferWithAuthorization

  • transferWithAuthorization(
        params: {
            from: `0x${string}`;
            nonce: `0x${string}`;
            r: `0x${string}`;
            s: `0x${string}`;
            to: `0x${string}`;
            v: Uint8;
            validAfter: Uint256;
            validBefore: Uint256;
            value: number;
        },
    ): Promise<`0x${string}`>

  • Transfers tokens with authorization.

    Parameters

    • params: {
          from: `0x${string}`;
          nonce: `0x${string}`;
          r: `0x${string}`;
          s: `0x${string}`;
          to: `0x${string}`;
          v: Uint8;
          validAfter: Uint256;
          validBefore: Uint256;
          value: number;
      }

    Returns Promise<`0x${string}`>

    transaction hash

Settings

Member Visibility

On This Page

Methods