feat: add gateway constant (#962)

README.md

@@ -67,6 +67,20 @@ Loading this module through a script tag will make the `BeeJs` object available
 
 ## Usage
 
+### Upload via Swarm Gateway
+
+```js
+import { Bee, NULL_STAMP, SWARM_GATEWAY_URL } from '@ethersphere/bee-js'
+
+main()
+
+async function main() {
+  const bee = new Bee(SWARM_GATEWAY_URL)
+  const { reference } = await bee.uploadData(NULL_STAMP, 'Hello, World!')
+  console.log(reference)
+}
+```
+
 ### Create or select an existing postage batch
 
 Swarm incentivizes nodes in the network to store content, therefor all uploads require a paid

src/index.ts

@@ -2,6 +2,7 @@ import { Bee } from './bee'
 
 export { SUPPORTED_BEE_VERSION, SUPPORTED_BEE_VERSION_EXACT } from './modules/debug/status'
 export * from './types'
+export * from './utils/constants'
 export * from './utils/error'
 export * as Utils from './utils/expose'
 export { Bee }

src/utils/constants.ts

@@ -0,0 +1,5 @@
+import { BatchId, Topic } from '..'
+
+export const SWARM_GATEWAY_URL = 'https://api.gateway.ethswarm.org'
+export const NULL_STAMP: BatchId = '0000000000000000000000000000000000000000000000000000000000000000' as BatchId
+export const NULL_TOPIC: Topic = '0000000000000000000000000000000000000000000000000000000000000000' as Topic

src/utils/expose.ts

@@ -1,5 +1,3 @@
-import { BatchId, Topic } from '..'
-
 export { getCollectionSize } from './collection'
 export { getFolderSize } from './collection.node'
 
@@ -54,6 +52,3 @@ export {
 } from './stamps'
 
 export { approximateOverheadForRedundancyLevel, getRedundancyStat, getRedundancyStats } from './redundancy'
-
-export const NULL_STAMP: BatchId = '0000000000000000000000000000000000000000000000000000000000000000' as BatchId
-export const NULL_TOPIC: Topic = '0000000000000000000000000000000000000000000000000000000000000000' as Topic

test/integration/feed/index.spec.ts

@@ -1,11 +1,11 @@
+import { NULL_TOPIC } from '../../../src'
 import { makeContentAddressedChunk } from '../../../src/chunk/cac'
 import { makePrivateKeySigner } from '../../../src/chunk/signer'
 import { downloadFeedUpdate, FeedUploadOptions, findNextIndex, updateFeed } from '../../../src/feed'
 import * as chunkAPI from '../../../src/modules/chunk'
 import { fetchLatestFeedUpdate } from '../../../src/modules/feed'
 import type { BeeRequestOptions, BytesReference, PrivateKeyBytes, Signer, Topic } from '../../../src/types'
 import { assertBytes, Bytes } from '../../../src/utils/bytes'
-import { NULL_TOPIC } from '../../../src/utils/expose'
 import { hexToBytes, makeHexString } from '../../../src/utils/hex'
 import { beeKyOptions, getPostageBatch, testIdentity } from '../../utils'
 

test/integration/modules/feed.spec.ts

@@ -1,7 +1,7 @@
+import { NULL_TOPIC } from '../../../src'
 import { createFeedManifest, fetchLatestFeedUpdate } from '../../../src/modules/feed'
 import { upload as uploadSOC } from '../../../src/modules/soc'
 import type { Topic } from '../../../src/types'
-import { NULL_TOPIC } from '../../../src/utils/expose'
 import { HexString, hexToBytes, makeHexString } from '../../../src/utils/hex'
 import { beeKyOptions, commonMatchers, getPostageBatch, testIdentity } from '../../utils'