@kiwarilabs/chidori-sdk 1.0.0

package/dist/cjs/types/types.d.ts

@@ -0,0 +1,55 @@
+import { type JsonRpcApiProvider as ProviderEthersV6, type Signer as SignerEthersV6 } from 'ethers-v6';
+import { Provider } from '@ethersproject/abstract-provider';
+import { Signer } from '@ethersproject/abstract-signer';
+import { JsonRpcProvider } from '@ethersproject/providers';
+export type SupportProviderType = Signer | Provider | JsonRpcProvider | ProviderEthersV6 | SignerEthersV6;
+export interface Providers {
+    provider: SupportProviderType;
+}
+export interface GetBalanceOfInterface {
+    contractAddress: string;
+    accountAddress: string;
+}
+export interface GetBalanceOfAtEpochInterface {
+    contractAddress: string;
+    accountAddress: string;
+    epoch: number;
+}
+export interface GetDecimalsInterface {
+    contractAddress: string;
+}
+export interface GetValidityDurationInterface {
+    contractAddress: string;
+}
+export interface GetCurrentEpochInterface {
+    contractAddress: string;
+}
+export interface GetIsEpochExpireInterface {
+    contractAddress: string;
+    identifier: number;
+}
+export interface GetEpochLengthInterface {
+    contractAddress: string;
+}
+export interface GetNameInterface {
+    contractAddress: string;
+}
+export interface GetSymbolInterface {
+    contractAddress: string;
+}
+export interface GetTotalSupplyInterface {
+    contractAddress: string;
+}
+export interface TransferInterface {
+    contractAddress: string;
+    to: string;
+    identifier: number;
+    value: number;
+}
+export interface TransferFromInterface {
+    contractAddress: string;
+    from: string;
+    to: string;
+    identifier: number;
+    value: number;
+}

package/dist/es/blockchain/chidori-provider.d.ts

@@ -0,0 +1,15 @@
+import { JsonRpcProvider, JsonRpcSigner } from '@ethersproject/providers';
+import { Providers } from '../types/types';
+export declare class ChidoriProvider {
+    readonly provider: {
+        provider: JsonRpcProvider;
+        signer: JsonRpcSigner;
+    };
+    constructor(config: {
+        provider: Providers;
+    });
+    wrapInputProviderLike(input: Providers): {
+        provider: JsonRpcProvider;
+        signer: JsonRpcSigner;
+    };
+}

package/dist/es/blockchain/chidori.d.ts

@@ -0,0 +1,8 @@
+import { Providers } from '../types/types';
+import { ChidoriProvider } from './chidori-provider';
+import { ERC7818Namespace } from './erc7818-namespace';
+export declare class Chidori {
+    readonly erc7818Expirable: ERC7818Namespace;
+    readonly chidoriProvider: ChidoriProvider;
+    constructor(providers: Providers);
+}

package/dist/es/blockchain/erc7818-namespace.d.ts

@@ -0,0 +1,102 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { GetBalanceOfAtEpochInterface, GetBalanceOfInterface, GetCurrentEpochInterface, GetDecimalsInterface, GetEpochLengthInterface, GetIsEpochExpireInterface, GetNameInterface, GetSymbolInterface, GetTotalSupplyInterface, // TransferFromInterface,
+GetValidityDurationInterface } from '../types/types';
+import { ChidoriProvider } from './chidori-provider';
+export declare class ERC7818Namespace {
+    private readonly chidoriProvider;
+    constructor(chidoriProvider: ChidoriProvider);
+    /**
+     * Get balance of owner.
+     *
+     * This method returns the balance of user.
+     *
+     * @param contractAddress - The address of the contract.
+     * @param accountAddress - The address of the account.
+     * @public
+     */
+    getBalanceOf({ contractAddress, accountAddress }: GetBalanceOfInterface): Promise<string>;
+    /**
+     * Get balance at epoch of owner by identifier.
+     *
+     * This method returns the balance of user.
+     *
+     * @param contractAddress - The address of the contract.
+     * @param accountAddress - The address of the account.
+     * @param identifier - The Identifier "MAY" represents an epoch, round, period, or token identifier.
+     * @public
+     */
+    getBalanceOfAtEpoch({ contractAddress, accountAddress, epoch }: GetBalanceOfAtEpochInterface): Promise<BigNumber>;
+    /**
+     * Get decimals of token.
+     *
+     * This method returns the decimals of token.
+     *
+     * @param contractAddress - The address of the contract.
+     * @public
+     */
+    getDecimals({ contractAddress }: GetDecimalsInterface): Promise<Number>;
+    /**
+     * Get validity duration.
+     *
+     * This method returns validity duration in blocks or the time in seconds.
+     *
+     * @param contractAddress - The address of the contract.
+     * @public
+     */
+    getValidityDuration({ contractAddress }: GetValidityDurationInterface): Promise<BigNumber>;
+    /**
+     * Get current epoch.
+     *
+     * This method returns current epoch of the token contract, often used for determining active/expired states.
+     *
+     * @param contractAddress - The address of the contract.
+     * @public
+     */
+    getCurrentEpoch({ contractAddress }: GetCurrentEpochInterface): Promise<BigNumber>;
+    /**
+     * Get epoch length.
+     *
+     * This method returns dulation of single epoch.
+     *
+     * @param contractAddress - The address of the contract.
+     * @public
+     */
+    getEpochLength({ contractAddress }: GetEpochLengthInterface): Promise<BigNumber>;
+    /**
+     * Get is epoch expire.
+     *
+     * This method returns boolean of the token contract, True if the token is expired, false otherwise.
+     *
+     * @param contractAddress - The address of the contract.
+     * @param identifier - The Identifier "MAY" represents an epoch, round, period, or token identifier.
+     * @public
+     */
+    getIsExpochExpire({ contractAddress, identifier }: GetIsEpochExpireInterface): Promise<Boolean>;
+    /**
+     * Get name of token.
+     *
+     * This method returns the name of token.
+     *
+     * @param contractAddress - The address of the contract.
+     * @public
+     */
+    getName({ contractAddress }: GetNameInterface): Promise<string>;
+    /**
+     * Get symbol of token.
+     *
+     * This method returns the symbol of token.
+     *
+     * @param contractAddress - The address of the contract.
+     * @public
+     */
+    getSymbol({ contractAddress }: GetSymbolInterface): Promise<string>;
+    /**
+     * Get total supply of token.
+     *
+     * This method returns the total supply of token.
+     *
+     * @param contractAddress - The address of the contract.
+     * @public
+     */
+    getTotalSupply({ contractAddress }: GetTotalSupplyInterface): Promise<BigNumber>;
+}

package/dist/es/index.d.ts

@@ -0,0 +1 @@
+export { Chidori } from './blockchain/chidori';