TypeScript

Description

Only registered partners can use this feature. Unregistered partners may test on the testnet using the secret key provided in the sample code.

This function is used by partners who support the payment system. The loyalty system's testnet is ready; you can use it for development, and once development is complete, you can switch to the mainnet.

Please create a wallet to be used with this feature and provide the wallet address to the loyalty system operations team.

• For the testnet, the wallet's secret key to be used is: 0xa0dcffca22f13363ab5d109f3a51ca99754cff4ce4c71dccc0c5df7f6492beee

• For the mainnet, create a wallet independently and deliver only its public address to the operations team.

The system adds purchase data received from trusted partners to the blockchain, which is then verified by validators. If the data is verified, the system provides the purchaser with points equivalent to a certain percentage of the purchase amount.

---

Development and Operation

Follow the steps below to proceed:

Development and Testing:

1. First, install the user app and set the network to testnet.

2. Review the test code and implement the necessary features. When creating SavePurchaseCent, use the wallet's private key: 0xa0dcffca22f13363ab5d109f3a51ca99754cff4ce4c71dccc0c5df7f6492beee (for testnet).

3. Purchaser’s wallet address recorded in the purchase data should be the wallet address from the user app.

4. Note: Testnet store IDs begin with “0x0003”.

Switching to Mainnet:

1. Generate a new wallet and use its private key to create SavePurchaseCent. You may use a wallet generated using MetaMask.

2. Send the wallet address created in step 1 to the KIOS operations team.

Cautions:

1. Both testnet and mainnet are always active, so ensure the system can handle both networks in the future.

2. If the store ID of the POS or KIOSK starts with "0x0003", use testnet information for SavePurchaseCent. If the store ID starts with "0x0004", use mainnet information.

3. SMS functionality is available only in Korea.

---

SDK

GitHub - kios-coin/kios-service-sdk: SDK essential for developing loyalty servicesGitHub

Sample Code

kios-service-sdk/typescript/tests/SavePurchaseClient.test.ts at v0.x.x · kios-coin/kios-service-sdkGitHub

1. Define the private keys for a wallet by network

Please use the registered value for the test net, generate the key to be used on the main net, and pass only the address to the KIOS operation team

// Key required to store purchase data
// ---------------------------------------------------------------------------------------
const KeysOfCollector: Map<number, string> = new Map([
    [NetWorkType.acc_testnet, "0x8acceea5937a8e4bb07abc93a1374264dd9bd2fc384c979717936efe63367276"],
    [NetWorkType.acc_mainnet, "0x0000000000000000000000000000000000000000000000000000000000000000"],
    [NetWorkType.kios_testnet, "0xa0dcffca22f13363ab5d109f3a51ca99754cff4ce4c71dccc0c5df7f6492beee"],
    [NetWorkType.kios_mainnet, "0x0000000000000000000000000000000000000000000000000000000000000000"],
    [NetWorkType.localhost, "0x2c93e943c0d7f6f1a42f53e116c52c40fe5c1b428506dc04b290f2a77580a342"],
]);
// ---------------------------------------------------------------------------------------

2. Define the asset address for a wallet by network.

// System address where the point is owned by the asset
// ---------------------------------------------------------------------------------------
const AssetAddresses: Map<number, string> = new Map([
    [NetWorkType.acc_testnet, "0x85EeBb1289c0d0C17eFCbadB40AeF0a1c3b46714"],
    [NetWorkType.acc_mainnet, "0xCB2e8ebBF4013164161d7F2297be25d4A9dC6b17"],
    [NetWorkType.kios_testnet, "0x153f2340807370855092D04E0e0abe4f2b634240"],
    [NetWorkType.kios_mainnet, "0xf077c9CfFa387E35de72b68448ceD5382CbC5D7D"],
    [NetWorkType.localhost, "0x4501F7aF010Cef3DcEaAfbc7Bfb2B39dE57df54d"],
]);
// ---------------------------------------------------------------------------------------

3. To determine the type of network

The type of network is determined by the shopID.

// ---------------------------------------------------------------------------------------
// Shop ID of the KIOSK
const shopId = "0x0003be96d74202df38fd21462ffcef10dfe0fcbd7caa3947689a3903e8b6b874";


// Select a network, select a network according to the Shop ID
const network = CommonUtils.getNetWorkType(shopId);

4. Creating a Client

// Create a client that transmits purchase data
// ---------------------------------------------------------------------------------------
const savePurchaseClient = new SavePurchaseClient(
    network,
    KeysOfCollector.get(network) || "",
    AssetAddresses.get(network) || ""
);
// ---------------------------------------------------------------------------------------

5. Save new purchase data

const purchaseId = "P100000000000000";
const timestamp = BigInt(new Date().getTime() / 1000);
await savePurchaseClient.saveNewPurchase(
    purchaseId,   // 결제 아이디
    timestamp,    // 결제 시간        
    0n,           // 포인트지급까지 지연시간(초) 카드결제취소대응를 위해 10일(10*86400) 으로 지정 또는 0         
    10_000,       // 총 결제금액 
    10_000,       // 현금 결제금액
    "krw",        // 환률 심벌
    shopId,       // 상점 아이디
    userAccount,  // 구매자의 지갑주소 - 구매자가 입력하지 않았다면 ""
    userPhone,    // 구매자의 전화번호 - 구매자가 입력하지 않았다면 ""
    [
        {
            productId: "2020051310000000", // 상품아이디
            amount: 10_000,                // 상품의 단가 * 수량
            providePercent: 10,            // 상품의 포인트 지급룰 (%)
        },
    ]
);

6. Save Cancellation Purchase Data

await savePurchaseClient.saveCancelPurchase(purchaseId, timestamp, 60n);