Skip to content

Commit 51b2952

Browse files
committed
chore: missed renames (api→rpc, .io→.tech)
ipfs/kubo#8959 protocol/bifrost-infra#178
1 parent b560f5c commit 51b2952

File tree

10 files changed

+34
-34
lines changed

10 files changed

+34
-34
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ In separate shells run the following:
6262
> npm run storybook
6363
```
6464

65-
### Configure IPFS API CORS headers
65+
### Configure Kubo RPC API CORS headers
6666

67-
You must configure your IPFS API at http://127.0.0.1:5001 to allow [cross-origin (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) requests from your dev server at http://localhost:3000
67+
You must configure your Kubo RPC endpoint at http://127.0.0.1:5001 to allow [cross-origin (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) requests from your dev server at http://localhost:3000
6868

6969
Similarly if you want to try out pre-release versions at https://dev.webui.ipfs.io you need to add that as an allowed domain too.
7070

@@ -117,7 +117,7 @@ To create an optimized static build of the app, output to the `build` directory:
117117

118118
## Test
119119

120-
The following command will run all tests: unit one for React and E2E against real HTTP API:
120+
The following command will run all tests: unit one for React and E2E against real Kubo RPC:
121121

122122
```sh
123123
> npm test
@@ -135,7 +135,7 @@ The WebUI uses Jest to run the isolated unit tests. Unit test files are located
135135

136136
## E2E tests
137137

138-
The end-to-end tests (E2E) test the full app in a headless Chromium browser. They spawn real IPFS node for HTTP API and a static HTTP server to serve the app.
138+
The end-to-end tests (E2E) test the full app in a headless Chromium browser. They spawn real Kubo node for HTTP RPC and a static HTTP server to serve the app.
139139
The purpose of those tests is not being comprehensible, but act as a quick regression and integration suite.
140140
Test files are located in `test/e2e/`.
141141

@@ -162,13 +162,13 @@ One can also override the binary used in e2e tests by providing a path to an alt
162162

163163
#### `E2E_API_URL`
164164

165-
Instead of spawning a disposable node and repo for tests, one can point the E2E test suite at arbitrary HTTP API running on localhost:
165+
Instead of spawning a disposable node and repo for tests, one can point the E2E test suite at arbitrary Kubo-compatible RPC API running on localhost:
166166

167167
```sh
168168
> E2E_API_URL=http://127.0.0.1:5001 npm run test:e2e
169169
```
170170

171-
**Caveat 1:** HTTP API used in tests needs to run on the local machine for Peers screen to pass (they test manual swarm connect to ephemeral `/ip4/120.0.0.1/..` multiaddr)
171+
**Caveat 1:** HTTP RPC API used in tests needs to run on the local machine for Peers screen to pass (they test manual swarm connect to ephemeral `/ip4/120.0.0.1/..` multiaddr)
172172

173173
**Caveat 2:** CORS requests from `http://localhost:3001` (static server hosting dev version of webui) need to be added to `Access-Control-Allow-Origin` whitelist array in node's config:
174174

public/locales/en/app.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@
5656
"addresses": "Addresses",
5757
"advanced": "Advanced",
5858
"agent": "Agent",
59-
"api": "API",
60-
"apiAddress": "API address",
59+
"api": "Kubo RPC",
60+
"apiAddress": "RPC API address",
6161
"blocks": "Blocks",
6262
"connection": "Connection",
6363
"downSpeed": "Incoming",

