Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add stamp create, utility get-bee and utility redeem commands
- Loading branch information
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
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,123 @@ | ||
| import { Utils } from '@ethersphere/bee-js' | ||
| import { Dates, Numbers } from 'cafe-utility' | ||
| import { LeafCommand, Option } from 'furious-commander' | ||
| import { createSpinner } from '../../utils/spinner' | ||
| import { createKeyValue } from '../../utils/text' | ||
| import { VerbosityLevel } from '../root-command/command-log' | ||
| import { StampCommand } from './stamp-command' | ||
|
|
||
| export class Create extends StampCommand implements LeafCommand { | ||
| public readonly name = 'create' | ||
|
|
||
| public readonly description = 'Create postage stamp in a simple way' | ||
|
|
||
| @Option({ | ||
| key: 'capacity', | ||
| description: 'Size of data, e.g. 100MB, 1GB', | ||
| type: 'string', | ||
| required: false, | ||
| }) | ||
| public capacity!: string | ||
|
|
||
| @Option({ | ||
| key: 'ttl', | ||
| description: 'Time to live of the postage stamp, e.g. 1h, 1d, 1w', | ||
| type: 'string', | ||
| required: false, | ||
| }) | ||
| public ttl!: string | ||
|
|
||
| @Option({ key: 'immutable', description: 'Disable stamp reuse', type: 'boolean', default: true }) | ||
| public immutable!: boolean | ||
|
|
||
| @Option({ key: 'label', description: 'Label of the postage stamp' }) | ||
| public label!: string | ||
|
|
||
| public postageBatchId!: string | ||
|
|
||
| public async run(): Promise<void> { | ||
| super.init() | ||
|
|
||
| let capacityInBytes = 0 | ||
| let ttlInMillis = 0 | ||
|
|
||
| if (!this.capacity) { | ||
| this.console.log('Please provide the capacity of the postage stamp') | ||
| this.console.log('This is the size of the data that can be uploaded with this stamp') | ||
| this.console.log('Example: 100MB, 1GB') | ||
| this.capacity = await this.console.askForValue('Capacity') | ||
| this.console.log('') | ||
| } | ||
|
|
||
| capacityInBytes = Numbers.makeStorage(this.capacity) | ||
|
|
||
| if (!this.ttl) { | ||
| this.console.log('Please provide the time to live of the postage stamp') | ||
| this.console.log('This is the time after which the stamp will expire') | ||
| this.console.log('Example: 1h, 1d, 1w') | ||
| this.ttl = await this.console.askForValue('TTL') | ||
| this.console.log('') | ||
| } | ||
|
|
||
| ttlInMillis = Dates.make(this.ttl) | ||
|
|
||
| const depth = Utils.getDepthForCapacity(capacityInBytes / 1024 ** 3) | ||
| const amount = Utils.getAmountForTtl(ttlInMillis / 1000 / 60 / 60 / 24) | ||
|
|
||
| this.console.log('You have provided the following parameters:') | ||
| this.console.log(createKeyValue('Capacity', Numbers.convertBytes(capacityInBytes))) | ||
| this.console.log(createKeyValue('TTL', Dates.secondsToHumanTime(ttlInMillis / 1000))) | ||
| this.console.log('') | ||
| this.console.log(`Your parameters are now converted to Swarm's internal parameters:`) | ||
| this.console.log(createKeyValue('Depth (capacity)', depth)) | ||
| this.console.log(createKeyValue('Amount (TTL)', amount)) | ||
|
|
||
| const estimatedCost = Utils.getStampCostInBzz(depth, Number(amount)) | ||
| const estimatedCapacity = Numbers.convertBytes(Utils.getStampMaximumCapacityBytes(depth)) | ||
| const estimatedTtl = Utils.getStampTtlSeconds(Number(amount)) | ||
|
|
||
| this.console.log('') | ||
| this.console.log(createKeyValue('Estimated cost', `${estimatedCost.toFixed(3)} xBZZ`)) | ||
| this.console.log(createKeyValue('Estimated capacity', estimatedCapacity)) | ||
| this.console.log(createKeyValue('Estimated TTL', Dates.secondsToHumanTime(estimatedTtl))) | ||
| this.console.log(createKeyValue('Type', this.immutable ? 'Immutable' : 'Mutable')) | ||
|
|
||
| if (this.immutable) { | ||
| this.console.info( | ||
| 'Once an immutable stamp is maxed out, it disallows further content uploads, thereby safeguarding your previously uploaded content from unintentional overwriting.', | ||
| ) | ||
| } else { | ||
| this.console.info( | ||
| 'When a mutable stamp reaches full capacity, it still permits new content uploads. However, this comes with the caveat of overwriting previously uploaded content associated with the same stamp.', | ||
| ) | ||
| } | ||
|
|
||
| if (!this.quiet && !this.yes) { | ||
| this.yes = await this.console.confirm('Confirm the purchase') | ||
| } | ||
|
|
||
| if (!this.yes && !this.quiet) { | ||
| return | ||
| } | ||
|
|
||
| const spinner = createSpinner('Creating postage batch. This may take up to 5 minutes.') | ||
|
|
||
| if (this.verbosity !== VerbosityLevel.Quiet && !this.curl) { | ||
| spinner.start() | ||
| } | ||
|
|
||
| try { | ||
| const batchId = await this.bee.createPostageBatch(amount.toString(), depth, { | ||
| label: this.label, | ||
| immutableFlag: this.immutable, | ||
| waitForUsable: true, | ||
| }) | ||
| spinner.stop() | ||
| this.console.quiet(batchId) | ||
| this.console.log(createKeyValue('Stamp ID', batchId)) | ||
| this.postageBatchId = batchId | ||
| } finally { | ||
| spinner.stop() | ||
| } | ||
| } | ||
| } |
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,44 @@ | ||
| import { execSync } from 'child_process' | ||
| import { writeFileSync } from 'fs' | ||
| import { LeafCommand } from 'furious-commander' | ||
| import fetch from 'node-fetch' | ||
| import { RootCommand } from '../root-command' | ||
|
|
||
| const archTable = { | ||
| arm64: 'arm64', | ||
| x64: 'amd64', | ||
| } | ||
|
|
||
| const platformTable = { | ||
| win32: 'windows', | ||
| darwin: 'darwin', | ||
| linux: 'linux', | ||
| } | ||
|
|
||
| export class GetBee extends RootCommand implements LeafCommand { | ||
| public readonly name = 'get-bee' | ||
|
|
||
| public readonly description = 'Downloads the Bee binary for the current platform' | ||
|
|
||
| public async run(): Promise<void> { | ||
| super.init() | ||
| const archString = Reflect.get(archTable, process.arch) | ||
| const platformString = Reflect.get(platformTable, process.platform) | ||
| const suffixString = process.platform === 'win32' ? '.exe' : '' | ||
|
|
||
| if (!archString || !platformString) { | ||
| throw Error(`Unsupported system: arch=${process.arch} platform=${process.platform}`) | ||
| } | ||
| const url = `https://github.com/ethersphere/bee/releases/download/v2.3.0/bee-${platformString}-${archString}${suffixString}` | ||
| this.console.info(`Downloading Bee from ${url}`) | ||
| await fetch(url) | ||
| .then(async x => x.arrayBuffer()) | ||
| .then(x => writeFileSync(`bee${suffixString}`, Buffer.from(x))) | ||
| this.console.info('Bee downloaded successfully') | ||
| if (process.platform !== 'win32') { | ||
| this.console.info(`Running chmod +x bee`) | ||
| execSync('chmod +x bee') | ||
| } | ||
| this.console.log('Verify the binary by running ./bee version') | ||
| } | ||
| } | ||
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.