CSUB-518: GATE -> CTC Swap

Cargo.toml

@@ -23,7 +23,7 @@ members = [
 resolver = "2"
 
 [workspace.package]
-version = '2.226.1'
+version = '2.227.0'
 authors = ['Gluwa Inc.', 'Nathan Whitaker <nathan.whitaker@gluwa.com>']
 edition = '2021'
 license = 'Unlicense'

creditcoin-js/src/extrinsics/extrinsics.ts

@@ -21,13 +21,15 @@ import {
     TransferId,
     ExternalAddress,
     OwnershipProof,
+    CollectCoinsContract,
 } from '../model';
 import { KeyringPair } from '@polkadot/keyring/types';
 import { lockDealOrderAsync } from './lock-deal-order';
 import { closeDealOrderAsync } from './close-deal-order';
 import { exemptLoanAsync } from './exempt';
 import { requestCollectCoinsAsync } from './request-collect-coins';
 import { registerAddressV2Async } from './register-address-v2';
+import { requestCollectCoinvsV2Async } from './request-collect-coins-v2';
 
 export const extrinsics = (api: ApiPromise) => {
     const registerAddress = (
@@ -119,6 +121,9 @@ export const extrinsics = (api: ApiPromise) => {
         signer: KeyringPair,
     ) => registerAddressV2Async(api, externalAddress, blockchain, ownershipProof, signer);
 
+    const requestCollectCoinsV2 = (contract: CollectCoinsContract, signer: KeyringPair) =>
+        requestCollectCoinvsV2Async(api, contract, signer);
+
     return {
         registerAddress,
         registerAddressV2,
@@ -134,5 +139,6 @@ export const extrinsics = (api: ApiPromise) => {
         closeDealOrder,
         exemptLoan,
         requestCollectCoins,
+        requestCollectCoinsV2,
     };
 };

creditcoin-js/src/extrinsics/request-collect-coins-v2.ts

@@ -0,0 +1,64 @@
+import { ApiPromise, SubmittableResult } from '@polkadot/api';
+import { ExternalAddress, CollectCoinsContract } from '../model';
+import { KeyringPair } from '@polkadot/keyring/types';
+import { handleTransaction } from './common';
+import { TxCallback, TxFailureCallback } from '..';
+import { PalletCreditcoinCollectCoinsTokenContract } from '@polkadot/types/lookup';
+import { CollectCoinsEvent, createCollectCoinsRegisteredEvent } from './request-collect-coins';
+
+export const createTokenContract = (
+    api: ApiPromise,
+    contract: CollectCoinsContract,
+): PalletCreditcoinCollectCoinsTokenContract => {
+    const toType = () => {
+        switch (contract.kind) {
+            case 'GCRE':
+                // eslint-disable-next-line @typescript-eslint/naming-convention
+                return { GCRE: [contract.evmAddress, contract.txHash] };
+            case 'GATE':
+                // eslint-disable-next-line @typescript-eslint/naming-convention
+                return { GATE: [contract.evmAddress, contract.txHash] };
+        }
+    };
+
+    return api.createType('PalletCreditcoinCollectCoinsTokenContract', toType());
+};
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const GATEContract = (evmAddress: ExternalAddress, txHash: string): CollectCoinsContract => {
+    return { kind: 'GATE', evmAddress, txHash };
+};
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const GCREContract = (evmAddress: ExternalAddress, txHash: string): CollectCoinsContract => {
+    return { kind: 'GCRE', evmAddress, txHash };
+};
+
+export const requestCollectCoinsV2 = async (
+    api: ApiPromise,
+    contract: CollectCoinsContract,
+    signer: KeyringPair,
+    onSuccess: TxCallback,
+    onFail: TxFailureCallback,
+) => {
+    const formattedContract = createTokenContract(api, contract);
+
+    const unsubscribe: () => void = await api.tx.creditcoin
+        .requestCollectCoinsV2(formattedContract)
+        .signAndSend(signer, { nonce: -1 }, (result) => handleTransaction(api, unsubscribe, result, onSuccess, onFail));
+};
+
+export const requestCollectCoinvsV2Async = async (
+    api: ApiPromise,
+    contract: CollectCoinsContract,
+    signer: KeyringPair,
+) => {
+    return new Promise<CollectCoinsEvent>((resolve, reject) => {
+        const onSuccess = (result: SubmittableResult) =>
+            resolve(createCollectCoinsRegisteredEvent(api, result, 'CollectCoinsRegistered'));
+
+        requestCollectCoinsV2(api, contract, signer, onSuccess, reject).catch((reason) => {
+            reject(reason);
+        });
+    });
+};

creditcoin-js/src/extrinsics/request-collect-coins.ts

@@ -68,7 +68,7 @@ const persistedCollectCoins = (api: ApiPromise, collectedCoinsId: CollectedCoins
     );
 };
 
-const createCollectCoinsRegisteredEvent = (
+export const createCollectCoinsRegisteredEvent = (
     api: ApiPromise,
     result: SubmittableResult,
     kind: CollectCoinsEventKind,

creditcoin-js/src/interfaces/augment-api-errors.ts

@@ -104,6 +104,8 @@ declare module '@polkadot/api-base/types/errors' {
              * The bid order has expired and is no longer valid.
              **/
             BidOrderExpired: AugmentedError<ApiType>;
+            BurnGATEFaucetNotSet: AugmentedError<ApiType>;
+            BurnGATEInsufficientFaucetBalance: AugmentedError<ApiType>;
             /**
              * The coin collection has already been registered.
              **/

creditcoin-js/src/interfaces/augment-api-query.ts

@@ -41,7 +41,7 @@ import type {
     PalletCreditcoinCollectCoinsCollectedCoins,
     PalletCreditcoinDealOrder,
     PalletCreditcoinLegacySighash,
-    PalletCreditcoinOcwTasksCollectCoinsGCreContract,
+    PalletCreditcoinOcwTasksCollectCoinsDeployedContract,
     PalletCreditcoinOffer,
     PalletCreditcoinTask,
     PalletCreditcoinTransfer,
@@ -333,9 +333,17 @@ declare module '@polkadot/api-base/types/storage' {
                 [u32, H256]
             > &
                 QueryableStorageEntry<ApiType, [u32, H256]>;
+            burnGATEConract: AugmentedQuery<
+                ApiType,
+                () => Observable<PalletCreditcoinOcwTasksCollectCoinsDeployedContract>,
+                []
+            > &
+                QueryableStorageEntry<ApiType, []>;
+            burnGATEFaucetAddress: AugmentedQuery<ApiType, () => Observable<Option<AccountId32>>, []> &
+                QueryableStorageEntry<ApiType, []>;
             collectCoinsContract: AugmentedQuery<
                 ApiType,
-                () => Observable<PalletCreditcoinOcwTasksCollectCoinsGCreContract>,
+                () => Observable<PalletCreditcoinOcwTasksCollectCoinsDeployedContract>,
                 []
             > &
                 QueryableStorageEntry<ApiType, []>;

creditcoin-js/src/interfaces/augment-api-tx.ts

@@ -35,10 +35,11 @@ import type {
     PalletCreditcoinAskOrderId,
     PalletCreditcoinBidOrderId,
     PalletCreditcoinBlockchain,
+    PalletCreditcoinCollectCoinsTokenContract,
     PalletCreditcoinDealOrderId,
     PalletCreditcoinLoanTerms,
     PalletCreditcoinOcwErrorsVerificationFailureCause,
-    PalletCreditcoinOcwTasksCollectCoinsGCreContract,
+    PalletCreditcoinOcwTasksCollectCoinsDeployedContract,
     PalletCreditcoinOfferId,
     PalletCreditcoinOwnershipProof,
     PalletCreditcoinTaskId,
@@ -417,6 +418,7 @@ declare module '@polkadot/api-base/types/submittable' {
                         | 'InvalidAddress'
                         | 'UnsupportedMethod'
                         | 'TransactionNotFound'
+                        | 'InsufficientFaucetBalance'
                         | number
                         | Uint8Array,
                 ) => SubmittableExtrinsic<ApiType>,
@@ -570,15 +572,40 @@ declare module '@polkadot/api-base/types/submittable' {
                 ) => SubmittableExtrinsic<ApiType>,
                 [Bytes, Bytes]
             >;
+            requestCollectCoinsV2: AugmentedSubmittable<
+                (
+                    contract:
+                        | PalletCreditcoinCollectCoinsTokenContract
+                        | { GCRE: any }
+                        | { GATE: any }
+                        | string
+                        | Uint8Array,
+                ) => SubmittableExtrinsic<ApiType>,
+                [PalletCreditcoinCollectCoinsTokenContract]
+            >;
+            setBurnGateContract: AugmentedSubmittable<
+                (
+                    contract:
+                        | PalletCreditcoinOcwTasksCollectCoinsDeployedContract
+                        | { address?: any; chain?: any }
+                        | string
+                        | Uint8Array,
+                ) => SubmittableExtrinsic<ApiType>,
+                [PalletCreditcoinOcwTasksCollectCoinsDeployedContract]
+            >;
+            setBurnGateFaucetAddress: AugmentedSubmittable<
+                (address: AccountId32 | string | Uint8Array) => SubmittableExtrinsic<ApiType>,
+                [AccountId32]
+            >;
             setCollectCoinsContract: AugmentedSubmittable<
                 (
                     contract:
-                        | PalletCreditcoinOcwTasksCollectCoinsGCreContract
+                        | PalletCreditcoinOcwTasksCollectCoinsDeployedContract
                         | { address?: any; chain?: any }
                         | string
                         | Uint8Array,
                 ) => SubmittableExtrinsic<ApiType>,
-                [PalletCreditcoinOcwTasksCollectCoinsGCreContract]
+                [PalletCreditcoinOcwTasksCollectCoinsDeployedContract]
             >;
             /**
              * Generic tx