-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Metadata API] Add methods left to complete metadata flow (#15)
* Add metadata api methods to create appDataDoc and upload it to IPFS * Add unit tests for Metadata API methods * Update README with new metadata methods * Iprove ifps utils + Refactor ipfs context type * Update readme * set file type as unknown for pinJSONToIPFS method
- Loading branch information
Showing
5 changed files
with
274 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| import fetchMock, { enableFetchMocks } from 'jest-fetch-mock' | ||
| import { CowSdk } from '../../CowSdk' | ||
| import { CowError } from '../../utils/common' | ||
|
|
||
| enableFetchMocks() | ||
|
|
||
| const chainId = 4 //Rinkeby | ||
|
|
||
| const cowSdk = new CowSdk(chainId) | ||
|
|
||
| const HTTP_STATUS_OK = 200 | ||
| const HTTP_STATUS_INTERNAL_ERROR = 500 | ||
|
|
||
| const DEFAULT_APP_DATA_DOC = { | ||
| version: '0.1.0', | ||
| appCode: 'CowSwap', | ||
| metadata: {}, | ||
| } | ||
|
|
||
| const CUSTOM_APP_DATA_DOC = { | ||
| ...DEFAULT_APP_DATA_DOC, | ||
| metadata: { | ||
| referrer: { | ||
| address: '0x1f5B740436Fc5935622e92aa3b46818906F416E9', | ||
| version: '0.1.0', | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| const IPFS_HASH = 'QmUf2TrpSANVXdgcYfAAACe6kg551cY3rAemB7xfEMjYvs' | ||
|
|
||
| const APP_DATA_HEX = '0x5ddb2c8207c10b96fac92cb934ef9ba004bc007a073c9e5b13edc422f209ed80' | ||
|
|
||
| beforeEach(() => { | ||
| fetchMock.resetMocks() | ||
| }) | ||
|
|
||
| afterEach(() => { | ||
| jest.restoreAllMocks() | ||
| }) | ||
|
|
||
| test('Valid: Create appDataDoc with empty metadata ', () => { | ||
| const appDataDoc = cowSdk.metadataApi.generateAppDataDoc({}) | ||
| expect(appDataDoc.version).toEqual(DEFAULT_APP_DATA_DOC.version) | ||
| expect(appDataDoc.appCode).toEqual(DEFAULT_APP_DATA_DOC.appCode) | ||
| expect(appDataDoc.metadata).toEqual(DEFAULT_APP_DATA_DOC.metadata) | ||
| }) | ||
|
|
||
| test('Valid: Create appDataDoc with custom metadata ', () => { | ||
| const appDataDoc = cowSdk.metadataApi.generateAppDataDoc(CUSTOM_APP_DATA_DOC.metadata) | ||
| expect(appDataDoc.metadata.referrer?.address).toEqual(CUSTOM_APP_DATA_DOC.metadata.referrer.address) | ||
| expect(appDataDoc.metadata.referrer?.version).toEqual(CUSTOM_APP_DATA_DOC.metadata.referrer.version) | ||
| }) | ||
|
|
||
| test('Invalid: Upload to IPFS without passing credentials', async () => { | ||
| const appDataDoc = cowSdk.metadataApi.generateAppDataDoc(CUSTOM_APP_DATA_DOC.metadata) | ||
| try { | ||
| await cowSdk.metadataApi.uploadMetadataDocToIpfs(appDataDoc) | ||
| } catch (e) { | ||
| const error = e as CowError | ||
| expect(error.message).toEqual('You need to pass IPFS api credentials.') | ||
| } | ||
| }) | ||
|
|
||
| test('Valid: Upload AppDataDoc to IPFS', async () => { | ||
| fetchMock.mockResponseOnce(JSON.stringify({ IpfsHash: IPFS_HASH }), { status: HTTP_STATUS_OK }) | ||
| const appDataDoc = cowSdk.metadataApi.generateAppDataDoc(CUSTOM_APP_DATA_DOC.metadata) | ||
| const cowSdk1 = new CowSdk(chainId, { ipfs: { pinataApiKey: 'validApiKey', pinataApiSecret: 'ValidApiSecret' } }) | ||
| const appDataHex = await cowSdk1.metadataApi.uploadMetadataDocToIpfs(appDataDoc) | ||
| expect(fetchMock).toHaveBeenCalledTimes(1) | ||
| expect(appDataHex).toEqual(APP_DATA_HEX) | ||
| }) | ||
|
|
||
| test('Invalid: Upload AppDataDoc to IPFS with wrong credentials', async () => { | ||
| fetchMock.mockResponseOnce(JSON.stringify({ error: { details: 'IPFS api keys are invalid' } }), { | ||
| status: HTTP_STATUS_INTERNAL_ERROR, | ||
| }) | ||
| const appDataDoc = cowSdk.metadataApi.generateAppDataDoc({}) | ||
| const cowSdk1 = new CowSdk(chainId, { ipfs: { pinataApiKey: 'InvalidApiKey', pinataApiSecret: 'InvValidApiSecret' } }) | ||
| try { | ||
| await cowSdk1.metadataApi.uploadMetadataDocToIpfs(appDataDoc) | ||
| await expect(cowSdk1.metadataApi.uploadMetadataDocToIpfs(appDataDoc)).rejects.toThrow('IPFS api keys are invalid') | ||
| } catch (e) { | ||
| const error = e as CowError | ||
| expect(fetchMock).toHaveBeenCalledTimes(1) | ||
| expect(error.message).toEqual('IPFS api keys are invalid') | ||
| } | ||
| }) | ||
|
|
||
| test('Valid: Decode appData ', async () => { | ||
| fetchMock.mockResponseOnce(JSON.stringify(CUSTOM_APP_DATA_DOC), { status: HTTP_STATUS_OK }) | ||
| const appDataDoc = await cowSdk.metadataApi.decodeAppData(APP_DATA_HEX) | ||
|
|
||
| expect(fetchMock).toHaveBeenCalledTimes(1) | ||
| expect(fetchMock).toHaveBeenCalledWith( | ||
| 'https://gnosis.mypinata.cloud/ipfs/QmUf2TrpSANVXdgcYfAAACe6kg551cY3rAemB7xfEMjYvs' | ||
| ) | ||
| expect(appDataDoc?.version).toEqual(CUSTOM_APP_DATA_DOC.version) | ||
| expect(appDataDoc?.appCode).toEqual(CUSTOM_APP_DATA_DOC.appCode) | ||
| expect(appDataDoc?.metadata.referrer?.address).toEqual(CUSTOM_APP_DATA_DOC.metadata.referrer.address) | ||
| expect(appDataDoc?.metadata.referrer?.version).toEqual(CUSTOM_APP_DATA_DOC.metadata.referrer.version) | ||
| }) | ||
|
|
||
| test('Invalid: Decode appData with wrong hash format', async () => { | ||
| fetchMock.mockResponseOnce(JSON.stringify({}), { status: HTTP_STATUS_INTERNAL_ERROR }) | ||
| try { | ||
| await cowSdk.metadataApi.decodeAppData('invalidHash') | ||
| } catch (e) { | ||
| const error = e as CowError | ||
| expect(error.message).toEqual('Error decoding AppData: Incorrect length') | ||
| } | ||
| }) | ||
|
|
||
| test('Valid: AppData to CID ', async () => { | ||
| const decodedAppDataHex = await cowSdk.metadataApi.appDataHexToCid(APP_DATA_HEX) | ||
| expect(decodedAppDataHex).toEqual(IPFS_HASH) | ||
| }) | ||
|
|
||
| test('Invalid: AppData to CID with wrong format ', async () => { | ||
| try { | ||
| await cowSdk.metadataApi.appDataHexToCid('invalidHash') | ||
| } catch (e) { | ||
| const error = e as CowError | ||
| expect(error.message).toEqual('Incorrect length') | ||
| } | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.