public/locales/en/settings.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"translationProjectIntro": "Add or improve translations and make IPFS better for everyone!",
2323
"translationProjectLink": "Join the IPFS Translation Project"
2424
},
25-
"apiDescription": "<0>If your node is configured with a <1>custom API address</1>, including a port other than the default 5001, enter it here.</0>",
25+
"apiDescription": "<0>If your node is configured with a <1>custom Kubo RPC API address</1>, including a port other than the default 5001, enter it here.</0>",
2626
"publicGatewayDescription": "<0>Choose which <1>public gateway</1> you want to use when generating shareable links.</0>",
2727
"cliDescription": "<0>Enable this option to display a \"view code\" <1></1> icon next to common IPFS commands. Clicking it opens a modal with that command's CLI code, so you can paste it into the IPFS command-line interface in your terminal.</0>",
2828
"cliModal": {
@@ -132,8 +132,8 @@
132132
"paragraph2": "If you're running IPFS Desktop you'll have some specific settings for it too."
133133
},
134134
"step2": {
135-
"title": "Custom API address",
136-
"paragraph1": "If you've configured your IPFS node with a custom API address, you can update your config file right here instead of editing the JSON by hand."
135+
"title": "Custom Kubo RPC API address",
136+
"paragraph1": "If you've configured your Kubo-compatible IPFS node with a custom RPC API address, you can update your config file right here instead of editing the JSON by hand."
137137
},
138138
"step3": {
139139
"title": "Pinning services",

public/locales/en/welcome.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"header": "What is IPFS?",
1515
"paragraph1": "<0><0>A hypermedia distribution protocol</0> that incorporates ideas from Kademlia, BitTorrent, Git, and more</0>",
1616
"paragraph2": "<0><0>A peer-to-peer file transfer network</0> with a completely decentralized architecture and no central point of failure, censorship, or control</0>",
17-
"paragraph3": "<0><0>An on-ramp to tomorrow's web</0> — traditional browsers can access IPFS files through gateways like <2>https://ipfs.io</2> or directly using the <4>IPFS Companion</4> extension</0>",
17+
"paragraph3": "<0><0>An on-ramp to tomorrow's web</0> — traditional browsers can access IPFS files through gateways like <2>https://dweb.link</2> or directly using the <4>IPFS Companion</4> extension</0>",
1818
"paragraph4": "<0><0>A next-gen CDN</0> — just add a file to your node to make it available to the world with cache-friendly content-hash addressing and BitTorrent-style bandwidth distribution</0>",
1919
"paragraph5": "<0><0>A developer toolset</0> for building <2>completely distributed apps and services</2>, backed by a robust open-source community</0>"
2020
},

