Installing SDK

npm install @usecyan/sdk

yarn add @usecyan/sdk

import {Cyan} from '@usecyan/sdk'

const apiKey = process.env.CYAN_API_KEY

const provider ... // your web3 provider
const host = 'https://testnet-api.usecyan.com'

const cyan = await Cyan.initiate({apiKey, provider, host})

async configure(): Promise<IConfigs>

async priceBnplsStep1(
	currencyAddress: string,
	items: Array<IItem | IItemWithPrice>
): Promise<{
	items: (IItemWithPrice & { interestRate: number })[];
	options: IOption[];
}>

async priceBnplsStep2(args: {
	wallet: string;
	items: IItemWithPrice[];
	option: IOption;
	currencyAddress: string;
	autoRepayStatus: 0 | 1;
}): Promise<Errored<ICreatePlanParams & { isChanged: boolean; marketName: string }>[]>

async pricePawnsStep1(
	currencyAddress: string,
	items: Array<IItem | IItemWithPrice>
): Promise<{
	items: (IItemWithPrice & { interestRate: number })[];
	options: IOption[];
}>

async pricePawnsStep2(args: {
	wallet: string;
	items: IItemWithPrice[];
	option: IOption;
	currencyAddress: string;
	autoRepayStatus: 0 | 1;
}): Promise<Errored<ICreatePlanParams & { isChanged: boolean; marketName: string }>[]>

async acceptPlans(plans: ICreatePlanParams[]): Promise<void>

async checkAndAllowCurrencyForPlan(currencyAddress: string, amount: BigNumber): Promise<void>

async getApproval(address: string, tokenId: string, tokenType?: INftType): Promise<void>

async createBnpls(
	currencyAddress: string, // The address of the currency to use for the BNPL plans.
	plans: ICreatePlanParams[], // An array of objects containing the parameters for each plan to create.
	useOriginalWallet: boolean = true // Whether to pay the downpayment using the original wallet or not (only works for native currency)
): Promise<ContractTransaction>

async createPawns(plans: ICreatePlanParams[]): Promise<ContractTransaction>

async getPaymentInfo(
	plan: IPlan, // The payment plan object
	isEarlyRepayment: boolean = false // Optional flag to indicate if this is early repayment or not
): Promise<{
	payAmountForCollateral: string;
	payAmountForInterest: string;
	payAmountForService: string;
	currentPayment: string;
	dueDate?: Date;
}>

async pay(plan: IPlan): Promise<ContractTransaction>

async payEarly(plan: IPlan): Promise<ContractTransaction>

async payBulk(plans: IPlan[], isEarlyPayment: boolean, releaseWallet?: string): Promise<ContractTransaction>

async fulfillOffer(plan: IPlan, offer: IOffer): Promise<ContractTransaction>

async getUserPlans(address: string): Promise<IPlan[]>

async getCyanWallet(): Promise<CyanWallet>

async getTopBids(collectionAddress: string, tokenId?: string): Promise<IOffer[]>

async createCyanWallet(): Promise<ContractTransaction>

async getPaymentPlanContract(): Promise<PaymentPlanV2>