CP-13448 - Injected Provider Demo (#3645)

Author: alexnicolae-ava

docs/injected-provider/working_demo.md

@@ -0,0 +1,282 @@
+import { buildEvmProviderShim } from './evmProviderShim'
+
+describe('buildEvmProviderShim', () => {
+  const defaultParams = {
+    chainId: '0xa86a',
+    address: '0x1234567890abcdef1234567890abcdef12345678'
+  }
+
+  it('returns a non-empty string', () => {
+    const shim = buildEvmProviderShim(defaultParams)
+    expect(typeof shim).toBe('string')
+    expect(shim.length).toBeGreaterThan(0)
+  })
+
+  it('wraps the code in an IIFE', () => {
+    const shim = buildEvmProviderShim(defaultParams)
+    expect(shim.trimStart()).toMatch(/^\(function\(\)/)
+    expect(shim.trimEnd()).toMatch(/\}\)\(\);$/)
+  })
+
+  describe('embedded values', () => {
+    it('embeds the chain ID', () => {
+      const shim = buildEvmProviderShim(defaultParams)
+      expect(shim).toContain("var _chainId = '0xa86a'")
+    })
+
+    it('embeds the address', () => {
+      const shim = buildEvmProviderShim(defaultParams)
+      expect(shim).toContain(
+        "var _address = '0x1234567890abcdef1234567890abcdef12345678'"
+      )
+    })
+
+    it('embeds a different chain ID when provided', () => {
+      const shim = buildEvmProviderShim({
+        chainId: '0x1',
+        address: defaultParams.address
+      })
+      expect(shim).toContain("var _chainId = '0x1'")
+      expect(shim).not.toContain("var _chainId = '0xa86a'")
+    })
+
+    it('embeds an empty address when not provided', () => {
+      const shim = buildEvmProviderShim({ chainId: '0xa86a', address: '' })
+      expect(shim).toContain("var _address = ''")
+    })
+  })
+
+  describe('pre-connected state', () => {
+    it('sets _connected to true when address is provided', () => {
+      const shim = buildEvmProviderShim(defaultParams)
+      expect(shim).toContain('var _connected = !!_address')
+    })
+
+    it('initializes _accounts from _address', () => {
+      const shim = buildEvmProviderShim(defaultParams)
+      expect(shim).toContain('var _accounts = _address ? [_address] : []')
+    })
+  })
+
+  describe('EIP-1193 provider object', () => {
+    let shim: string
+
+    beforeAll(() => {
+      shim = buildEvmProviderShim(defaultParams)
+    })
+
+    it('sets isMetaMask flag', () => {
+      expect(shim).toContain('isMetaMask: true')
+    })
+
+    it('sets isCore flag', () => {
+      expect(shim).toContain('isCore: true')
+    })
+
+    it('sets isAvalanche flag', () => {
+      expect(shim).toContain('isAvalanche: true')
+    })
+
+    it('implements request method', () => {
+      expect(shim).toContain('request: function(args)')
+    })
+
+    it('implements isConnected method', () => {
+      expect(shim).toContain('isConnected: function()')
+    })
+  })
+
+  describe('local RPC methods handled in shim', () => {
+    let shim: string
+
+    beforeAll(() => {
+      shim = buildEvmProviderShim(defaultParams)
+    })
+
+    it.each([
+      'eth_chainId',
+      'eth_accounts',
+      'net_version',
+      'eth_coinbase',
+      'eth_requestAccounts',
+      'wallet_requestPermissions',
+      'wallet_getPermissions'
+    ])('handles %s locally', method => {
+      expect(shim).toContain(`method === '${method}'`)
+    })
+  })
+
+  describe('legacy method support', () => {
+    let shim: string
+
+    beforeAll(() => {
+      shim = buildEvmProviderShim(defaultParams)
+    })
+
+    it('implements enable()', () => {
+      expect(shim).toContain('enable: function()')
+    })
+
+    it('implements send()', () => {
+      expect(shim).toContain('send: function(methodOrPayload')
+    })
+
+    it('implements sendAsync()', () => {
+      expect(shim).toContain('sendAsync: function(payload, callback)')
+    })
+  })
+
+  describe('event emitter', () => {
+    let shim: string
+
+    beforeAll(() => {
+      shim = buildEvmProviderShim(defaultParams)
+    })
+
+    it('implements on()', () => {
+      expect(shim).toContain('on: function(event, fn)')
+    })
+
+    it('implements removeListener()', () => {
+      expect(shim).toContain('removeListener: function(event, fn)')
+    })
+
+    it('implements removeAllListeners()', () => {
+      expect(shim).toContain('removeAllListeners: function(event)')
+    })
+  })
+
+  describe('global provider installation', () => {
+    let shim: string
+
+    beforeAll(() => {
+      shim = buildEvmProviderShim(defaultParams)
+    })
+
+    it('installs window.ethereum via Object.defineProperty', () => {
+      expect(shim).toContain("Object.defineProperty(window, 'ethereum'")
+    })
+
+    it('installs window.core via Object.defineProperty', () => {
+      expect(shim).toContain("Object.defineProperty(window, 'core'")
+    })
+
+    it('installs window.avalanche via Object.defineProperty', () => {
+      expect(shim).toContain("Object.defineProperty(window, 'avalanche'")
+    })
+
+    it('makes properties non-configurable', () => {
+      expect(shim).toContain('configurable: false')
+    })
+
+    it('includes a no-op setter to prevent overrides', () => {
+      expect(shim).toContain('set: function() {}')
+    })
+  })
+
+  describe('EIP-6963 announcement', () => {
+    let shim: string
+
+    beforeAll(() => {
+      shim = buildEvmProviderShim(defaultParams)
+    })
+
+    it('dispatches eip6963:announceProvider event', () => {
+      expect(shim).toContain('eip6963:announceProvider')
+    })
+
+    it('listens for eip6963:requestProvider event', () => {
+      expect(shim).toContain('eip6963:requestProvider')
+    })
+
+    it('uses rdns app.core.mobile', () => {
+      expect(shim).toContain("rdns: 'app.core.mobile'")
+    })
+
+    it('sets provider name to Core', () => {
+      expect(shim).toContain("name: 'Core'")
+    })
+
+    it('includes a base64 SVG icon', () => {
+      expect(shim).toContain("icon: 'data:image/svg+xml;base64,")
+    })
+  })
+
+  describe('injection guards', () => {
+    let shim: string
+
+    beforeAll(() => {
+      shim = buildEvmProviderShim(defaultParams)
+    })
+
+    it('includes doctypeCheck', () => {
+      expect(shim).toContain('function doctypeCheck()')
+    })
+
+    it('includes suffixCheck for xml and pdf', () => {
+      expect(shim).toContain('function suffixCheck()')
+      expect(shim).toContain("'xml'")
+      expect(shim).toContain("'pdf'")
+    })
+
+    it('includes documentElementCheck', () => {
+      expect(shim).toContain('function documentElementCheck()')
+    })
+
+    it('early returns if guards fail', () => {
+      expect(shim).toContain(
+        'if (!doctypeCheck() || !suffixCheck() || !documentElementCheck()) return'
+      )
+    })
+  })
+
+  describe('native bridge', () => {
+    let shim: string
+
+    beforeAll(() => {
+      shim = buildEvmProviderShim(defaultParams)
+    })
+
+    it('defines __coreProviderRespond on window', () => {
+      expect(shim).toContain('window.__coreProviderRespond = function(id')
+    })
+
+    it('defines __coreProviderEmit on window', () => {
+      expect(shim).toContain('window.__coreProviderEmit = function(eventName')
+    })
+
+    it('uses safeSend wrapper for postMessage', () => {
+      expect(shim).toContain('function safeSend(msg)')
+      expect(shim).toContain('window.ReactNativeWebView')
+    })
+
+    it('sends domain_metadata message', () => {
+      expect(shim).toContain("method: 'domain_metadata'")
+    })
+
+    it('sends provider_request messages', () => {
+      expect(shim).toContain("method: 'provider_request'")
+    })
+  })
+
+  describe('legacy event dispatch', () => {
+    it('dispatches ethereum#initialized event', () => {
+      const shim = buildEvmProviderShim(defaultParams)
+      expect(shim).toContain("new Event('ethereum#initialized')")
+    })
+  })
+
+  describe('auto-connect event firing', () => {
+    it('auto-fires connect event on listener attachment', () => {
+      const shim = buildEvmProviderShim(defaultParams)
+      expect(shim).toContain("event === 'connect'")
+      expect(shim).toContain('fn({ chainId: _chainId })')
+    })
+
+    it('auto-fires accountsChanged event on listener attachment', () => {
+      const shim = buildEvmProviderShim(defaultParams)
+      expect(shim).toContain("event === 'accountsChanged'")
+      expect(shim).toContain('fn(_accounts.slice())')
+    })
+  })
+})