src/components/about-ipfs/AboutIpfs.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ export const AboutIpfs = ({ t }) => {
1414
<li className='mb2'><strong>A peer-to-peer file transfer network</strong> with a completely decentralized architecture and no central point of failure, censorship, or control</li>
1515
</Trans>
1616
<Trans i18nKey='aboutIpfs.paragraph3' t={t}>
17-
<li className='mb2'><strong>An on-ramp to tomorrow's web</strong> &mdash; traditional browsers can access IPFS files through gateways like <code className='f5 bg-light-gray br2 pa1'>https://ipfs.io</code> or directly using the <a className='link blue' target='_blank' rel='noopener noreferrer' href='https://github.com/ipfs-shipyard/ipfs-companion#ipfs-companion'>IFPS Companion</a> extension</li>
17+
<li className='mb2'><strong>An on-ramp to tomorrow's web</strong> &mdash; traditional browsers can access IPFS files through gateways like <code className='f5 bg-light-gray br2 pa1'>https://dweb.link</code> or directly using the <a className='link blue' target='_blank' rel='noopener noreferrer' href='https://github.com/ipfs/ipfs-companion#readme'>IFPS Companion</a> extension</li>
1818
</Trans>
1919
<Trans i18nKey='aboutIpfs.paragraph4' t={t}>
2020
<li className='mb2'><strong>A next-gen CDN</strong> &mdash; just add a file to your node to make it available to the world with cache-friendly content-hash addressing and BitTorrent-style bandwidth distribution</li>
2121
</Trans>
2222
<Trans i18nKey='aboutIpfs.paragraph5' t={t}>
23-
<li className='mb2'><strong>A developer toolset</strong> for building completely <a className='link blue' target='_blank' rel='noopener noreferrer' href='https://awesome.ipfs.io/'>distributed apps and services</a>, backed by a robust open-source community</li>
23+
<li className='mb2'><strong>A developer toolset</strong> for building completely <a className='link blue' target='_blank' rel='noopener noreferrer' href='https://awesome.ipfs.tech/'>distributed apps and services</a>, backed by a robust open-source community</li>
2424
</Trans>
2525
</ul>
2626
</Box>

src/components/is-not-connected/IsNotConnected.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ const IsNotConnected = ({ t, apiUrl, connected, sameOrigin, ipfsApiAddress, doUp
2525
<h1 className='montserrat fw4 charcoal ma0 f3 red'>{t('app:status.couldNotConnect')}</h1>
2626
</div>
2727
<Trans i18nKey='notConnected.paragraph1' t={t}>
28-
<p className='fw6 mb3'>Check out the installation guide in the <a className='link blue' href='https://docs.ipfs.io/install/command-line-quick-start/' target='_blank' rel='noopener noreferrer'>IPFS Docs</a>, or try these common fixes:</p>
28+
<p className='fw6 mb3'>Check out the installation guide in the <a className='link blue' href='https://docs.ipfs.tech/install/command-line-quick-start/' target='_blank' rel='noopener noreferrer'>IPFS Docs</a>, or try these common fixes:</p>
2929
</Trans>
3030
<ol className='pl3 pt2'>
3131
<Trans i18nKey='notConnected.paragraph2' t={t}>
@@ -39,7 +39,7 @@ const IsNotConnected = ({ t, apiUrl, connected, sameOrigin, ipfsApiAddress, doUp
3939
{ !sameOrigin && (
4040
<div>
4141
<Trans i18nKey='notConnected.paragraph3' t={t}>
42-
<li className='mb3 mt4'>Is your IPFS API configured to allow <a className='link blue' href='https://github.com/ipfs-shipyard/ipfs-webui#configure-ipfs-api-cors-headers'>cross-origin (CORS) requests</a>? If not, run these commands and then start your daemon from the terminal:</li>
42+
<li className='mb3 mt4'>Is your IPFS API configured to allow <a className='link blue' href='https://github.com/ipfs/ipfs-webui#configure-kubo-rpc-api-cors-headers'>cross-origin (CORS) requests</a>? If not, run these commands and then start your daemon from the terminal:</li>
4343
</Trans>
4444
<div className='br1 overflow-hidden'>
4545
<div className='f7 mb0 sans-serif charcoal pv1 pl2 bg-black-20 flex items-center overflow-x-auto'>

src/components/pinning-manager/pinning-manager-service-modal/PinningManagerServiceModal.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ const PinningManagerServiceModal = ({ t, onLeave, onSuccess, className, service,
107107
<p className='f6'>
108108
<Trans i18nKey="pinningServiceModal.description" t={t}>
109109
Want to make your custom pinning service available to others?
110-
<a href='https://docs.ipfs.io/how-to/work-with-pinning-services/' rel='noopener noreferrer' target="_blank" className='pv0 dib link' type='link'>Learn how.</a>
110+
<a href='https://docs.ipfs.tech/how-to/work-with-pinning-services/' rel='noopener noreferrer' target="_blank" className='pv0 dib link' type='link'>Learn how.</a>
111111
</Trans>
112112
</p>
113113
</ModalBody>

src/lib/tours.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ export const filesTour = {
112112
<h2 className='f3 fw4'>{t('tour.step1.title')}</h2>
113113
<Trans i18nKey='tour.step1.paragraph1' t={t}>
114114
<p className='tl f6'>
115-
This is where the files on your <a className='teal link' href='https://docs.ipfs.io/concepts/file-systems/' rel='noopener noreferrer' target='_blank'>
115+
This is where the files on your <a className='teal link' href='https://docs.ipfs.tech/concepts/file-systems/' rel='noopener noreferrer' target='_blank'>
116116
Mutable File System (MFS)</a> live. You can add files or folders and manage them from this page.
117117
</p>
118118
</Trans>
@@ -141,7 +141,7 @@ export const filesTour = {
141141
<p className='tl f6'>{t('tour.step3.paragraph2')}</p>
142142
<Trans i18nKey='tour.step3.paragraph3' t={t}>
143143
<p className='tl f6'>
144-
If you want to add something that is already on IPFS, you can import it to your MFS by passing its <a className='teal link' href='https://docs.ipfs.io/concepts/content-addressing/' rel='noopener noreferrer' target='_blank'>Content
144+
If you want to add something that is already on IPFS, you can import it to your MFS by passing its <a className='teal link' href='https://docs.ipfs.tech/concepts/content-addressing/' rel='noopener noreferrer' target='_blank'>Content
145145
Identifier (CID)</a>.
146146
</p>
147147
</Trans>
@@ -233,7 +233,7 @@ export const settingsTour = {
233233
content: <div className='montserrat charcoal'>
234234
<h2 className='f3 fw4'>{t('tour.step3.title')}</h2>
235235
<Trans i18nKey='tour.step3.paragraph1' t={t}>
236-
<p className='tl f6'>If you have accounts with third-party remote pinning services, add them here so you can pin/unpin items to those services directly from the Files screen. You can learn more about third-party pinning services in the <a className='teal link' href='https://docs.ipfs.io/how-to/work-with-pinning-services' rel='noopener noreferrer' target='_blank'>IPFS Docs</a>.
236+
<p className='tl f6'>If you have accounts with third-party remote pinning services, add them here so you can pin/unpin items to those services directly from the Files screen. You can learn more about third-party pinning services in the <a className='teal link' href='https://docs.ipfs.tech/how-to/work-with-pinning-services' rel='noopener noreferrer' target='_blank'>IPFS Docs</a>.
237237
</p>
238238
</Trans>
239239
</div>,

src/settings/SettingsPage.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ export const SettingsPage = ({
5656
<div className='lh-copy charcoal'>
5757
<Title>{t('app:terms.apiAddress')}</Title>
5858
<Trans i18nKey='apiDescription' t={t}>
59-
<p>If your node is configured with a <a className='link blue' href='https://github.com/ipfs/kubo/blob/master/docs/config.md#addresses' target='_blank' rel='noopener noreferrer'>custom API address</a>, including a port other than the default 5001, enter it here.</p>
59+
<p>If your node is configured with a <a className='link blue' href='https://github.com/ipfs/kubo/blob/master/docs/config.md#addresses' target='_blank' rel='noopener noreferrer'>custom Kubo RPC API address</a>, including a port other than the default 5001, enter it here.</p>
6060
</Trans>
6161
<ApiAddressForm/>
6262
</div>
@@ -66,7 +66,7 @@ export const SettingsPage = ({
6666
<div className='lh-copy charcoal'>
6767
<Title>{t('app:terms.publicGateway')}</Title>
6868
<Trans i18nKey='publicGatewayDescription' t={t}>
69-
<p>Choose which <a className='link blue' href="http://docs.ipfs.io/concepts/ipfs-gateway/#public-gateways" target='_blank' rel='noopener noreferrer'>public gateway</a> you want to use to open your files.</p>
69+
<p>Choose which <a className='link blue' href="http://docs.ipfs.tech/concepts/ipfs-gateway/#public-gateways" target='_blank' rel='noopener noreferrer'>public gateway</a> you want to use to open your files.</p>
7070
</Trans>
7171
<PublicGatewayForm/>
7272
</div>
@@ -75,7 +75,7 @@ export const SettingsPage = ({
7575
<Box className='mb3 pa4-l pa2'>
7676
<Title>{t('ipnsPublishingKeys.title')}</Title>
7777
<p className='ma0 mr2 lh-copy charcoal f6'>
78-
{t('ipnsPublishingKeys.description')}&nbsp;<a className='link blue' target='_blank' rel='noopener noreferrer' href='https://docs.ipfs.io/concepts/glossary/#ipns'>{t('learnMoreLink')}</a>
78+
{t('ipnsPublishingKeys.description')}&nbsp;<a className='link blue' target='_blank' rel='noopener noreferrer' href='https://docs.ipfs.tech/concepts/glossary/#ipns'>{t('learnMoreLink')}</a>
7979
</p>
8080
<IpnsManager t={t} />
8181
</Box>
@@ -86,7 +86,7 @@ export const SettingsPage = ({
8686
{ arePinningServicesSupported
8787
? t('pinningServices.description')
8888
: t('pinningServices.noPinRemoteDescription')
89-
}&nbsp;<a className='link blue' target='_blank' rel='noopener noreferrer' href='https://docs.ipfs.io/how-to/work-with-pinning-services/'>{t('learnMoreLink')}</a>
89+
}&nbsp;<a className='link blue' target='_blank' rel='noopener noreferrer' href='https://docs.ipfs.tech/how-to/work-with-pinning-services/'>{t('learnMoreLink')}</a>
9090
</p>
9191
<PinningManager t={t} />
9292
</Box>

test/e2e/remote-api.test.js renamed to test/e2e/remote-rpc-api.test.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ import { path as getGoIpfsPath } from 'kubo'
99
import * as kuboRpcModule from 'kubo-rpc-client'
1010
const { createProxyServer } = httpProxy
1111

12-
test.describe('Remote API tests', () => {
12+
test.describe('Remote RPC API tests', () => {
1313
// Basic Auth Proxy Setup
1414
// -----------------------------------
1515
// Why do we support and test Basic Auth?
1616
// Some users choose to access remote API.
1717
// It requires setting up reverse proxy with correct CORS and Basic Auth headers,
1818
// but when done properly, should work. This test sets up a proxy which
19-
// acts as properly protected and configured remote API to ensure there are no
19+
// acts as properly protected and configured remote RPC API to ensure there are no
2020
// regressions for this difficult to test use case.
2121
let ipfsd
2222
let proxyd
@@ -41,7 +41,7 @@ test.describe('Remote API tests', () => {
4141
const { id } = await ipfsd.api.id()
4242
rpcId = id
4343

44-
// set up proxy in front of remote API to provide CORS and Basic Auth
44+
// set up proxy in front of remote RPC API to provide CORS and Basic Auth
4545
user = 'user'
4646
password = 'pass'
4747

@@ -88,7 +88,7 @@ test.describe('Remote API tests', () => {
8888
})
8989

9090
test.beforeEach(async ({ page }) => {
91-
// Swap API port for each test, ensure we don't get false-positives
91+
// Swap RPC API port for each test, ensure we don't get false-positives
9292
proxyPort = await getPort()
9393
await proxyd.listen(proxyPort)
9494
// remove default api port set in test/e2e/setup/global-setup.js
@@ -147,13 +147,13 @@ test.describe('Remote API tests', () => {
147147
}
148148

149149
const basicAuthConnectionConfirmation = async (user, password, proxyPort, page, peerId) => {
150-
// (1) confirm API section on Status page includes expected PeerID and API description
150+
// (1) confirm RPC API section on Status page includes expected PeerID and RPC API description
151151
// account for JSON config, which we hide from status page
152152
await expectHttpApiAddressOnStatusPage('Custom JSON configuration', page)
153153
// confirm webui is actually connected to expected node :^)
154154
await expectPeerIdOnStatusPage(peerId, page)
155155

156-
// (2) go to Settings and confirm API string includes expected JSON config
156+
// (2) go to Settings and confirm RPC API string includes expected JSON config
157157
const apiOptions = JSON.stringify({
158158
url: `http://127.0.0.1:${proxyPort}/`,
159159
headers: {
@@ -184,7 +184,7 @@ test.describe('Remote API tests', () => {
184184
await page.reload() // instant addr update for faster CI
185185
await page.waitForSelector('input[id="api-address"]')
186186
const apiAddrValue = await page.inputValue('#api-address')
187-
// if API address is defined as JSON, match objects
187+
// if RPC API address is defined as JSON, match objects
188188
try {
189189
const json = JSON.parse(apiAddrValue)
190190
const expectedJson = JSON.parse(value)
@@ -201,7 +201,7 @@ test.describe('Remote API tests', () => {
201201
// having that out of the way, tests begin below ;^)
202202
// ----------------------------------------------------------------------------
203203

204-
test.describe('API @ multiaddr', () => {
204+
test.describe('RPC @ multiaddr', () => {
205205
test('should be possible to set via Settings page', async ({ page }) => {
206206
await switchIpfsApiEndpointViaSettings(rpcMaddr, page)
207207
await expectPeerIdOnStatusPage(rpcId, page)
@@ -219,7 +219,7 @@ test.describe('Remote API tests', () => {
219219
})
220220
})
221221

222-
test.describe('API @ URL', () => {
222+
test.describe('RPC @ URL', () => {
223223
test('should be possible to set via Settings page', async ({ page }) => {
224224
await switchIpfsApiEndpointViaSettings(rpcUrl, page)
225225
await expectPeerIdOnStatusPage(rpcId, page)
@@ -237,7 +237,7 @@ test.describe('Remote API tests', () => {
237237
})
238238
})
239239

240-
test.describe('API with CORS and Basic Auth', () => {
240+
test.describe('RPC with CORS and Basic Auth', () => {
241241
test.afterEach(async ({ page }) => {
242242
await switchIpfsApiEndpointViaLocalStorage(null, page)
243243
})

0 commit comments

Comments
 (0)